General: System Interaction via HTTP (REST API).

Standard Queries

It is possible to monitor Lobster_data and the communication services of the Lobster Integration Server with an external tool (e.g. Nagios).

The following URL is available for this purpose.

http(s)://<IP/URL Integration Server>:<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.
as2=true	Show status of AS2 service.
ssh=true	Show status of SSH service.
dw=true	Show status of Lobster_data.
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

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

Result

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 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 
Emergency Mode active = false
Remaining Emergency Ticks = 1344

Further Queries

In addition to the queries above, there is another sub-path for further system information.

Lobster_data Queues

The following call also shows the number of jobs in the individual queues of Lobster_data.

http(s)://<IP/URL Integration Server>:<Port>/dw/monitor/v1/monitorplain4?dw=true

or

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

_data lowest prio queued jobs = 0
_data lower prio queued jobs = 0
_data normal prio queued jobs = 0
_data higher prio queued jobs = 0
_data highest prio queued jobs = 0

Reorganisation Run

The following call shows additional information about the last reorganisation run. See also section System Monitoring with Profiles .

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

or

http(s)://<IP/URL Integration Server>:<Port>/dw/monitor/v1/monitorplain4?all=true&reorg=true

Reorganisation sec ago = 23771
Reorganisation duration = 9

The value sec ago shows how many seconds ago the reorganisation run was finished. The value duration shows the duration of the run in seconds.

Special Cases

If there was no reorganisation in the last 36 hours:

Reorganisation sec ago = -1
Reorganisation duration =

If the reorganisation was started but not successfully completed:

Reorganisation sec ago = 24491
Reorganisation duration = -1

In the last case the value sec ago refers to the start of the run, because the end cannot be determined.

Status SAP

The following call shows information about connected SAP systems. Note: The parameter must be specified explicitly and is not included in all=true.

http(s)://<IP/URL Integration Server>:<Port>/dw/monitor/v1/monitorplain4?sap=true

SAP status = Alive
SAP aliases = 0/1 [my_sap_alias/0] !

The first line shows whether the SAP service is running.

If the service is running, information about the aliases is displayed in the second line. Format:

<Number of configured aliases with connections>/<number of configured aliases> [<alias name>/<number of connections>,<alias name>/<number of connections>, ...]

An exclamation mark is added at the end of the line if the number of connected aliases is less than the number of configured aliases, i.e. at least one alias has no connection. Note: The number of connections corresponds to the total number displayed in the SapConnectionService in the Admin Console.

Hard Disk Usage

The following call shows additional information about the hard disk usage of the partition where Lobster_data is installed.

http(s)://<IP/URL Integration Server>:<Port>/dw/monitor/v1/monitorplain4?hdd=true

or

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

HDD TotalMBytes = 61725
HDD FreeMBytes  = 47638
HDD FreePercent = 77.18

System Monitoring (general) (REST API)