==== SAP transports ====

=== Purpose ===
Transports are used to propagate changes across systems. It is important to detect when a transport is in an error state in order to reprocess it.  
This monitor will watch for failed transports and notify as soon as one is detected
=== Configuration hints ===

Create a rule in the surveillance table and set the filter as you need. If the number of failed transports matching the filters is over the threshold, an alarm will be sent. 
Via the filters, you can customize how transports will be monitored for a given transport, user or client.


**Aggregate:** 
If active, only one alarm per rule will be generated if the number of failed transports matching the filter is above threshold. It will report how many transports have failed, with no details. 
if not active, one alarm per failed transport will be sent, along with more details concerning the transport itself: Client, user, return code, step, timestamp.
=== Surveillance table ===

^Parameter^Description^
^Active|Use this field to activate or deactivate a line of configuration.|
^Transport|A filter to match only a given transport name. The use of regular expression can be made here.|
^Client|A filter to match only a subset of clients.|
^User|A filter to match only a subset of users.|
^Aggregate|If checked, the probe will send one alarm indicating the number of failed transports matching the filter. If not checked, the probe will send an alarm for each failed transport matching the filter. 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 metric generation.|
=== Examples ===
 
^Active^Transport^Client^User^Aggregate^Severity^Auto clear^Alarm tag^Alarm^Metric^
|true|*|*|*|true|WARNING|true| |true|false|

**Effect** : This configuration will send a MAJOR alarm as soon as a failed transport is detected. The alarm will be cleared automatically if when the transport has finally been applied successfully
=== Examples ===
 
^Active^Transport^Client^User^Aggregate^Severity^Auto clear^Alarm tag^Alarm^Metric^
|true|*|*|JDOE|true|MAJOR|false| |true|false|

**Effect** : This will send a MAJOR alarm as soon as a transport created by user JDOE has a failed status. This alarm won't be cleared by the probe.
=== Generated metrics ===
 
^metricId^metricUnit^metricTarget^metricDescription^
|SAP_FAILED_TRANSPORTS|Transports|[TRANSPORT][CLIENT][USER]|Sends the number of failed transports matching the filter|