IBM User Guide for Java V7 on Windows > Troubleshooting and support > Using diagnostic tools > Using dump agents

Dump agent environment variables

The -Xdump option on the command line is the preferred method for producing dumps for cases where the default settings are not enough. You can also produce dumps using the JAVA_DUMP_OPTS environment variable.

If you set agents for a condition using the JAVA_DUMP_OPTS environment variable, default dump agents for that condition are disabled; however, any -Xdump options specified on the command line will be used.

The JAVA_DUMP_OPTS environment variable is used as follows:

JAVA_DUMP_OPTS="ON<condition>(<agent>[<count>],<agent>[<count>]),
ON<condition>(<agent>[<count>],...),...)"

where:

• <condition> can be:
  • ANYSIGNAL
  • DUMP
  • ERROR
  • INTERRUPT
  • EXCEPTION
  • OUTOFMEMORY

• <agent> can be:
  • ALL
  • NONE
  • JAVADUMP
  • SYSDUMP
  • HEAPDUMP

• <count> is the number of times to run the specified agent for the specified condition. This value is optional. By default, the agent will run every time the condition occurs.

JAVA_DUMP_OPTS is parsed by taking the leftmost occurrence of each condition, so duplicates are ignored. The following setting will produce a system dump for the first error condition only:

ONERROR(SYSDUMP[1]),ONERROR(JAVADUMP)

Also, the ONANYSIGNAL condition is parsed before all others, so

ONINTERRUPT(NONE),ONANYSIGNAL(SYSDUMP)

has the same effect as

ONANYSIGNAL(SYSDUMP),ONINTERRUPT(NONE)

If the JAVA_DUMP_TOOL environment variable is set, that variable is assumed to specify a valid executable name and is parsed for replaceable fields, such as %pid. If %pid is detected in the string, the string is replaced with the JVM's own process ID. The tool specified by JAVA_DUMP_TOOL is run after any system dump or Heapdump has been taken, before anything else.

Other environments variables available for controlling dumps are listed in Javadump and Heapdump options.

The dump settings are applied in the following order, with the settings later in the list taking precedence:

1. Default JVM dump behavior.
2. -Xdump command-line options that specify -Xdump:<type>:defaults, see defaults option.
3. DISABLE_JAVADUMP, IBM_HEAPDUMP, and IBM_HEAP_DUMP environment variables.
4. IBM_JAVADUMP_OUTOFMEMORY and IBM_HEAPDUMP_OUTOFMEMORY environment variables.
5. JAVA_DUMP_OPTS environment variable.
6. Remaining -Xdump command-line options.

Setting JAVA_DUMP_OPTS only affects those conditions that you specify. Actions on other conditions are unchanged.

Parent: Using dump agents

Error 404 - Not Found

The document you are looking for may have been removed or re-named. Please contact the web site owner for further assistance.