==== SAP transaction times ====

=== Purpose ===
This monitor is dedicated to the monitoring of SAP transactions average execution time per step.  
You can define the transaction, task and period for which you want to analyze the response time. The monitor will then generate an alarm if the response time is over a threshold.
=== Configuration hints ===

Create one or several rules in the table to define transaction times monitoring. You can watch a specific transaction, or a group of transaction using regular expression.  You can also leave * in transaction name and watch all transactions of a given type of task. 
**Note:** Computing average response times over a period longer than 30 minutes can consume a large amount of resources on the SAP system and is not advised.


**If an average response time of 0 ms is reported for all transactions, it is very likely that the timezone of your SAP system is not matching the one of the OS**
=== Surveillance table ===

^Parameter^Description^
^Active|Use this field to activate or deactivate a line of configuration.|
^Transaction|Defines the transaction to watch for. You can use regexp to match a subset of transactions.|
^Excluded transaction|A filter to exclude some transactions. Mostly useful if you defined a large subset (like '*') in the transaction field.|
^Task|The type of task in which the transaction is running.|
^Period (min, max 30)|The period of time for which the average response time will be computed.|
^Max time/step (ms)|The threshold for the maximum time per step in milliseconds.|
^Min step count|The minimum number of steps expected in order to consider the response time to be relevant, and thus evaluate the alarm condition.|
^Aggregate|Is selected, it will compute the global response time of all the transactions matching the 'transaction filter'. If not selected, the response time of each transaction will be compared to the threshold. Potentially several alarms per line can 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^Transaction^Excluded transaction^Task^User^Period (min, max 30)^Max time/step (ms)^Min step count^Aggregate^Severity^Auto clear^Alarm tag^Alarm^
|true|*|Z.*|DIALOG|5|150|500|false|MAJOR|true| |true|false|

**Effect** : Sends an alarm for each transaction (except the ones starting with Z) having a response time per step greater than 150ms over the last 5 minutes. If less than 500 DIALOG steps were executed within the period, no alam will be sent.
=== Examples ===
 
^Active^Transaction^Excluded transaction^Task^User^Period (min, max 30)^Max time/step (ms)^Min step count^Aggregate^Severity^Auto clear^Alarm tag^Alarm^
|true|VA01| |DIALOG|5|150|500|false|MAJOR|true| |true|false|

**Effect** : Sends an alarm if VA01 transaction response time is greater than 150 ms over the last 5 minutes.
=== Generated metrics ===
 
^metricId^metricUnit^metricTarget^metricDescription^
|TRANSACTION_AVG_TIME_PER_STEP|Avg time per step (ms)|TASK / TRANSACTION|Sends the average response time per step for a transaction, a group of transaction or a task|