====== SAP users ======
  The goal of this monitor is to follow the amount of connections on each application server
  and to detect when the number of connected users is above a threshold.
  you can differentiate interactive, RFC and plugin users and 
  apply specific threshold for a given application server.

===== Configuration hints =====

  * The surveillance table allows to easily define how you want to monitor the users.
  * You can create several rules by adding any new line in the table and use the filter to target specific conditions.
  * Threshold and severity can be adapted for a specific type of user or for a specific application server.
  * If you set 0 as threshold for a given type of user, it will be ignored.

===== Configuration =====
  * **Send metrics:** 
    * If enabled, the monitor will send application logs metrics (See metrics table below)
  * **Use new collection method**
    * If enabled, the monitor will use a new function module to collect use information

==== Surveillance table ====

^Parameter^Description^
^Active|Use this field to activate or deactivate a line of configuration.|
^Instance|A filter to match only a subset of instances.|
^Max active users|Sets the threshold for the total number of connection (sums interactive, RFC and plugin)|
^Max interactive users|The threshold for interactive users.|
^Max RFC users|The threshold for RFC users.|
^Max Plugin users|The threshold for plugin users.|
^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.|
^Report|If checked, this line of surveillance will be used for report generation|
=== Examples ===
 
^Active^Instance^Max active users^Max interactive users^Max RFC users^Max Plugin users^Max user/dialog ratio^Max user/instance ratio^Severity^Auto clear^Alarm tag^
|true|*|100|50|0|0|WARNING|true| |true|false|

**Effect** : Generates a WARNING alarm if 100 or more users of any type are connected, or 50 or more interactive users connected.
===== Examples =====
 
^Active^Instance^Max active users^Max interactive users^Max RFC users^Max Plugin users^Max user/dialog ratio^Max user/instance ratio^Severity^Auto clear^Alarm tag^
|true|mysap_PRD_00|0|50|0|0|CRITICAL|true| |true|false|

**Effect** : Generates a CRITICAL alarm if 50 or more interactive users are connected to instance mysap_PRD_00
===== Generated metrics =====
 
^metricId^metricUnit^metricTarget^metricDescription^
| USERS_ACTIVE|Users|INSTANCE|The total number of user connection from any type, per application server and overall.|
| USERS_INTERACTIVE|Users|INSTANCE|The total number of interactive user connection from any type, per application server and overall|
| USERS_RFC|Users|INSTANCE|The total number of RFC user connections per application server|