Check if xDI Runtime is running

If you need to check whether your runtime is active or not, you can do so in a few ways.

Using runtime metrics

xDI Runtime exposes internal metrics over a REST API, including a health check. This is the most convenient method.

Using the command line

The fastest way to see the runtime status is by using the startcommand script to check service status. Chain a connect command with the get services command, as in this example:

D:\apps\Semarchy\runtime> startcommand "connect to localhost port 42070;get services"
D:\apps\Semarchy\runtime> echo off
Connecting to localhost on port 42070
Connected
Name      Status  Duration
rdbms     Running 23:11:35.95
execution Running 23:11:34.548
soap      Running 23:11:32.847
listener  Running 23:11:34.548
scheduler Running 23:11:33.628

The output shows that all runtime services are in a Running state.

You can also confirm that startcommand was successful by checking its return code. It is stored in the ERRORLEVEL environment variable: %ERRORLEVEL% on Windows, and $ERRORLEVEL on Linux. The return code of the startcommand script is 0 when the runtime is active, and -1 when it is not running.

D:\apps\Semarchy\runtime> echo %ERRORLEVEL%
0

It is also possible to check the status of an individual service, and format the output:

D:\apps\Semarchy\runtime> startcommand "connect to localhost port 42070;get services name rdbms format '%status'"
D:\apps\Semarchy\runtime> echo off
Connecting to localhost on port 42070
Connected
Running

Using a specific process

To avoid having to use the command line, considering adding status notifiers to your processes.

For example, you can design and execute a process which uses actions to send status information. Actions such as FTP, SendMail, or file writing are possible choices, but you can use whatever matches your environment. At the end of the process, you could also send an email or update a flag to confirm that everything works.