====== Servers metrics ======
===== Purpose =====
  This monitor allows to discover any meaningful metric from the server and monitor its value.
  Metrics can be discovered and selected from the monitor's menu
===== Configuration hints =====
  * Use the "Load servers" button to get the list of servers existing in your BO system.
  * Then select the servers you want to monitor.   To select the metric you want to monitor select a rule in the surveillance table you want to edit and hit the "Wizard" button.
  * You will get a list of metrics (with their current value) that you can monitor.
  * Use the special character "*" to define a rule for all the servers
===== Surveillance table =====
^Parameter^Description^
^Active|If checked, the rule will be active.|
^Server|The server(s) concerned by the rule.|
^Metric to monitor|The monitored metric|
^Threshold|A threshold that if breached an alarm will be sent|
^Severity|The severity of the alarm|
^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^Server^Metric to monitor^Threshold^Severity^Auto clear^Alarm tag ^Alarm^Metric^
|true|*|Auditing.numberOfEventsInTheQueue|100|CRITICAL|true| |true|true|

**Effect** : An alert will be sent if a server has his metric "Auditing.numberOfEventsInTheQueue" with a value greater than 100.   The value of this metric will be sent
===== Generated metrics =====
 
^metricId^metricUnit^metricTarget^metricDescription^
|[serverName]_[metricName]| |Metric name|Metric populated by BO configured to be monitored in Redpeaks|