System Monitoring (allgemein) (REST API)

Der Zustand von Lobster Integration, der Kommunikationsdienste des Lobster Integration Servers und des DMZ-Servers (falls vorhanden) kann per REST-API (HTTP) abgefragt werden. Als Ergebnis erhalten Sie eine Plaintext-HTML-Seite mit System-Informationen. Sie können ein externes Tool (z. B. Nagios, PRTG, usw.) verwenden, um diese Abfrage durchzuführen und das Ergebnis automatisch auszuwerten. Für die HTTP-Abfrage ist eine Authentifizierung notwendig.

Authentifizierung


Zur Authentifizierung wird der A nmeldename und das Passwort eines Lobster-Integration-Benutzers verwendet. Details finden Sie in Abschnitt REST API (→ Authentifizierung).

Speziell für das System Monitoring (und nur hier) gibt es eine zweite Möglichkeit. Die Authentifizierung läuft hier gleich ab, aber die Zugangsdaten stammen nicht von einem Lobster-Integration-Benutzer. Stattdessen wird hier ein Partner mit dem Namen Monitorplain erzeugt. Für diesen Partner legen Sie dann einen HTTP-Kanal mit dem Namen MONITORDATA an. In diesem Kanal müssen Sie lediglich die Felder "Partner Kennung" und "Partner Kennwort" füllen (beliebig). Diese Zugangsdaten verwenden Sie dann für die Authentifizierung.

Wenn Sie einen DMZ-Server (falls vorhanden) abfragen wollen, kann nur die eben beschriebene zweite Möglichkeit verwendet werden. Der Name des HTTP-Kanals (ebenfalls auf dem inneren System) muss hier aber MONITORDMZ sein. In der Konfigurationsdatei ./etc/startup_dmz.xml (auf dem DMZ-Server) muss zudem zwingend der Parameter addStandardServlets auf true gesetzt werden.

<Call name="addStandardServlets"><Arg type="boolean">true</Arg></Call>

Auf DMZ-Servern kann die Authentifizierung auch explizit deaktiviert werden. Dies wird von uns aber nicht empfohlen. Dazu kann in der Konfigurationsdatei ./etc/startup_dmz.xml (auf dem DMZ-Server) der folgende Parameter benutzt werden.

<!-- disable authentication for monitoring requests (aka monitorplain.jsp) - not recommended
<Call name="disableMonitoringCredentials"/>
-->

Standard-Abfragen


http(s)://<IP/URL Integration Server oder DMZ>:<Port>/dw/monitor/v1


Jeder HTTP-Zugriff liefert eine Response als Plaintext (MIME Type text/plain), in der tabellarisch die überwachten Eigenschaften gelistet werden. Durch zusätzliche Query-Parameter kann der Umfang der Ausgabe gesteuert werden.


Parameter

Beschreibung

ftp=true

Status des FTP-Dienstes anzeigen.

smtp=true

Status des SMTP-Dienstes anzeigen.

oftp=true

Status des OFTP-Dienstes anzeigen.

message=true

Status des Message-Dienstes anzeigen und Anzahl noch nicht abgearbeiteter Messages.

as2=true

Status des AS2-Dienstes anzeigen.

ssh=true

Status des SSH-Dienstes anzeigen.

dw=true

Status von Lobster Integration anzeigen.

max=true

Wirkt nur zusammen mit all und dw. Dann wird die aktuell längste Profillaufzeit angezeigt. Hinweis: Der Parameter max=true (in Verbindung mit dw=true) verbraucht mehr Ressourcen und sollte daher nicht öfter als etwa alle 10 Sekunden aufgerufen werden.

all=true

Gleichbedeutend mit ftp=true&smtp=true&oftp=true&message=true&dw=true

Beispiel-Aufruf Integration Server


http(s)://<IP/URL Integration Server oder DMZ>:<Port>/dw/monitor/v1?dw=true&as2=true


Server's local time = Wed Sep 21 11:59:52 CEST 2022
HTTP status = Alive
AS2 status = Alive
startupservice status = Alive
startup applications = 3: [HubStartupConfiguration, DataWizardSetup, WebMonitor]
_data status = Alive
_data processed requests = 112449
_data queued jobs = 0
_data queued responses = 0
_data total errors = 63
_data unresolved = 1
_data running profiles = 0
Total memory = 12582912 KB
Free memory = 11551032 KB
Max memory = 12582912 KB
Used memory = 8% used
Number of Threads = 281
available Processors = 8
operating system = amd64
system load = 0.0
Lobster IS Version = IS/5.9.13_50428
Lobster_data Version = 4.5.0_50411 
License emergency mode active = false
Remaining Emergency Ticks = 1344

Beispiel-Aufruf DMZ-Server


http(s)://<IP/URL DMZ>:<Port>/dw/monitor/v1?all=true


Server's local time = Thu Jun 27 09:39:05 CEST 2024
_DMZ status = Alive
 
AS2 status = Failed
FTP status = Alive, Sessions: 1
SMTP status = Failed -> SmtpService not added to factory yet
OFTP TCP/IP status = Alive, Sessions: 0
SSH status = Alive, Sessions: 0
Message remote interface = Alive
Total messages on hold = 1
Q context = System Q name = UpdateDmz on hold = 1
failed services = 2: [AS2, SMTP]
Total memory = 4194304 KB
Free memory = 1660966 KB
Max memory = 4194304 KB
Used memory = 60% used