Metrics Engine Documentation Index
Configuration Reference Home

Host System Monitor Provider

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.

Host System Monitor Providers can be used to provide monitoring information about host system cpu, memory utilization, disk devices and network interface utilization. Enabling host system cpu, memory, disk and network interface I/O monitoring requires running an external collector helper process except on Linux systems.
Host system monitoring is not available on Windows systems.

Parent Component
Properties
dsconfig Usage

Parent Component

The Host System Monitor Provider component inherits from the Monitor Provider

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description ↓ disk-devices
↓ enabled ↓ network-devices
↓ system-utilization-monitor-log-directory

Basic Properties

description

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

enabled

Description
Indicates whether the Host System Monitor Provider is enabled for use.
Default Value
false
Allowed Values
true
false
Multi-Valued
No
Required
Yes
Admin Action Required
Enabling host system cpu, memory, disk and network interface I/O monitoring requires running an external collector helper process except on Linux systems. Notes: - Enabling the host system monitor does not require restarting the server on Linux systems. - Enabling the host system monitor provider on UNIX (non-Linux) requires restarting the server. Changes to disk-devices and network-devices cannot be validated until the server is restarted. - Host system monitoring is not available on Windows systems.

system-utilization-monitor-log-directory

Description
Specifies a relative or absolute path to the directory on the local filesystem containing the log files used by the system utilization monitor. The path must exist, and it must be a writable directory by the server process.
Default Value
logs
Allowed Values
Unknown
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action


Advanced Properties

disk-devices (Advanced Property)

Description
Specifies which disk devices to monitor for I/O activity. Should be the device name as displayed by iostat -d.
Default Value
None
Allowed Values
Any valid disk device name - e.g. sda, sd1.
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action

network-devices (Advanced Property)

Description
Specifies which network interfaces to monitor for I/O activity. Should be the device name as displayed by netstat -i.
Default Value
None
Allowed Values
Any valid network device name - e.g. eth0, en0, lo.
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action


dsconfig Usage

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 Host System Monitor Provider:

dsconfig create-monitor-provider
     --provider-name {name}
     --type host-system
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Monitor Provider:

dsconfig delete-monitor-provider
     --provider-name {name}