X4 Produktdokumentation

Heap Dumps for Service Installations

There are several ways to configure an X4 installation that runs as a Windows or Linux service. We show one of the options here.

For this purpose, the standalone.bat file (Windows) or standalone.conf file (Linux) has to be changed in the following folder:

  • Windows: <server_directory>\wildfly\bin\standalone.bat

  • Linux: <server_directory>\wildfly\bin\standalone.conf

How to change the standalone.bat file (Windows)

  1. Open the standalone.bat file in the <server_directory>\wildfly\bin\standalone.bat folder in a text editor.

  2. Add the following command line parameter in the standalone.bat file:

    Untitled-20240611-091838.png

    Command line parameter for Windows

    @set JAVA_OPTS=%JAVA_OPTS% -XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath="<PathToStoreTheHeapDump>"
    
  1. Adjust the path where the heap dump is to be saved.
    info Only absolute paths are possible.


  2. Save the standalone.bat file.

If a memory shortage occurs with the modified standalone.bat file, a file with a name such as java_pid23948.hprof is saved in the specified path. This file contains the heap dump.

How to adapt thestandalone.conf file (Linux)

  1. Open the standalone.conf file in the <server_directory>\wildfly\bin\standalone.conf folder in a text editor.

  2. Add this command line parameter in the standalone.conf file analogous to windows:
    Command line parameter for Linux:

    JAVA_OPTS=$JAVA_OPTS -XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath="<PathToStoreTheHeapDump>"
    
  1. Adjust the path where the heap dump is to be saved.
    info Only absolute paths are possible.

  2. Save the standalone.conffile.

If a memory shortage occurs with the modified startX4.conf file, a file with a name such as java_pid23948.hprof is saved in the specified path. This file contains the heap dump.