REST API

Purpose

Integation between SAP systems and other third party applications can be implemented via the SAP cloud integration platform.
This monitor will look for message log errors generated by the cloud platform and report alarms and metrics.

Configuration hints

Create one or several rules in the table to define the endpoint to monitor

The monitor will generate alarms following custom conditions

The monitor will generate custom metrics and metadata based on endpoint result

Surveillance table

Parameter	Description
Active	Use this field to activate or deactivate a line of configuration.
Request option	Define the end point to monitor (see Request configuration section)
Alarm	Use this field to activate or deactivate alarms
Alarms	Used to define the conditions to trigger an alarm
Metric	Use this field to activate or deactivate metrics
Metrics	Used to define generated metrics
Metadata	Use this field to activate or deactivate metadata
Metadata	Used to define generated metrics.

Request configuration

Parameter	Description
Name	Identifies the request by a name
Method	GET, HEAD, POST, PUT, PATCH, DELETE, OPTIONS, TRACE
Result type	Define the result type (JSON, XML, TEXT)
URL	The end point to monitor
Payload filter	JSONPATH or XMLPATH to prefilter result data
Module	Overrides the default module value of generated alarms and metrics
Headers	Customize/Override the http headers
Query params	Defines the http request parameters
Request body	Defines a request body (used for POST and PUT request)

Alarms

An alarm is defined by General parameter and assertions.
The assertions will define the conditions to trigger alarms.

General

Parameter	Description
Title	Identifies the alarm by a name
Alarm ID	Defines the alarm ID (Used for clear)
Module	Overrides the default alarm module
Severity	The alarm severity
Message	Custom alarm message. Variables can be used (see below)
To clear	If checked, the alarm will be cleared as soon as the alarm no longer happens
Tags	Customize the alarm tags. Variables can be used (see below)

Assertions

Parameter	Description
Assertion target	Sets the data to use for assertion
Operator	Defines the operator (if json path or xpath is selected, the path and new operator will be needed)
Expected value	The expected value from response or json/xml path

Metrics

Use a JSONPATH or XMLPATH to generate custom metrics.

Configuration

Parameter	Description
Name	Defines the identifier of the metric
Unit	Unit of the metric
Value	Value of the metric, the field can contains a JSON/XML path
Tags	Customize the alarm tags. The tag can contains variables or json,xml path (see below)

Variables

Variable	Description
%GROUP_ID%	Replaced by group's id field
%GROUP_UUID%	Replaced by group's uuid field
%GROUP_NAME%	Replaced by group's name field
%GROUP_COMPANY_NAME%	Replaced by group's company name field
%GROUP_SHORT_NAME%	Replaced by group's short name field
%SYSTEM_ID%	Replaced by system's id field
%SYSTEM_UUID%	Replaced by system's uuid field
%SYSTEM_SID%	Replaced by system's SID field
%SYSTEM_NAME%	Replaced by system's name field
%SYSTEM_ROLE%	Replaced by system's role field
%SYSTEM_ENVIRONMENT%	Replaced by system's environment field
%CON_ID%	Replaced by connector's id field
%CON_UUID%	Replaced by connector's uuid field
%CON_NAME%	Replaced by connector's name field
%CON_SHORT_NAME%	Replaced by connector's short name field
%MODULE%	Replaced by API
%AGENT%	Replaced by instance name