System monitoring (general) (REST API)

The status of Lobster Integration, the communication services of the Lobster Integration Server and the DMZ server (if available) can be queried via REST API (HTTP). As a result, you will receive a plain text HTML page with system information. You can use an external tool (e.g. Nagios, PRTG, etc.) to perform this query and automatically evaluate the result. Authentication is required for the HTTP query.

Authentication


The login name and password of a Lobster Integration user are used for authentication. Details can be found in section REST API (→ "Authentication").

There is a second option specifically for the system monitoring (and only here). The authentication process is the same here, but the access data does not come from a Lobster Integration user. Instead, a partner with the name "Monitorplain" must be created. You then create an "HTTP" channel with the name "MONITORDATA" for this partner. In this channel, you only need to fill the fields " Partner ID" and " Partner password" (arbitrary). You then use this access data for authentication.

If you want to query a DMZ server (if available), only this second option can be used. However, the name of the HTTP channel (also on the internal system) must be "MONITORDMZ". Additionally, parameter "addStandardServlets" in configuration file ./etc/startup_dmz.xml (on the DMZ server) must be set to true.

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

Authentication can also explicitly be deactivated on DMZ servers. However, we do not recommend this. For this purpose, the following parameter can be used in configuration file ./etc/startup_dmz.xml.

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

Standard queries


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


Each HTTP request provides a response as plain text (MIME type "text/plain") in which the monitored properties are listed in a table. The amount of output can be controlled by means of additional query parameters.


Parameter

Description

ftp=true

Show status of FTP service.

smtp=true

Show status of SMTP service.

oftp=true

Show status of OFTP service.

message=true

Show status of Message service and number of Messages on hold.

as2=true

Show status of AS2 service.

ssh=true

Show status of SSH service.

dw=true

Show status of Lobster Integration.

max=true

Only works with "all" or "dw". Shows the currently longest profile runtime. Note: Parameter "max=true" (in conjunction with "dw=true") consumes more resources and should therefore not be called more than approximately every 10 seconds.

all=true

Equivalent to "ftp=true&smtp=true&oftp=true&message=true&dw=true".

Example call Integration Server


http(s)://<IP/URL Integration Server or 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

Example call 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