Heap Dump Creation

By default, when Transformer encounters an out of memory error (OOME), it creates a heap dump.

By default, heap dump files are written to the file defined in the TRANSFORMER_LOG environment variable and use a naming convention that allows generating multiple heap dump files, as follows: $TRANSFORMER_LOG/transformer_heapdump_${timestamp}.hprof.

You can change the name of the heap dump files, but we recommend using the ${timestamp} or similar variable to ensure that the heap dump name is unique.

Note that Java Virtual Machine, and therefore Transformer, does not overwrite existing heap dump files. For example, if you use $TRANSFORMER_LOG/transformer_heapdump.hprof as the file name, after Transformer creates the first heap dump file, it will not create another until you remove the existing file.

Note: Depending on the number and size of the generated heap dump files, you might want to increase the Transformer Java heap size.

You can configure the following heap dump environment variables:


Heap Dump Environment Variable	Description
TRANSFORMER_HEAPDUMP_ON_OOM	Specifies whether Transformer generates a heap dump upon encountering an out of memory error. Default is true.
TRANSFORMER_HEAPDUMP_PATH	Specifies the file name and location to use for heap dump files. By default, heap dumps are written to `$TRANSFORMER_LOG/transformer_heapdump_${timestamp}.hprof`. To specify a different file name or location, uncomment the property and enter the location and file name to use. Tip: To write multiple heap dump files to a directory, use a function or variable to ensure that the file name is unique. If a file of the same name exists in the directory, Transformer does not create a new heap dump file.

Modify environment variables using the method required by your installation type.