==== SAP buffers ====

=== Purpose ===
This monitor will look for SAP buffers used space, hit ratio, directory used, swap rate and quality. Hit ratio, swap rate and buffer quality metrics can be computed since the startup of the instance, or within a period of time. 
=== Configuration hints ===

Use the surveillance table to define the buffers monitoring settings: Buffer name, thresholds, severity, filters, etc... Note: Once you defined a surveillance line for a specific buffer name, other lines using "*" as buffer name filter will not match the specified buffer name.
Multiple severity syntax: All thresholds can be defined by using the multiple severity syntax: 
  * G2W:50 W2C:90  => Warning above 50, Critical above 90

If the period field is set with a value above 0, hit ratio, swap rate and buffer quality will be computed within the specified period instead of since the startup of the instance
=== Atomic fields ===
^Low footprint (if false the swap/quality and min request rates will be computed)|With this option selected, the probe will use a low footprint API to get SAP buffers information from SAP. The drawback is that it won't be possible to compute the swap/quality rate and the number of requests.|

=== 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.|
^Buffer name|The name of the buffer to look for, or * for any buffer.|
^Max used space (%)|The threshold for the current used space of a given buffer (percent).|
^Min hit ratio (%)|The threshold for the minimum hit ratio for a given buffer. Computed from instance startup or within a period.|
^Max dir used (%)|The threshold for the maximum swap rate of a given buffer. Computed from instance startup or within a period.|
^Max swap (%)|The threshold for the minimum quality rate of a given buffer. Computed from instance startup or within a period.|
^Min quality (%)|The threshold for the maximum directory usage of a given buffer. Computed from instance startup or within a period.|
^Period (min)|If a value greater than 0 is set, it will define the period for the computation of hit ratio, swap and quality rate metrics. Computed since startup otherwise.|
^Min requests|Define a minimum of requests to consider the computed metrics as relevant. Below this value, no alarms will be sent. |
^Severity|The default level of severity of the alarm generated by this line of surveillance. Applies when multiple severity syntax is not used|
^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.|
^Report|If checked, this line of surveillance will used for showing threshold and severity in the daily report|
=== Examples ===
 
^Active^Instance^Buffer name^Max used space (%)^Min hit ratio (%)^Max dir used (%)^Max swap (%)^Min quality (%)^Period (min)^Min requests^Severity^Auto clear^Alarm tag^Alarm^Metric^Report^
|true|*|*|80%|90%|0|0|0|0|200|MAJOR|true| |true|false|false|

**Effect** : Sends a MAJOR alarm if any buffer use more than 80% of its space of if the hit ratio is below 90%.
=== Examples ===
 
^Active^Instance^Buffer name^Max used space (%)^Min hit ratio (%)^Max dir used (%)^Max swap (%)^Min quality (%)^Period (min)^Min requests^Severity^Auto clear^Alarm tag^Alarm^Metric^Report^
|true|*|Program|0|90%|0|10%|0|30|200|MAJOR|true| |true|false|false|

**Effect** : Sends a MAJOR alarm if the Program buffer hit ratio of the last 30 min is below 90%, and if the swap rate of the period is over 10%
=== Generated metrics ===
 
^metricId^metricUnit^metricTarget^metricDescription^
|BUFFER_PERCENTAGE USED|Percent|[INSTANCE][BUFFER]|The usage ratio of the buffer|
|BUFFER_USED_SPACE|Kilobytes|[INSTANCE][BUFFER]|The space used in the buffer|
|BUFFER_DIRECTORY_USED|Percent|[INSTANCE][BUFFER]|The directory used space of the buffer|
|BUFFER_HIT_RATIO|Percent|[INSTANCE][BUFFER]|The buffer hit ratio|
|BUFFER_SWAP_RATE|Percent|[INSTANCE][BUFFER]|The buffer swap rate|
|BUFFER_QUALITY|Percent|[INSTANCE][BUFFER]|The buffer quality rate|