==== Update requests ====

=== Purpose ===
This monitor is dedicated to the monitoring of SAP updates. It will look for updates with ERROR, NOT_COMPLETED or INCONSISTENT status. 
When an update or a group of updates with such status is discovered, the monitor will generate an alarm
=== Configuration hints ===

You can customize the monitoring in order to match updates from a specific client, user, TCode or report. Use the surveillance table to adjust the monitoring settings: Thresholds, severity, filters, etc... 
Only the number of inconsistent updates can be collected, filters won't work with this type.
=== Surveillance table ===

^Parameter^Description^
^Active|Use this field to activate or deactivate a line of configuration.|
^Status|The status of updates to look for.|
^Client|A filter to match only a given client or subset of clients|
^User|A filter to match only a user or a subset of users.|
^TCode|A filter to match only TCode of a subset of TCodes.|
^Report|A filter to match only a given report or a subset of reports|
^Threshold|The maximum number of updates having the specified status and matching the defined filters.|
^Aggregate|If checked, the threshold will be compared to the total number of updates matching the filter. If not checked, the probe will group updates having the same Client/User/TCode/Report values and compare the cardinality of each group to the threshold. Several alarms can potentially be generated.|
^Severity|The level of severity of the alarm generated by this line of surveillance.|
^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 QOS generation.|
^Report|If checked, this line of surveillance will used for showing threshold and severity in the daily report|
=== Examples ===
 
^Active^Status^Client^User^TCode^Report^Threshold^Aggregate^Severity^Auto clear^Alarm tag^Alarm^Metric^
|true|ERROR|*|*|*|*|1|true|MAJOR|true| |true|false|false|

**Effect** : Sends a MAJOR alarm if any update with ERROR status is found.
=== Examples ===
 
^Active^Status^Client^User^TCode^Report^Threshold^Aggregate^Severity^Auto clear^Alarm tag^Alarm^Metric^
|true|INCONSISTENT|800|jdoe|*|*|10|true|WARNING|true| |true|false|false|

**Effect** : Sends a WARNING alarm if there are 10 or more INCONSISTENT updates on client 800 from user jdoe
=== Generated metrics ===
 
^metricId^metricUnit^metricTarget^metricDescription^
|UPDATES_ERRORS|Updates|[CLIENT][USER][TRANSACTION][REPORT]|Sends the number of updates matching the filter, having an error status.|
|UPDATES_NOT_COMPLETED|Updates|[CLIENT][USER][TRANSACTION][REPORT]|Send the number of incomplete updates matching the filter|