API Calls for Alive Check and Server Information

1 AliveCheckServlet
- 1.1 Usage
- 1.2 Evaluation
2 ServerInfoServlet

If the need arises to check if the system's web server is fully functional, these servlets offer a convenient way. There are two servlets available.

AliveCheckServlet

This servlet is accessible without logging in.

Usage

If you want to use the servlet, the following link has to be clicked: https://serveraddress/loom-portal/AliveCheckServlet.do

Example response:

hostname=nameofthehost
hostaddress=1.1.1
status=OK
duration=17
time=2022-06-15_13:28:03
startup=2022-06-14_18:12:09
sysuptimeindays=182
timuptimeinmins=1155
swversion=7.7.0-alpha.6
database1=true

Evaluation

The response of the AliveCheckServlet calls contains the following attributes and values:

System Information	Description

System Information	Description
hostname	Name of the host server.
hostaddress	IP address of the host server.
status	It shows the overall status of the server. It can either be OK, wARNING or, ERROR. ERROR means that an essential interface (e.g. the database) does not function/cannot be reached. wARNING means that a non-essential interface (e.g. web services endpoint) does not function/cannot be reached. OK is put out, when both above do not apply, so the interfaces can be reached.
duration	The duration of the call is given. Units are in milliseconds (ms).
time	This information shows the current date and time of the server in the following format: `YYYY-MM-DD_HH:mm:ss` (Year, Month, Day, Hours, Minutes, Seconds). Example: `2022-06-15_07:56:29`
startup	The start time of the JBoss/Wildfly server, which tells since when the current application/program instance is running.
sysuptimeindays	The duration in days since when the server is up and running since last restart.
timuptimeinmins	The duration in minutes since when the Server is up and running since last restart.
swversion	Currently installed version of the Software.
database1	This value can either be `true` or `false`. `true` means database is connected.

If changes are made to the tim.properties while the server is running, reloading the tim.properties file is necessary. The following link can be used with the parameter ?reload=true at the end of the URL:
http://serveraddress/loom-portal/AliveCheckServlet.do?reload=true

ServerInfoServlet

This servlet is only accessible by the admin user, so logging into the System is necessary. It provides more and sensitive information than the AliveCheckServlet.

Example response:

hostname=nameofthehost
hostaddress=1.1.1.1
status=OK
duration=34
time=2022-06-15_14:05:28
startup=2022-06-14_18:12:09
sysuptimeindays=182
javaversion=11.0.8
javaruntimeversion=11.0.8+10-LTS
javavendor=Amazon.com Inc.
jvmname=OpenJDK 64-Bit Server VM
timuptimeinmins=1193
swversion=7.7.0-alpha.6
swrevision=7a97c6a
database1=true
memmax=2048
memtotal=2048
memfree=900

Additional information's descriptions are in the below table:

System Information	Description

System Information	Description
hostname	Name of the host server.
hostaddress	IP address of the host server.
status	It shows the overall status of the server. It can either be OK, wARNING or, ERROR.
duration	The duration of the call is given.
time	The current server time is given.
startup	The start point of the JBoss/Wildfly is given.
sysuptimeindays	The duration in days since when the server is up and running since last restart.
javaversion	Standardized version of the installed Java Runtime Environment.
javaruntimeversion	Technical version description of the installed Java Runtime Environment.
javavendor	Vendor that provides Java runtime environment.
jvmname	Name of the used JDK.
timuptimeinmins	The duration in minutes since when the Server is up and running since last restart.
swversion	Currently installed version of the Software.
swrevision	Final commit of the version.
database1	This value can either be `true` or `false`.
memmax	Maximum given memory for the Virtual Machine.
memtotal	The server's overall memory capacity is given in bytes.
memfree	The server's free memory capacity is given in bytes.