WSO2 Carbon - carbondump Tool [ Documentation Index ]

carbondump - Captures the State of the System in Error Situations.

Introduction

carbondump is a tool for collecting all the necessary data from a running Carbon instance at the time of an error. This data helps to capture state of the running system and it aids in the problem determination. carbondump generates a zip archive with the collected data. This dump file(zip file) helps us, the WSO2 support team to analyze your system well and get an idea about the state of the system when the error happened. Therefore, as a best practise run this tool as soon as possible at the time of an error.

carbondump captures various information of your running Carbon instance, including information about the memory of the Java process, a complete thread dump, checksum values of all the files inside the directory where the product file resides(say CARBON_HOME), JAVA_HOME, CARBON_HOME, etc. It copies all the configuration files, log files found inside the CARBON_HOME. It also captures certain information about your operation system, kernel information, list of installed modules and their information.

Usage of carbondump

You need to provide the process ID(pid) of the Carbon instance and the CARBON_HOME. CARBON_HOME is the directory path of the directory where your unzipped Carbon distribution resides in the file system.

sh carbondump.sh [-carbonHome path] [-pid of the carbon instance]

e.g. (Linux) sh carbondump.sh -carbonHome /home/user/wso2carbon-3.0.0/ -pid 5151

e.g. (Windows) carbondump.bat -carbonHome c:\wso2carbon-3.0.0\ -pid 5151

Captured Information of the System

  • Operating system information
    • OS(kernel) version
    • Installed modules list and their information
    • List of running tasks in the system
  • Memory information of the Java process
    • Java heap memory dump
    • Histogram of the heap
    • Objects waiting for finalization
    • Java heap summary. GC algo used, etc.
    • Statistics on permgen space of Java heap
  • Information about the running Carbon instance
    • Product name and version
    • Carbon framework version(This includes the patched version)
    • CARBON_HOME, JAVA_HOME
    • configuration files.
    • log files
    • H2 database files
  • Thred dump
  • Checksum values of all the files found in the $CARBON_HOME