Note: this component is designated "advanced", which means that objects of this type are not expected to be created or altered in most environments. If you believe that such a change is necessary, you may want to contact support in order to understand the potential impact of that change.
Prometheus Monitor Attribute Metrics provide a way of publishing the value of a monitor attribute as a Prometheus metric.
↓Relations to This Component
↓Properties
↓dsconfig Usage
The following components have a direct composition relation to Prometheus Monitor Attribute Metrics:
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ metric-name | None |
| ↓ monitor-attribute-name | |
| ↓ monitor-object-class-name | |
| ↓ metric-type | |
| ↓ filter | |
| ↓ metric-description | |
| ↓ label-name-value-pair |
| Description | The name that will be used in the metric to be consumed by Prometheus. |
| Default Value | None |
| Allowed Values | The metric name must start with a letter or underscore, and it must only contain letters, digits, and underscores. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
monitor-attribute-name (Read-Only)
| Description | The name of the monitor attribute that contains the numeric value to be published. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
monitor-object-class-name (Read-Only)
| Description | The name of the object class for monitor entries that contain the monitor attribute. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | The metric type that should be used for the value of the specified monitor attribute. |
| Default Value | None |
| Allowed Values | counter - The value should be treated as a counter whose value increases over time as associated events occurs. gauge - The value should be treated as a gauge whose value may go up or down over time to reflect a point-in-time value. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | A filter that may be used to restrict the set of monitor entries for which the metric should be generated. |
| 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 | A human-readable description that should be published as part of the metric definition. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | A set of name-value pairs for labels that should be included in the published metric for the target attribute. Each value should be presented in the form "name=value", with an equal sign used to separate the name and the value. |
| Default Value | None |
| Allowed Values | Each value must be a label name followed by an equal sign and the label value. The label name must start with a letter or underscore, and it must only contain letters, digits, and underscores. The label value can be any non-empty string. |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
To list the configured Prometheus Monitor Attribute Metrics:
dsconfig list-prometheus-monitor-attribute-metrics
[--property {propertyName}] ...
To view the configuration for an existing Prometheus Monitor Attribute Metric:
dsconfig get-prometheus-monitor-attribute-metric-prop
--metric-name {name}
--extension-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Prometheus Monitor Attribute Metric:
dsconfig set-prometheus-monitor-attribute-metric-prop
--metric-name {name}
--extension-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new Prometheus Monitor Attribute Metric:
dsconfig create-prometheus-monitor-attribute-metric
--metric-name {name}
--extension-name {name}
--set monitor-attribute-name:{propertyValue}
--set monitor-object-class-name:{propertyValue}
--set metric-type:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Prometheus Monitor Attribute Metric:
dsconfig delete-prometheus-monitor-attribute-metric
--metric-name {name}
--extension-name {name}