A Numeric Gauge Data Source defines the source of numeric-based gauge data obtained from the monitor backend.
↓Parent Component
↓Relations to This Component
↓Properties
↓dsconfig Usage
The Numeric Gauge Data Source component inherits from the Gauge Data Source
The following components have a direct aggregation relation to Numeric Gauge Data Sources:
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ description | ↓ divide-value-by |
| ↓ additional-text | ↓ divide-value-by-attribute |
| ↓ monitor-objectclass | ↓ divide-value-by-counter-attribute |
| ↓ monitor-attribute | |
| ↓ include-filter | |
| ↓ resource-attribute | |
| ↓ resource-type | |
| ↓ minimum-update-interval | |
| ↓ data-orientation | |
| ↓ statistic-type |
| Description | A description for this Gauge Data Source |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Additional information about the source of this data that is added to alerts sent as a result of gauges that use this Gauge Data Source. Information may include tips related to diagnosing alarms, caveats related to particular platforms or environments, and additional instructions useful for configuring gauges to use this Gauge Data Source. The string may either be plain text or, to facilitate internationalization of text that appear in alarm and alert notification messages, a reference to a resource message declaration class and message descriptor, formatted as ${message.class.name:MESSAGE_DESCRIPTOR}. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | The object class name of the monitor entries to examine for generating gauge data. |
| Default Value | None |
| Allowed Values | The object class name of the monitor entries to examine for generating gauge data. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the attribute on the monitor entries from which to derive the current gauge value. This attribute must appear in the entry specified by the object class. |
| Default Value | None |
| Allowed Values | An attribute of the specified monitor entry object class. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | An optional LDAP filter that can be used restrict which monitor entries are used to compute output. If an LDAP filter is specified, only monitor entries that match the filter, in addition to including the object class specified by the monitor-objectclass property, will be included in the gauge data. |
| Default Value | None |
| Allowed Values | A valid LDAP search filter |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the attribute whose value is used to identify the specific resource being monitored (e.g. device name). Gauges that represent data for multiple resources will provide monitor data in multiple monitor entries. This property specifies the attribute that is used to specifically identify the resource that is being monitored. A gauge that conveys information about disk devices for example would specify the attribute that contains the name of the devices in monitor entries. When SNMP alerts are used to convey alarm status, this information will appear as part of the 'Specific Problems' field. |
| Default Value | cn |
| Allowed Values | An attribute of the specified monitor entry object class. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | A string indicating the type of resource being monitored. The string should describe the type of object referred to by the resource attribute, and is intended to add clarity to resource name. For example a gauge for measuring the number of entries for each backend should have a label 'Backend'. If not defined, the resource will be generically be referred to as 'Resource'. The string may either be plain text or, to facilitate internationalization of text that appears in alarm and alert notification messages, a reference to a resource message declaration class and message descriptor, formatted as ${message.class.name:MESSAGE_DESCRIPTOR}. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
minimum-update-interval (Read-Only)
| Description | The minimum frequency with which gauges using this Gauge Data Source can be configured for update. In order to prevent undesirable side effects, some Gauge Data Sources may use this property to impose a higher bound on the update frequency of gauges. |
| Default Value | 10 ms |
| 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 whether a higher or lower value is a more severe condition. |
| Default Value | lower-is-better |
| Allowed Values | lower-is-better - Indicates that lower values correspond to lower severity. For example, in general lower response times numbers are better than higher ones. higher-is-better - Indicates that higher values correspond to lower severity. For example, in general more disk space being available is better than less. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the type of statistic to include in the output for the monitored attribute. The statistic indicates the type of data the monitor value represents and how it is to be processed during sub-sampling intervals. Minimum, maximum, and average statistics may be computed from multiple sub-samples during an update interval. |
| Default Value | average |
| Allowed Values | count-per-second - The monitored attribute is a counter value. The difference between the count value in successive measurements, divided by the time difference between measurements is used to provide the rate value. average - Multiple samples of the monitored attribute value are taken during the interval, and the average value of the measurements is output. minimum - Multiple samples of the monitored attribute value are taken during the interval, and the minimum value of the measurements is output. maximum - Multiple samples of the monitored attribute value are taken during the interval, and the maximum value of the measurements is output. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
divide-value-by (Advanced Property)
| Description | An optional floating point value that can be used to scale the resulting value. This is used to scale the resulting value by a fixed amount. This is typically used to reduce large values to a more manageable length. For example, free disk space could be represented in GB instead of just bytes. If a value for this property is specified, then it will be applied to the monitored attribute after any regular expression replacement is done and before it is scaled by the divide-value-by-attribute. |
| Default Value | None |
| Allowed Values | A real number value. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
divide-value-by-attribute (Advanced Property)
| Description | An optional property that can scale the resulting value by another attribute in the monitored entry. This is used to scale the resulting value by another attribute that is part of the same monitored entry. One example use case of this is to calculate the percentage busy of the server worker threads by dividing the number of busy threads by the total number of threads. If a value for this property is specified, then it will be applied after the value is scaled by divide-value-by if that property is specified. |
| Default Value | None |
| Allowed Values | The name of the attribute to divide by. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
divide-value-by-counter-attribute (Advanced Property)
| Description | An optional property that can scale the resulting value by another attribute whose value represents a counter in the monitored entry. This is used to scale the resulting value by another attribute that is part of the same monitored entry. One example use case of this is to calculate time spent processing total operations which is an interval of time divided by the difference in number of operations processed over that same interval. This property differs from the divide-value-by-attribute property in that the division of the final value takes place after the difference between this attribute's first sample value and the update sample value specified by the attribute has been determined. |
| Default Value | None |
| Allowed Values | The name of the attribute to divide by. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
To list the configured Gauge Data Sources:
dsconfig list-gauge-data-sources
[--property {propertyName}] ...
To view the configuration for an existing Gauge Data Source:
dsconfig get-gauge-data-source-prop
--source-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Gauge Data Source:
dsconfig set-gauge-data-source-prop
--source-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new Numeric Gauge Data Source:
dsconfig create-gauge-data-source
--source-name {name}
--type numeric
--set monitor-objectclass:{propertyValue}
--set monitor-attribute:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Gauge Data Source:
dsconfig delete-gauge-data-source
--source-name {name}