====== Sybase database size ======

===== Purpose =====
  Disk space is a critical resource for any database, to persist database and log data.
  This monitor is meant to detect situations where allocated disk space is running low.
===== Configuration hints =====

**Surveillance table:**
  * This is a table of rules that you can use to configure and customize the configuration.
  * Each line of the table will define a rule of monitoring.
  * You can combine multiple rules to cover different cases.
  * Within a rule, you can configure a maximum **data** and **log** used space.

** Maximum data and log used space: ** 
  * Use the [[..:commonsettings#multi_thresholds_syntax|multi-threshold]] syntax to set multiple threshold/severity associations: G2W:80 W2M:85 (Green To Warning, Warning To Major, etc...).  
  * An alarm of the corresponding severity will be sent if the used space is reaching a threshold.  
  * Set 0 in the field if unused 
  * You can set a DB specific rule by using the DB name filter. Use * to match any DB name, or regular expression.

**Rules order:** 
  * Rules are processed following their order in the table. 
  * One given DB **can only be processed once**, it will be ignored by subsequent rules. 
  * Therefore you **MUST** define specific rules (for a given DB) **before** general ones (for all).
===== Surveillance table =====

^Parameter^Description^
^Active|If checked, the rule is enabled and will be processed|
^DB name|A filter to match only a specific DB name, can use regular expression, white or black list|
^Max DATA used space (%)|The threshold for the DATA usage on disk. You can use the multi threshold syntax (Like G2W:80 W2C:90)|
^Max LOG used space (%)|The threshold for the LOG usage on disk. You can use the multi threshold syntax (Like G2W:80 W2C:90)|
^Severity|The default severity used if multi threshold syntax is not used.|
^Auto clear|If set, clears the alarms that are no longer generated.|
^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|Defines if the alerting is active for this rule.|
^Metric|Defines if the metric generation is active for this rule.|
^Report|If checked, this rule will be used for showing threshold and severity in the daily report|
===== Examples =====
 
^Active^DB name^Max DATA used space (%)^Max LOG used space (%)^Severity^Auto clear^Prefix^Alarm^Metric^Report^
|true|*|85|90|MAJOR|true| |true|true|false|

**Effect** : A MAJOR alarm will be sent if DATA space is used at 85% of more (and 90% for LOG space), for any database.
===== Examples =====
 
^Active^DB name^Max DATA used space (%)^Max LOG used space (%)^Severity^Auto clear^Prefix^Alarm^Metric^Report^
|true|master|0|G2W:90 W2C:95|MAJOR|true| |true|true|false|

**Effect** : A WARNING alarm will be sent if LOG space of master DB is used at 90% or more (CRITICAL if 95%)
===== Generated metrics =====
 
^metricId^metricUnit^metricTarget^metricDescription^
|DATABASE_LOG_PERCENTAGE_USED_SPACE|%|[DB NAME]|The LOG percentage usage of a given DB|
|DATABASE_DATA_PERCENTAGE_USED_SPACE|%|[DB NAME]|The DATA percentage usage of a given DB|
|DATABASE_LOG_USED_SPACE|GB|[DB NAME]|The LOG usage of the DB|
|DATABASE_DATA_USED_SPACE|GB|[DB_NAME]|The DATA usage of the DB|
|DATABASE_TOTAL_LOG_SPACE|MB|[DB NAME]|The total LOG space of the given DB|
|DATABASE_TOTAL_DATA_SPACE|GB|[DB NAME]|The total DATA space of the given DB|