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 UnboundID support in order to understand the potential impact of that change.
The Disk Space Usage Monitor Provider may be used to monitor the amount of usable disk space available for Metrics Engine components. It also provides the ability to generate administrative alerts and/or take additional action if the amount of usable space drops below defined thresholds.
There are three thresholds that may be defined for this monitor: a low space warning threshold, a low space error threshold, and an out of space error threshold. As long as the amount of usable disk space is above the low space warning threshold, no action will be taken. If the amount of usable space drops below the low space warning threshold, then the Metrics Engine will begin generating administrative alerts warning about low disk space. If the amount of usable space drops below the low space error threshold, then the Metrics Engine will continue generating administrative alerts but will also begin rejecting all operations requested by non-root users. If the amount of usable space drops below the out of space error threshold, then the Metrics Engine will send one final alert notification and will shut itself down in an attempt to avoid problems that may occur due to completely running out of space (e.g., inability to continue logging or update the database).
The threshold values may be specified either as absolute sizes or as percentages of the total available space. Either all values must be specified either as absolute values or all values must be specified as percentages; a mix of absolute values and percentages cannot be used. The low space warning threshold must be greater than or equal to the low space error threshold, the low space error threshold must be greater than or equal to the out of space error threshold, and the out of space error threshold must be greater than or equal to zero.
↓Parent Component
↓Properties
↓dsconfig Usage
The Disk Space Usage Monitor Provider component inherits from the Monitor Provider
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ description | None |
| ↓ enabled | |
| ↓ low-space-warning-size-threshold | |
| ↓ low-space-warning-percent-threshold | |
| ↓ low-space-error-size-threshold | |
| ↓ low-space-error-percent-threshold | |
| ↓ out-of-space-error-size-threshold | |
| ↓ out-of-space-error-percent-threshold | |
| ↓ alert-frequency |
| Description | A description for this Monitor Provider |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Indicates whether the Monitor Provider is enabled for use. |
| Default Value | None |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
low-space-warning-size-threshold
| Description | Specifies the low space warning threshold value as an absolute amount of space. If the amount of usable disk space drops below this amount, then the Metrics Engine will begin generating warning alert notifications. |
| Default Value | None |
| Allowed Values | A positive integer representing a size. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
low-space-warning-percent-threshold
| Description | Specifies the low space warning threshold value as a percentage of total space. If the amount of usable disk space drops below this amount, then the Metrics Engine will begin generating warning alert notifications. |
| Default Value | None |
| Allowed Values | An integer value. Lower limit is 0. Upper limit is 100 . |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
low-space-error-size-threshold
| Description | Specifies the low space error threshold value as an absolute amount of space. If the amount of usable disk space drops below this amount, then the Metrics Engine will start rejecting operations requested by non-root users. |
| Default Value | None |
| Allowed Values | A positive integer representing a size. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
low-space-error-percent-threshold
| Description | Specifies the low space error threshold value as a percentage of total space. If the amount of usable disk space drops below this amount, then the Metrics Engine will start rejecting operations requested by non-root users. |
| Default Value | None |
| Allowed Values | An integer value. Lower limit is 0. Upper limit is 100 . |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
out-of-space-error-size-threshold
| Description | Specifies the out of space error threshold value as an absolute amount of space. If the amount of usable disk space drops below this amount, then the Metrics Engine will shut itself down to avoid problems that may occur from complete exhaustion of usable space. |
| Default Value | None |
| Allowed Values | A positive integer representing a size. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
out-of-space-error-percent-threshold
| Description | Specifies the out of space error threshold value as a percentage of total space. If the amount of usable disk space drops below this amount, then the Metrics Engine will shut itself down to avoid problems that may occur from complete exhaustion of usable space. |
| Default Value | None |
| Allowed Values | An integer value. Lower limit is 0. Upper limit is 100 . |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the length of time between administrative alerts generated in response to lack of usable disk space. Administrative alerts will be generated whenever the amount of usable space drops below any threshold, and they will also be generated at regular intervals as long as the amount of usable space remains below the threshold value. A value of zero indicates that alerts should only be generated when the amount of usable space drops below a configured threshold. |
| Default Value | 60 minutes |
| Allowed Values | A duration. Lower limit is 1 seconds. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
To list the configured Monitor Providers:
dsconfig list-monitor-providers
[--property {propertyName}] ...
To view the configuration for an existing Monitor Provider:
dsconfig get-monitor-provider-prop
--provider-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Monitor Provider:
dsconfig set-monitor-provider-prop
--provider-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new Disk Space Usage Monitor Provider:
dsconfig create-monitor-provider
--provider-name {name}
--type disk-space-usage
--set enabled:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Monitor Provider:
dsconfig delete-monitor-provider
--provider-name {name}