Health Endpoint

Information

• This topic describes the health endpoint that can be used from S 39.5.37 to query the status of the server.

Configuration

• The configuration is carried out in web.conf or via environment variables.

• The following values are configured by default:

  • webservices__server_status__enable = false

  • webservices__server_status__connection = 0.0.0.0:9998

  • webservices__server_status__entrypoint = /ServerStatus

• Two additional end points are set up and return the status of the respective component as a minimum.

  • Both of them are configured with fixed values and extend the ServerStatus endpoint:

    • /manager

      • Available at http://ip_adresse:port/[webservices__server_status__entrypoint]/manager

    • /worker

      • Available at http://ip_adresse:port/[webservices__server_status__entrypoint]/worker

Return values

ServerStatus

The information is output in json format and have the following structure:

{
  "server": {
	"version": {
		  "release_date":[ DATUM ]
		  "release_version": [ TEXT ]
		}
	"state": {
		  "schema": [ SCHEMAINITIALIZATION ]
		  "server": [ STATE ]
		  "start_time": [ DATUM ]
		  "database": [ WEBSERVICESTATUS ]
		  "server_mode": [ SERVERMODE ]
		}
   "webservices": {
      "servicedocumentinterface": [ WEBSERVICESTATUS ]
      "genericservice": [ WEBSERVICESTATUS ]
      "serviceinterface": [ WEBSERVICESTATUS ]
      "prometheus": [ WEBSERVICESTATUS ]
      "monitoring": [ WEBSERVICESTATUS ]
      "secure": [ WEBSERVICESTATUS ]
    }
}

Details

• The DATE has the following format: "Fri Aug 09 08:30:05 UTC 2024" ("E MMM dd HH:mm:ss z yyyy")

• The [ SCHEMAINITIALIZATION ] can show these steps during server initialization:

  • NONE

  • INITIALIZING - the DB schema is initialized

  • FINISHED - is finished

• The [ STATE ] outputs the overall server status:

  • STARTING - server is started

  • LISTENING - server is running

  • STOPPING - server is stopped

  • SHUTDOWN - server is terminated

  • RECONFIGURING - server is restarted

• The [ SERVERMODE ] indicates the operating mode of the server:

  • NONE

  • STANDARD - normal operation

  • MIGRATION

  • IMPORT

  • EXPORT

• The [ WEBSERVICESTATUS ] shows the status of the respective services:

  • NONE - not approved or not configured correctly

  • INITIALIZING - is configured

  • RUNNING - started and functioning

  • STOPPED - stopped

Manager/Worker

Here too, the return value is output in json format and has this structure:

{"manager" oder "worker" : [ SYSTEMZUSTAND ]}

The [ SYSTEMZUSTAND ] shows the status of the respective container:
• healthy
• unhealthy