Gauge for non-numeric, string-based performance indicators. This is analogous to a traffic light, having an enumerable set of values red, yellow, and green.
Unlike numeric gauges that convey the severity of a scalar value, Indicator Gauges convey the status of data for which the threshold values can be enumerated and expressed as a series of text string patterns. For example, backend server availability may be defined in a monitor entry attribute as a set of enumerated values like AVAILABLE, DEGRADED, UNAVAILABLE. An Indicator Gauge may be configured to raise alarms based on these values.
↓Parent Component
↓Relations from This Component
↓Properties
↓dsconfig Usage
The Indicator Gauge component inherits from the Gauge
The following components have a direct aggregation relation from Indicator Gauges:
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ description | ↓ include-resource |
| ↓ enabled | ↓ exclude-resource |
| ↓ override-severity | ↓ server-unavailable-severity-level |
| ↓ alert-level | ↓ server-degraded-severity-level |
| ↓ update-interval | ↓ major-value |
| ↓ samples-per-update-interval | ↓ minor-value |
| ↓ gauge-data-source | |
| ↓ critical-value | |
| ↓ warning-value |
| Description | A description for this Gauge |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Indicates whether this Gauge is enabled. Disabled Gauges will not be updated, their status will not appear in either the alarm or monitor backends, and changes to their severity will not generate alerts. |
| Default Value | true |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | When defined, causes this Gauge to assume the specified severity, overriding its computed severity. This is useful for testing alarms generated by Gauges as well as suppressing alarms for known conditions. |
| Default Value | Severity is not currently overridden. |
| Allowed Values | normal - The Gauge's severity is 'normal' warning - This Gauge's severity is 'warning'. minor - This Gauge's severity is 'minor'. major - This Gauge's severity is 'major.' critical - This Gauge's severity is 'critical'. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the level at which alerts are sent for alarms raised by this Gauge. Whenever an alarm's severity changes, one or more alerts may be issued. Alarms raised for levels below this setting will appear in the alarm backend but will not send alerts. This setting overrides the alarm manager's default-gauge-alert-level setting. |
| Default Value | None |
| Allowed Values | always - Alarms of any severity will generate alerts. warning-and-above - Warning, minor, major, and critical alarms will trigger alerts. minor-and-above - Minor, major, and critical alarms will trigger alerts. major-and-above - Major and critical alarms will trigger alerts. critical-only - Only critical alarms will trigger alerts. never - No alerts will be generated. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | The frequency with which this Gauge is updated. This interval specifies when this Gauge's monitor entries are updated as well as determining whether its status warrants raising alarms due to severity changes. Some data sources may use their minimum-update-interval property to impose a higher lower bound than what is permitted by this property's syntax. |
| Default Value | 10 seconds |
| Allowed Values | A duration. Lower limit is 10 milliseconds. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Indicates the number of times the monitor data source value will be collected during the update interval. For average, minimum, or maximum values that fluctuate more frequently than the update interval, it is important to collect enough samples over the update interval to obtain a representative value. Indicator gauges may use this property to ensure that all values taken over an update interval are consistent in order for an alarm to be raised. When a value is specified greater than 1, the sample value that indicates the least severe severity will be used to represent the gauge's severity at update time. |
| Default Value | 1 |
| Allowed Values | An integer value. Lower limit is 0. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the source of data to use in determining this Indicator Gauge's severity and status. |
| Default Value | None |
| Allowed Values | The DN of any Indicator Gauge Data Source. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | A regular expression pattern that is used to determine whether the current monitored value indicates this gauge's severity should be critical. At each evaluation interval, the monitored value is obtained from the monitor data source. If the value matches this pattern, this Indicator Gauge's severity is considered 'critical'. For simple strings, patterns that contain one of the following characters must be escaped using a backslash (): { } [ ] ( ) ^ $ . | * + ? . Otherwise the character is assumed to be a regular expression meta-character with special meaning. |
| Default Value | This gauge will not assume a severity of 'critical'. |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | A regular expression pattern that is used to determine whether the current monitored value indicates this gauge's severity will be 'warning'. At each evaluation interval, the monitored value is obtained from the monitor data source. If the value matches this pattern, and does not match a more critical pattern, the gauge is considered 'warning'. For simple strings, patterns that contain one of the following characters must be escaped using a backslash (): { } [ ] ( ) ^ $ . | * + ? . Otherwise the character is assumed to be a regular expression meta-character with special meaning. |
| Default Value | This gauge will not assume a severity of 'warning'. |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
include-resource (Advanced Property)
| Description | Specifies set of resources to be monitored. When present, only specific resources listed in this attribute will be monitored. If empty this Gauge will apply to all resources unless a resource is listed in the exclude-resource property. This property may be used, for example, to limit a Gauge to a particular disk device. This property has no effect on Gauges whose data sources represent a single resource. |
| Default Value | All resources are monitored except those that are explicitly excluded. |
| Allowed Values | A string |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
exclude-resource (Advanced Property)
| Description | Specifies resources to exclude from being monitored. When present, specific resources listed by this property will be excluded from being monitored. This property may be used, for example, to exclude a particular disk device from being monitored. This property has no effect on Gauges whose data sources represent a single resource. |
| Default Value | No resources are excluded from monitoring. |
| Allowed Values | A string |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
server-unavailable-severity-level (Advanced Property)
| Description | Specifies the alarm severity level at or above which the server is considered unavailable. This controls the alarm severity at or above which this Gauge should trigger the server to declare itself unavailable by exposing an unavailable alert type within the RootDSE. Clients can query for this to assess a server's self-declared health. |
| Default Value | none |
| Allowed Values | critical - Alarms with critical severity will cause the server to enter an unavailable state. major - Alarms with severity at or above major will cause the server to enter an unavailable state. minor - Alarms with severity at or above minor will cause the server to enter an unavailable state. warning - Alarms with severity at or above warning will cause the server to enter an unavailable state. none - Alarms will not cause the server to enter an unavailable state. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
server-degraded-severity-level (Advanced Property)
| Description | Specifies the alarm severity level at or above which the server is considered degraded. This controls the alarm severity at or above which this Gauge should trigger the server to declare itself degraded by exposing a degraded alert type within the RootDSE. Clients can query for this to assess a server's self-declared health. |
| Default Value | none |
| Allowed Values | critical - Alarms with critical severity will cause the server to enter a degraded state. major - Alarms with severity at or above major will cause the server to enter a degraded state. minor - Alarms with severity at or above minor will cause the server to enter a degraded state. warning - Alarms with severity at or above warning will cause the server to enter a degraded state. none - Alarms will not cause the server to enter a degraded state. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
major-value (Advanced Property)
| Description | A regular expression pattern that is used to determine whether the current monitored value indicates this gauge's severity will be 'major'. At each evaluation interval, the monitored value is obtained from the monitor data source. If the value matches this pattern, this Indicator Gauge's severity is considered 'major'. For simple strings, patterns that contain one of the following characters must be escaped using a backslash (): { } [ ] ( ) ^ $ . | * + ? . Otherwise the character is assumed to be a regular expression meta-character with special meaning. |
| Default Value | This gauge will not assume a severity of 'major'. |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
minor-value (Advanced Property)
| Description | A regular expression pattern that is used to determine whether the current monitored value indicates this gauge's severity will be 'minor'. At each evaluation interval, the monitored value is obtained from the monitor data source. If the value matches this pattern, this Indicator Gauge's severity is considered 'minor'. For simple strings, patterns that contain one of the following characters must be escaped using a backslash (): { } [ ] ( ) ^ $ . | * + ? . Otherwise the character is assumed to be a regular expression meta-character with special meaning. |
| Default Value | This gauge will not assume a severity of 'minor'. |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
To list the configured Gauges:
dsconfig list-gauges
[--property {propertyName}] ...
To view the configuration for an existing Gauge:
dsconfig get-gauge-prop
--gauge-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Gauge:
dsconfig set-gauge-prop
--gauge-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new Indicator Gauge:
dsconfig create-gauge
--gauge-name {name}
--type indicator
--set gauge-data-source:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Gauge:
dsconfig delete-gauge
--gauge-name {name}