Using the IBM Business Process Manager data collector
Use the IBM® Business Process Manager data collector, which is installed with IBM Business Process Manager, to gather some of the standard information that is needed to debug IBM Business Process Manager issues. This command-line tool can gather log file or configuration information and upload it to a Problem Management Record (PMR).
About this task
The IBM Business
Process Manager data
collector gathers various product information, compresses it into
a .zip file, and optionally sends the compressed file to IBM for a
PMR. You can also use the tool to compress the data without sending
it to IBM. The command is
profile_root/bin/bpmdc C:/MyProfileDirectory/bin/bpmdc -PMR=12345.678.901 -uploadToIBM=yesYou
might use the IBM Business
Process Manager data
collector tool in these situations:
- After an issue occurs, you can use the basic bpmdc command to compress the log files for the profile into a .zip file.
- You can re-create an issue by setting a trace string using the administrative console or the wsadmin command, and then run the bpmdc command to collect the logs and send them to IBM.
- After opening a PMR, you can use the bpmdc -PMR=PMRnumber -uploadToIBM=yes command with the most relevant type options to upload relevant data.
- IBM Support provides a specific command or set of commands to run for your environment that obtains the needed data.
- IBM Support provides a trace string that must be gathered with the commands. With trace enabled, you can re-create the issue or wait for a reoccurrence before running the provided commands to gather and upload the data to IBM.
The IBM Business Process Manager data collector is not supported for z/OS.
The following table lists
the command line parameters.
| Command line parameter | Default value | Description |
|---|---|---|
| PMR | None | The 11-digit PMR number to which the data is
associated. Use one of the following forms for this value: 12345.678.901 or 12345,678,901. Note: Comma
characters can be an issue on the Microsoft Windows command line if you do
not surround the value with the double quotes.
|
| uploadToIBM | No | Specifies whether to upload the data to the IBM ECuREP site for a particular PMR. You can set this value to yes or no. |
| outputDirectory | install_root/BPM/isadc | The path to the directory where the output collection .zip file will be stored. |
| type | General | The type of collection to run. The valid values are General, Install, or Dump. |
| config | no | With a general collection, when you set this parameter to yes, the config directory is included. You can set this value to yes or no. |
| help | No values | When you include this parameter with the command, a description of the command options is displayed. |
The following table lists the server connection options
required for -type=Dump.
| Command line parameter | Default value | Description |
|---|---|---|
| server | None | The server from which you want to collect JVM dumps. |
| soapport | None | The SOAP port for the server. |
| user | None | The user with wsadmin access to the server to which you are connecting. |
| password | None | The password for the user. |
The following table lists the dump options available
for -type=Dump.
| Command line parameter | Default value | Description |
|---|---|---|
| dumptype | Thread | The type of Java™ virtual
machine (JVM) dump to trigger:
|
| count | 1 | The number of JVM dumps to trigger during the collection. |
| interval | 0 | The number of JVM dumps to trigger during the collection. |
You can run the command without any parameters, in which case the general collection is run and the log directory is compressed into a .zip file.
The output file name has the following format: PMRnumber.ProfileName_type_timeStampValue.zip
The
data gathered is based on the profile where the command is run. If
it is run from the installation directory, the default profile is
used.
Note: Be sure to run the command from the profile from which
you want to gather data.
- General collection
- The General collection type gathers the following
information:
- Profile logs directory (profile_root/logs). The collected files include all of the server log files and traces under this profile directory.
- The results of the versionInfo -maintenancePackages command.
- Optionally, the profile_root/config directory. This directory is collected only when the -config=yes option is used.
Note: The limitation with this collection is that it does not gather log files and traces if it goes to a custom directory outside the profile logs directory. It is not recommended that you change the log file locations from the default, because it makes it more difficult for others to find them. - Install collection
- The Install collection type gathers the following
information, which is listed in the technote Collect
troubleshooting data for installation or upgrade problems with IBM
Business Process Manager (BPM) products:
- Any temporary launchpad log files
- Installation Manager data directory
- The results of the versionInfo -maintenancePackages command
- Installation logs directory
- Profile logs directory
- Database upgrade script log files
- Various configuration files that are related to the installation process
- JVM Dump collection
- The Dump collection type triggers various types of JVM dumps on a target server
within a profile before gathering the general collection and generated dumps.
With the provided server connection options, the command will connect to the server using the SOAP port to make a wsadmin connection with the user and password. Depending on the dump type, it will trigger various JVM dumps until the count number is reached. The dumps are triggered a set number of seconds apart based on the interval that is set.
The Dump collection gathers general collection files such as /logs and version information, in addition to dump files such as javacores, heap dumps, and system dump .zip files.
Note: The server connected to must be the one you want to gather data from.