Troubleshoot the Release service

This topic describes how to troubleshoot the Release service.

The Release service does not start

If the Release service does not start, increase the startup timeout:

  1. Stop the service:

    Operating system Shortcut
    Microsoft Windows Ctrl + c
    Unix-based systems Ctrl + c
  2. Uninstall Release.
  3. Add a timeout value.

    • Unix-based systems: Go to XL_RELEASE_SERVER_HOME/conf/xlr-wrapper-linux.conf and add the following line: wrapper.startup.timeout=<timeout>
    • Microsoft Windows: Go to XL_RELEASE_SERVER_HOME\conf\xlr-wrapper-win.conf and add the following line: wrapper.startup.timeout=<timeout> Where <timeout> is the startup timeout in seconds.
  4. Save the file.
  5. Reinstall the Release service.
  6. Start the service:

    • Microsoft Windows: Point a CLI to XL_RELEASE_SERVER_HOME/bin and execute run.cmd.
    • Unix-based systems: Point a terminal to XL_RELEASE_SERVER_HOME/bin and executerun.sh.

The Release service occasionally fails to start or stop

The Release service may occasionally fail to stop after a stop command is issued, or start after a start command is issued (as shown in the server log). If these situations occur:

  1. Stop the service:

    Operating system Shortcut
    Microsoft Windows Ctrl + c
    Unix-based systems Ctrl + c
  2. Uninstall Release.
  3. In the XL_RELEASE_SERVER_HOME/conf/xlr-wrapper-linux.conf file, add the following line:wrapper.fork_hack = true
  4. Save the file.
  5. Reinstall the Release service.
  6. Start the service:

    • Microsoft Windows: Point a CLI to XL_RELEASE_SERVER_HOME/bin and execute run.cmd.
    • Unix-based systems: Point a terminal to XL_RELEASE_SERVER_HOME/bin and execute run.sh.

Release is occasionally killed by service wrapper

If Release suddenly stops working, inspect the service wrapper logs. The service wrapper process may have killed the Release instance JVM because it did not respond within the configured time period. The configuration option that defines this period is wrapper.ping.timeout and the default time is 30 seconds.

If the JVM heap is large, it may cause a long garbage collection pause when Release is under load. If this occurs, increase the ping timeout to 60 or 120 seconds. You can configure the service wrapper options via XL_RELEASE_SERVER_HOME/conf/xlr-wrapper-linux.conf (on Unix-base systems) or XL_RELEASE_SERVER_HOME\conf\xlr-wrapper-win.conf (on Microsoft Windows) files.

For more information on the service wrapper, see the Java Service Wrapper documentation.

Uninstall the Release Service

To remove an installed Release service from your system:

  1. Open a terminal.
  2. Point to and execute the following:

    Operating system Shortcut
    Microsoft Windows XL_RELEASE_SERVER_HOME\bin\uninstall-service.cmd
    Unix-based systems XL_RELEASE_SERVER_HOME/bin/uninstall-service.sh