Platform-Specific and Other Metrics
DRBD.ConnState(device)
Connection state of DRBD device.
Data Type |
String |
Platforms |
Linux |
| Argument | Type | Description |
|---|---|---|
device |
Integer |
DRBD device number (e.g., |
DRBD.DataState(device)
Data synchronization state.
Data Type |
String |
Platforms |
Linux |
| Argument | Type | Description |
|---|---|---|
device |
Integer |
DRBD device number (e.g., |
DRBD.DeviceState(device)
Operational state.
Data Type |
String |
Platforms |
Linux |
| Argument | Type | Description |
|---|---|---|
device |
Integer |
DRBD device number (e.g., |
DRBD.PeerDataState(device)
Data state of peer device.
Data Type |
String |
Platforms |
Linux |
| Argument | Type | Description |
|---|---|---|
device |
Integer |
DRBD device number (e.g., |
DRBD.PeerDeviceState(device)
State of peer device.
Data Type |
String |
Platforms |
Linux |
| Argument | Type | Description |
|---|---|---|
device |
Integer |
DRBD device number (e.g., |
DRBD.Protocol(device)
Protocol type (A, B, or C).
Data Type |
String |
Platforms |
Linux |
| Argument | Type | Description |
|---|---|---|
device |
Integer |
DRBD device number (e.g., |
Hypervisor.Type
Hypervisor platform type (e.g., VMware, Hyper-V, KVM).
Data Type |
String |
Platforms |
Linux, Windows, FreeBSD, Solaris |
Hypervisor.Version
Hypervisor version.
Data Type |
String |
Platforms |
Linux, Windows, FreeBSD, Solaris |
Windows Performance Data Helper metrics. These metrics provide access to Windows Performance Counters through the PDH library. Requires the winperf subagent.
PDH.CounterValue(counterPath, twoSamples)
Windows Performance counter value.
Data Type |
Integer |
Platforms |
Windows |
| Argument | Type | Description |
|---|---|---|
counterPath |
String |
Counter path (starts with single backslash, no machine name prefix) |
twoSamples |
Integer |
Optional. Set to |
PDH.CounterValue(\System\Processes) PDH.CounterValue(\Processor(_Total)\% Processor Time,1)
PDH.Version
PDH library version (as returned by PdhGetDllVersion()).
Data Type |
Unsigned Integer |
Platforms |
Windows |
WinPerf.Features
Features supported by this WinPerf subagent version (bit mask).
Data Type |
Unsigned Integer |
Platforms |
Windows |
USB.ConnectedCount(vid, pid)
Number of connected USB devices matching VID/PID.
Data Type |
Integer |
Platforms |
Windows |
| Argument | Type | Description |
|---|---|---|
vid |
String |
VID — Vendor ID in hexadecimal format (required) |
pid |
String |
PID — Product ID in hexadecimal format (optional) |
USB.ConnectedCount(046D) USB.ConnectedCount(046D,C52B)
The first example counts all Logitech devices (VID 046D). The second counts only Logitech Unifying Receivers (VID 046D, PID C52B).
Framebuffer.Count
Number of framebuffer devices (/dev/fb0 to /dev/fb7) that the agent could read at startup and registered as screenshot sources.
Requires the fbdev subagent; see Framebuffer Screenshots.
Data Type |
Integer |
Platforms |
Linux |
Modbus metrics are available only in agent builds compiled with Modbus support.
Modbus.Coil(host, port, unitId, address)
Modbus coil value.
Data Type |
Unsigned Integer |
Platforms |
All |
| Argument | Type | Description |
|---|---|---|
host |
String |
Device hostname or IP address |
port |
Integer |
TCP port (default: 502; use an empty argument to select the default) |
unitId |
Integer |
Modbus unit ID, 1-255 (default: 1) |
address |
Integer |
Register or coil address (default: 0) |
Requires EnableModbusProxy = yes.
Modbus.ConnectionStatus(host[, port[, unitId]])
Modbus connection health.
Data Type |
Integer |
Platforms |
All |
| Argument | Type | Description |
|---|---|---|
host |
String |
Device hostname or IP address |
port |
Integer |
TCP port (default: 502; use an empty argument to select the default) |
unitId |
Integer |
Modbus unit ID, 1-255 (default: 1) |
Requires EnableModbusProxy = yes.
Modbus.DiscreteInput(host, port, unitId, address)
Modbus discrete input value.
Data Type |
Unsigned Integer |
Platforms |
All |
| Argument | Type | Description |
|---|---|---|
host |
String |
Device hostname or IP address |
port |
Integer |
TCP port (default: 502; use an empty argument to select the default) |
unitId |
Integer |
Modbus unit ID, 1-255 (default: 1) |
address |
Integer |
Register or coil address (default: 0) |
Requires EnableModbusProxy = yes.
Modbus.HoldingRegister(host, port, unitId, address[, conversion])
Modbus holding register value.
Data Type |
Unsigned Integer |
Platforms |
All |
| Argument | Type | Description |
|---|---|---|
host |
String |
Device hostname or IP address |
port |
Integer |
TCP port (default: 502; use an empty argument to select the default) |
unitId |
Integer |
Modbus unit ID, 1-255 (default: 1) |
address |
Integer |
Register or coil address (default: 0) |
conversion |
String |
Conversion suffix (default: uint16); see Modbus Monitoring |
Requires EnableModbusProxy = yes.
Modbus.InputRegister(host, port, unitId, address[, conversion])
Modbus input register value.
Data Type |
Unsigned Integer |
Platforms |
All |
| Argument | Type | Description |
|---|---|---|
host |
String |
Device hostname or IP address |
port |
Integer |
TCP port (default: 502; use an empty argument to select the default) |
unitId |
Integer |
Modbus unit ID, 1-255 (default: 1) |
address |
Integer |
Register or coil address (default: 0) |
conversion |
String |
Conversion suffix (default: uint16); see Modbus Monitoring |
Requires EnableModbusProxy = yes.
EtherNetIP.Attribute(host, port, path)
Value of EtherNet/IP CIP attribute.
Requires EnableEtherNetIPProxy to be set in agent configuration.
Data Type |
String |
Platforms |
All |
| Argument | Type | Description |
|---|---|---|
host |
String |
Device hostname or IP address |
port |
Integer |
TCP port (optional, default 44818) |
path |
String |
CIP symbolic path to the attribute |
X.509 certificate monitoring from local PEM, DER, or PKCS#12 files. An optional second argument supplies the PKCS#12 password.
For remote TLS-service certificates, use the TLS.Certificate metrics from the netsvc subagent.
X509.Certificate.ExpirationDate(path[, password])
Certificate expiration date (YYYY-MM-DD).
Data Type |
String |
Platforms |
All |
| Argument | Type | Description |
|---|---|---|
path |
String |
Local certificate file path |
password |
String |
Optional PKCS#12 password |
X509.Certificate.ExpirationTime(path[, password])
Certificate expiration UNIX timestamp.
Data Type |
Unsigned Integer 64 |
Platforms |
All |
| Argument | Type | Description |
|---|---|---|
path |
String |
Local certificate file path |
password |
String |
Optional PKCS#12 password |
X509.Certificate.ExpiresIn(path[, password])
Days until certificate expiration.
Data Type |
Integer |
Platforms |
All |
| Argument | Type | Description |
|---|---|---|
path |
String |
Local certificate file path |
password |
String |
Optional PKCS#12 password |
X509.Certificate.Issuer(path[, password])
Certificate issuer name.
Data Type |
String |
Platforms |
All |
| Argument | Type | Description |
|---|---|---|
path |
String |
Local certificate file path |
password |
String |
Optional PKCS#12 password |
X509.Certificate.Subject(path[, password])
Certificate subject name.
Data Type |
String |
Platforms |
All |
| Argument | Type | Description |
|---|---|---|
path |
String |
Local certificate file path |
password |
String |
Optional PKCS#12 password |
X509.Certificate.ExpiresIn(/etc/ssl/certs/server.pem) X509.Certificate.Subject(/etc/ssl/certs/server.pem)
X509.Certificate.TemplateID(path[, password])
Certificate template identifier.
Data Type |
String |
Platforms |
All |
| Argument | Type | Description |
|---|---|---|
path |
String |
Local certificate file path |
password |
String |
Optional PKCS#12 password |
WindowsCertificateStore.Certificate.metric(store, certificate)
Properties of a certificate in a Windows certificate store.
Use the WindowsCertificateStore.Certificates list or table to enumerate certificates in a store.
Platforms |
Windows |
| Argument | Type | Description |
|---|---|---|
store |
String |
Certificate store name (e.g., |
certificate |
String |
Certificate selector: a thumbprint, or a value prefixed with |
| Metric | Data Type | Description |
|---|---|---|
|
String |
Expiration date (YYYY-MM-DD) |
|
Unsigned Integer 64 |
Expiration UNIX timestamp |
|
Integer |
Days until expiration |
|
Integer |
Private key presence (1=yes, 0=no) |
|
String |
Issuer name |
|
String |
Subject name |
|
String |
Certificate template identifier |
|
String |
SHA-1 thumbprint |
VNC.LocalServerState(port)
VNC loopback accessibility.
Data Type |
Integer |
Platforms |
All |
| Argument | Type | Description |
|---|---|---|
port |
Integer |
TCP port (1-65535), e.g. 5900 |
VNC.ServerState(host, port)
VNC remote accessibility.
Data Type |
Integer |
Platforms |
All |
| Argument | Type | Description |
|---|---|---|
host |
String |
Hostname or IP address |
port |
Integer |
TCP port (1-65535), e.g. 5900 |
WindowsFirewall.State
Overall firewall status (1=enabled, 0=disabled). Can also be called with a profile name argument to get per-profile status.
Data Type |
Integer |
Platforms |
Windows |
| Metric | Description |
|---|---|
|
Overall firewall status |
|
Firewall status for specific profile. Argument: profile name |
The following metrics are provided by the wmi subagent.
ACPI.ThermalZone.CurrentTemp
Current temperature in ACPI thermal zone.
Without arguments, reports the first thermal zone; with a zone argument, reports the given zone.
Use the ACPI.ThermalZones list to enumerate available zones.
Data Type |
Integer |
Platforms |
Windows |
| Metric | Description |
|---|---|
|
Temperature in the first ACPI thermal zone |
|
Temperature in specific thermal zone. Argument: zone name |
Hardware.NetworkAdapter.property(index)
Network adapter hardware properties from WMI.
Use the Hardware.NetworkAdapters list or table to enumerate adapters.
Platforms |
Windows |
| Argument | Type | Description |
|---|---|---|
index |
Integer |
Adapter index |
| Metric | Data Type | Description |
|---|---|---|
|
Unsigned Integer |
Adapter availability |
|
String |
Adapter description |
|
Unsigned Integer |
Network stack interface index |
|
String |
MAC address |
|
String |
Manufacturer |
|
String |
Product name |
|
Unsigned Integer 64 |
Adapter speed |
|
String |
Adapter type |
System.AntiSpywareProduct., System.AntiVirusProduct., System.FirewallProduct.*
Windows Security Center product status.
Platforms |
Windows |
| Metric | Data Type | Description |
|---|---|---|
|
Integer |
Anti-spyware product active |
|
String |
Anti-spyware product display name |
|
Integer |
Anti-spyware product up to date |
|
Integer |
Anti-virus product active |
|
String |
Anti-virus product display name |
|
Integer |
Anti-virus product up to date |
|
Integer |
Firewall active |
|
String |
Firewall product display name |
|
Integer |
Firewall product up to date |
WMI.Query(namespace, query, property)
Generic WMI query. Returns the given property from the first object matched by the query.
Data Type |
String |
Platforms |
Windows |
| Argument | Type | Description |
|---|---|---|
namespace |
String |
WMI namespace (e.g., |
query |
String |
WQL query |
property |
String |
Property to return. Array properties can be indexed (e.g., |
System.KStat(module, instance, name, statistic)
Kernel statistics value.
Data Type |
String |
Platforms |
Solaris |
| Argument | Type | Description |
|---|---|---|
module |
String |
Module name |
instance |
Integer |
Instance number |
name |
String |
Name |
statistic |
String |
Statistic name |
System.KStat(unix,0,system_misc,boot_time)
AIX Logical Volume Manager metrics.
Use the LVM.LogicalVolumes, LVM.PhysicalVolumes, and LVM.VolumeGroups lists to enumerate available instances.
LVM.LogicalVolume.metric(volume)
Logical volume information.
Platforms |
AIX |
| Argument | Type | Description |
|---|---|---|
volume |
String |
Logical volume name |
| Metric | Data Type | Description |
|---|---|---|
|
Unsigned Integer 64 |
Size of logical volume |
|
String |
Status of logical volume |
LVM.PhysicalVolume.metric(volume)
Physical volume information.
Platforms |
AIX |
| Argument | Type | Description |
|---|---|---|
volume |
String |
Physical volume name |
| Metric | Data Type | Description |
|---|---|---|
|
Unsigned Integer 64 |
Free space on physical volume |
|
Float |
Percentage of free space on physical volume |
|
Unsigned Integer 64 |
Number of resynchronizing partitions on physical volume |
|
Unsigned Integer 64 |
Number of stale partitions on physical volume |
|
String |
Status of physical volume |
|
Unsigned Integer 64 |
Total size of physical volume |
|
Unsigned Integer 64 |
Used space on physical volume |
|
Float |
Percentage of used space on physical volume |
LVM.VolumeGroup.metric(group)
Volume group information.
Platforms |
AIX |
| Argument | Type | Description |
|---|---|---|
group |
String |
Volume group name |
| Metric | Data Type | Description |
|---|---|---|
|
Unsigned Integer |
Number of active physical volumes in volume group |
|
Unsigned Integer 64 |
Free space in volume group |
|
Float |
Percentage of free space in volume group |
|
Unsigned Integer |
Number of logical volumes in volume group |
|
Unsigned Integer |
Number of physical volumes in volume group |
|
Unsigned Integer 64 |
Number of resynchronizing partitions in volume group |
|
Unsigned Integer 64 |
Number of stale partitions in volume group |
|
Unsigned Integer 64 |
Total size of volume group |
|
Unsigned Integer 64 |
Used space in volume group |
|
Float |
Percentage of used space in volume group |