Products documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== CPI message processing logs ======
===== 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 logs and status to monitor
  * You can target specific integration flows and status by setting the appropriate filters
  * The monitor will generate alarms when log messages are matching the filter
  * You can use the aggregate mode to define the granularity of the alerting (see aggregate section below)
  * Activate the metric checkbox to generate metrics for counting the number of logs per integration flow and status.
 
===== Time period field =====
  * Defines the maximum age of the oldest log to collect in minutes from now
  * If set to 0, it will fetch all logs generated since the last check (example: From last 15 minutes if the monitor runs every 15 minutes)

===== Aggregate =====
  * This option allows to tune the granularity of alarms that will be generated: 
    * If enabled, you will only get one alarm if the count of logs matching the filter is above threshold. 
    * If disabled, you will receive one alarm per log, with more details about the log itself (error message, etc...)

===== Options =====
  * **Alert last only:** If enabled, it will only send an alarm for the last ERROR log of a flow (based on correlation Id)
  * **Collect custom headers:** For each log, an additional query will be performed to collect addtional headers information.
  * **Collect error info:** For each log, an additional query will be performed to collect addtional error information.
  * **Send metadata:** Send each log metadata to compatible integration plugins
  * **Send metrics:** Generate metrics for counting the amount of logs per combination of flow/status/custom status

===== Surveillance table =====
^Parameter^Description^
|Active| Use this field to activate or deactivate a line of configuration.|
|Period| The time period to look for messages (minutes) |
|Flow name | A filter on the message flow: Will only match messages belonging to this flow |
|Status| Used to match a specific message status|
|Custom Status| Used to match a specific message custom status|
|Max Messages| Used in aggregate mode. Send an alert if number of logs matching the filter is greater or equal than threshold. Multi threshold is available|
|Severity| The alarm severity if simple threshold is set|
|Aggregates|If checked, the threshold will be compared to the total number of messages matching the filter. If not checked, one alarm per message will be generated.|
|Auto clear|If checked, the alarm will be cleared as soon as the alarm condition is not met anymore.|
|Alarm tag|This field allows to add custom tags to the alarm, to be used with alarm rules filtering|
|Alarm|If checked, this line of surveillance will be used for alarm generation.|

===== Examples =====
 
^Active^Period^Flow name^Status^Custom status^Max messages^Severity^Aggregates^Auto clear^Alarm tag^Alarm^
|true|15|*|ERROR|*|10|WARNING|true|true| |true|

**Effect:** Generates a WARNING alarm if 10 or more log messages are found with status ERROR in the last 15 min

^Active^Period^Flow name^Status^Custom status^Max messages^Severity^Aggregates^Auto clear^Alarm tag^Alarm^
|true|0|iFlow_XYZ|ERROR|*|G2W:1 W2M:10|WARNING|true|true| |true|

**Effect:** Look for logs from iFlox_XYZ. Send a WARNING alarm if it finds 1 to 9 logs with status ERROR since the last check. Send a MAJOR alarm if 10 or more logs are found.
===== Generated metrics =====
 
^metricId^metricUnit^metric tags^metricDescription^
|SCPI_MESSAGE_PROCESSING_LOGS_COUNT|Logs|[INTEGRATION_WORKFLOW][STATUS][CUSTOM_STATUS]|The number of logs per workflow, status and custom status|