Health-Endpunkt

Information

• Dieses Topic beschreibt den Health-Endpunkt, der ab S 39.5.37 genutzt werden kann, um den Status des Servers abzufragen/zu überwachen.

Konfiguration

• Die Konfiguration erfolgt in der web.conf oder per Umgebungsvariablen.

• Defaultmäßig sind die folgenden Werte konfiguriert:

  • webservices__server_status__enable = false

  • webservices__server_status__connection = 0.0.0.0:9998

  • webservices__server_status__entrypoint = /ServerStatus

• Zwei weitere Endpunkte werden eingerichtet und geben den Status der jeweiligen Komponente minimal zurück.

  • Diese sind jeweils mit festen Werten konfiguriert und erweitern den ServerStatus-Endpunkt:

    • /manager

      • Zu erreichen unter http://ip_adresse:port/[webservices__server_status__entrypoint]/manager

    • /worker

      • Zu erreichen unter http://ip_adresse:port/[webservices__server_status__entrypoint]/worker

Rückgabewerte

ServerStatus

Die Informationen werden im json-Format ausgegeben und haben diese Struktur:

{
  "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

• Das DATUM hat folgendes Format: "Fri Aug 09 08:30:05 UTC 2024" ("E MMM dd HH:mm:ss z yyyy")

• Die [ SCHEMAINITIALIZATION ] kann diese Schritte während der Initialisierung des Server anzeigen:

  • NONE

  • INITIALIZING - das DB-Schema initialisiert

  • FINISHED - ist beendet

• Der [ STATE ] gibt den Gesamtzustand des Servers aus:

  • STARTING - Server wird gestartet

  • LISTENING - Server ist in Betrieb

  • STOPPING - Server wird gestoppt

  • SHUTDOWN - Server wird beendet

  • RECONFIGURING - Server wird neu gestartet

• Der [ SERVERMODE ] gibt die Betriebsart des Servers wieder:

  • NONE

  • STANDARD - normaler Betrieb

  • MIGRATION

  • IMPORT

  • EXPORT

• Der [ WEBSERVICESTATUS ] zeigt den Zustand des jeweiligen Services an:

  • NONE - nicht freigeben oder nicht richtig konfiguriert

  • INITIALIZING - wird konfiguriert

  • RUNNING - ist gestartet und funktionsfähig

  • STOPPED - ist gestoppt

Manager/Worker

Auch hier ist der Rückgabewert im json-Format und hat diese Struktur:

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

Der [ SYSTEMZUSTAND ] gibt den Zustand des jeweiligen Containers wieder:
• healthy
• unhealthy