====== PI/XI consumer cache status ======
  The goal of this monitor is to detect when a consumer cache has an error status
===== Configuration hints =====
  * This monitor has to be assigned to a Web portal connector of the target SAP system.
  * Use user credentials having access to the PI/XI channels view.
  * With the surveillance table, you can define custom monitoring for a specific cache name or define a global policy applied to all.
  * You can adjust the alarm severity according to your needs.
===== Surveillance table =====
^Parameter^Description^
^Active|Use this field to activate or deactivate a line of configuration. |
^Consumer cache|A filter on the cache name. |
^Severity|he alarm severity to use when a cache is not in the right state.|
^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 used for showing threshold and severity in the daily report |
===== Examples =====
^Active^Consumer cache^Status^Max. messages^Severity^Auto clear^Alarm tag^Alarm^
|true|*|MAJOR|true| |true|false|false|

**Effect** : Sends a MAJOR alarm if any consumer cache is in ERROR state.
===== Generated metrics =====
^metricId^metricUnit^metricTarget^metricDescription^
|PIXI_CONSUMMER_CACHE_STATUS|Consummer cache status|CACHE|Sends TRUE if the cache has an OK status, FALSE instead.|