====== PI/XI messages ABAP ======
  This monitor is dedicated to the monitoring of PI/XI messages status of ABAP stack instances.
  It requires to be associated with an ABAP connector to the target SAP system
===== Configuration hints =====
  * With this monitor, you will have the possibility to detect and to be notified when a message or a group of messages has a particular status.
  * Use the surveillance table to define the monitoring settings.
  * Set the clients from which to collect the messages (**Client is not a filter, but the parameter of a query**)
  * You can filter in or out certain types of messages by using Sender, Receiver and Emit/Rec Interface fields.
  * You can adjust the level of alarm severity depending on the type of status or on message properties. 
  * A disabled severity will filter out the messages matching the filters, for all subsequent lines.
  * This monitor will analyze the messages received since the last check time, with a maximum analyze depth of 60 minutes.
===== Atomic fields =====
^Message Limit|The maximum number of message to fetch per call. This is a security to prevent downloading too much data.|

===== Surveillance table =====
^Parameter^Description^
^Active|Use this field to activate or deactivate a line of configuration. |
^Status|Define the type message status to look for. |
^Client|The client in which the messages will be collected|
^Sender|A filter on the sender of the messages. |
^Receiver|filter on the receiver of the messages. |
^Sender interface|A filter on the message emitter interface.|
^Receiver interface|A filter on the message receiver interface.|
^PID|A filter on the message PID.|
^Max. messages|The threshold for the number of messages going through the filter.|
^Aggregates|If not set, one alarm per message matching the filters will be sent. If set, an alarm will be sent only if the cumulated number of messages matching the filter is not below the threshold.|
^Severity|The default severity to apply when the simple threshold syntax is used.|
^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 text within the alarm message. %MSG% variable will contain the actual generated message and can be used such as: "my_prefix %MSG% my_suffix". By default, tag will be used as prefix. |
^Alarm|If checked, this line of surveillance will be used for alarm generation. |
^Metric|If checked, this line of surveillance will be used for metric generation. |
^Report|If checked, this line of surveillance will used for showing threshold and severity in the daily report |
===== Examples =====
 
^Active^Status^Client^Sender^Receiver^Sender interface^Receiver interface^PID^Max. messages^Aggregates^Severity^Auto clear^Alarm tag^Alarm^Metric^Report^
|true|ANY_ERROR|000|*|*|*|*|*|1|false|MAJOR|true| |true|false|false|

**Effect** : Sends a MAJOR alarm per messages having an ERROR state since the last check time.
===== Examples ===== 
 
^Active^Status^Client^Sender^Receiver^Sender interface^Receiver interface^PID^Max. messages^Aggregates^Severity^Auto clear^Alarm tag^Alarm^Metric^Report^
|true|SYSTEM_ERROR|000|*|*|*|*|*|10|true|CRITICAL|true| |true|false|false|

**Effect** : Sends a CRITICAL alarm if 10 or more messages have a SYSTEM_ERROR state since the last check time.
===== Generated metrics ===== 
 
^metricId^metricUnit^metricTarget^metricDescription^
|PIXI_ABAP_MESSAGES_STATUS|Status|[TYPE][CLIENT][SENDER][RECIVER][EMIT_INT ][REC_INT][PID]|Sends TRUE if the rule generated an alarm for this filter, FALSE instead.|
|PIXI_ABAP_MESSAGES_STATUS_COUNT|Message errors|[TYPE][CLIENT][SENDER][RECIVER][EMIT_INT ][REC_INT][PID]|Sends the number of messages matching the filter|