Note: this is an abstract component that cannot be instantiated.
The Monitoring Threshold is used to configure a set of operational performance limits on a specific measurement.
↓Direct Subcomponents
↓Relations From this Component
↓Properties
↓dsconfig Usage
The following Monitoring Thresholds are available in the server :
These Monitoring Thresholds inherit from the properties described below.
The following components have a direct aggregation relation to Monitoring Thresholds:
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ threshold-name | None |
| ↓ description | |
| ↓ min-time-for-trigger | |
| ↓ min-time-for-exit | |
| ↓ per-sample-time-average | |
| ↓ alert-condition | |
| ↓ alert-on-warn | |
| ↓ current-value-requires | |
| ↓ threshold-aggregation |
| Description | Specifies the name of the Monitoring Threshold. Monitoring Threshold are referenced by LDAP SLA objects to provide performance goals for an application. When the application fails to meet the performance goals an alert will be issued indicating the problem. The name of a Monitoring Threshold should be descriptive enough that it is clear from the name what the limits are. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Description of the Monitoring Threshold. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Minimum amount of time a threshold must be exceeded before it enters an alerted state. A value of 1 second indicates that every transition across the specified performance limit should result in the threshold entering an alerted state. This should be used for measurements that have very little jitter, or when the limit is not close to the normal value. This value allows the threshold to alert only when the monitored value exceeds the limit for a period of time. The default value of 15 seconds allows short spikes to occur without triggering an alert. |
| Default Value | 15 seconds |
| Allowed Values | A duration. Lower limit is 1 seconds. Upper limit is 900 seconds. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Minimum amount of time a threshold must not be exceeded before it exits an alerted state. A value of 1 second indicates that every transition below the specified performance limit should result in the threshold leaving the alerted state. This should be used for measurements that have very little jitter, or when the limit is not close to the normal value. This value allows the threshold to clear exactly when the monitored value goes below the limit for the specified period of time. The default value of 15 seconds allows short dropouts to occur without clearing the current alert. |
| Default Value | 15 seconds |
| Allowed Values | A duration. Lower limit is 1 seconds. Upper limit is 900 seconds. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Controls the time resolution of the data used to compute the threshold. Some types of metrics have a lot of variation between consecutive samples. By increasing the per-sample-time-average the samples will be time-averaged, smoothing some of the variation and making it easier to select an appropriate threshold limit. For example, consider a sequence of sample values 1,5,2,3,1,7,2,3,6,3,1,8,3,1,2 The average of this sequence is 3.2, yet ~25% of the samples are above 5. If we change the per-sample-time-average from 1 to 3, we time-average every 3 samples and get the sequence 2.66,3.66,3.66,4,2 all of which are below 5. In this example, time-averaging the samples will smooth it enough that we can place a threshold closer to the average value without getting false triggers. |
| Default Value | 5 seconds |
| Allowed Values | A duration. Lower limit is 1 seconds. Upper limit is 20 seconds. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Indicates at what state the Monitoring Threshold will issue an alert. A Monitoring Threshold can issue an alert when it initially enters an alerted state, when it exits an alerted state, or at both entry and exit times. This setting controls when this Monitoring Threshold will issue an alert. |
| Default Value | entry |
| Allowed Values | entry - Issue an alert when the threshold enters an alerted state. exit - Issue an alert when the threshold exits an alerted state. |
| Multi-Valued | Yes |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Indicates whether the Monitoring Threshold will issue an alert when the threshold enters or leaves a warn state. Each Monitoring Threshold has two alerted states, warn and critical. When the Monitoring Threshold enters a critical alert state it will always issue an alert subject to the value of alert-condition property. If this property is true the Monitoring Threshold will issue alerts when entering/exiting the warning state based on the value of alert-condition property. |
| Default Value | true |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Query will return only servers of the specified types. Each Monitoring Threshold will return a set of servers that match this type constraint. |
| Default Value | all |
| Allowed Values | any - Current value is valid if at least one source has provided data. all - Current value is valid if all sources have provided data. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Method used to compute the threshold value from a set of discrete values. Each Monitoring Threshold may contain multiple streams of data that together constitute a logical value. This commonly occurs when data comes from multiple monitored servers. In this situation, the threshold must aggregate the streams in a way that is appropriate for the value. |
| Default Value | avg |
| Allowed Values | avg - value will be the average of the values in the different streams. min - value will be the minimum of the values in the different streams. max - value will be the maximum of the values in the different streams. sum - value will be the sum of the values in the different streams. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
To list the configured Monitoring Thresholds:
dsconfig list-monitoring-thresholds
[--property {propertyName}] ...
To view the configuration for an existing Monitoring Threshold:
dsconfig get-monitoring-threshold-prop
--threshold-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Monitoring Threshold:
dsconfig set-monitoring-threshold-prop
--threshold-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To delete an existing Monitoring Threshold:
dsconfig delete-monitoring-threshold
--threshold-name {name}