==== Dispatcher queues ====

=== Purpose ===
This monitor is dedicated to the surveillance of the dispatcher queues. It can monitor the number of requests waiting in the queues at a given time, and the number of requests written within a given period of time.
=== Configuration hints ===

Use the surveillance table to create monitoring rule for each type of queue, and set the threshold for the maximum number of requests to watch for a given queue.  
If you set a period to a value different than 0, the threshold will be used to compare against the number of requests received within the period, instead of the total number of waiting requests 
=== Surveillance table ===

^Parameter^Description^
^Active|Use this field to activate or deactivate a line of configuration.|
^Queue type|Choose the type of queue to watch|
^Cur. waiting req. (nb or %)|The threshold for number of waiting requests, in absolute or in percentage of the total capacity of the queue.|
^Max. written req.|The threshold for the number of requests written in the queue with the configured period.|
^Period (min)|The period of time used by the Max written request threshold.|
^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.|
=== Examples ===
 
^Active^Queue type^Cur. waiting req. (nb or %)^Max. written req.^Period (min)^Severity^Auto clear^Alarm tag^Alarm^Metric^
|true|DIALOG|80%|0|5|MAJOR|true| |true|false|

**Effect** : Sends a MAJOR alarm if the DIALOG queue is filled up to 80% or more. Ignore the number of written requests.
=== Examples ===
 
^Active^Queue type^Cur. waiting req. (nb or %)^Max. written req.^Period (min)^Severity^Auto clear^Alarm tag^Alarm^Metric^
|true|DIALOG|80%|5000|5|MAJOR|true| |true|false|

**Effect** : Same than previous example, but also send an alarm if 5000 requests or more have been written in the last 5 minutes.
=== Generated metrics ===
 
^metricId^metricUnit^metricTarget^metricDescription^
|DISPATCHER_QUEUES_PERCENTAGE_USED|Percent|INSTANCE:TYPE|The usage ratio of a dispatcher queue (Nb of waiting requests/Max size)|
|DISPATCHER_QUEUES_NB_WAITING|Waiting requests|INSTANCE:TYPE|The total number of requests waiting in the queue|
|DISPATCHER_NB_WRITTEN_REQUESTS_IN_PERIOD|Written Request|INSTANCE:TYPE|The number of requests written in the queue within the configured period|