Platform-Specific and Other Metrics

DRBD.ConnState(device)

Connection state of DRBD device.

Data Type

String

Platforms

Linux
Table 1. Arguments
Argument Type Description

device

Integer

DRBD device number (e.g., 0, 1)

DRBD.DataState(device)

Data synchronization state.

Data Type

String

Platforms

Linux
Table 2. Arguments
Argument Type Description

device

Integer

DRBD device number (e.g., 0, 1)

DRBD.DeviceState(device)

Operational state.

Data Type

String

Platforms

Linux
Table 3. Arguments
Argument Type Description

device

Integer

DRBD device number (e.g., 0, 1)

DRBD.PeerDataState(device)

Data state of peer device.

Data Type

String

Platforms

Linux
Table 4. Arguments
Argument Type Description

device

Integer

DRBD device number (e.g., 0, 1)

DRBD.PeerDeviceState(device)

State of peer device.

Data Type

String

Platforms

Linux
Table 5. Arguments
Argument Type Description

device

Integer

DRBD device number (e.g., 0, 1)

DRBD.Protocol(device)

Protocol type (A, B, or C).

Data Type

String

Platforms

Linux
Table 6. Arguments
Argument Type Description

device

Integer

DRBD device number (e.g., 0, 1)

DRBD.Version.API

DRBD API version.

Data Type

String

Platforms

Linux

DRBD.Version.Driver

DRBD driver version.

Data Type

String

Platforms

Linux

DRBD.Version.Protocol

DRBD protocol version.

Data Type

String

Platforms

Linux

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
Table 7. Arguments
Argument Type Description

counterPath

String

Counter path (starts with single backslash, no machine name prefix)

twoSamples

Integer

Optional. Set to 1 if two samples are required for calculation (e.g., CPU utilization counters)
Examples
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
Table 8. Arguments
Argument Type Description

vid

String

VID — Vendor ID in hexadecimal format (required)

pid

String

PID — Product ID in hexadecimal format (optional)
Examples
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).

Modbus metrics are available only in agent builds compiled with Modbus support.

Modbus.Coil(address)

Modbus coil value.

Data Type

Unsigned Integer

Platforms

All
Table 9. Arguments
Argument Type Description

address

String

Coil address

Modbus.ConnectionStatus(connection)

Modbus connection health.

Data Type

Integer

Platforms

All
Table 10. Arguments
Argument Type Description

connection

String

Connection name

Modbus.DiscreteInput(address)

Modbus discrete input value.

Data Type

Unsigned Integer

Platforms

All
Table 11. Arguments
Argument Type Description

address

String

Discrete input address

Modbus.HoldingRegister(address)

Modbus holding register value.

Data Type

Unsigned Integer

Platforms

All
Table 12. Arguments
Argument Type Description

address

String

Holding register address

Modbus.InputRegister(address)

Modbus input register value.

Data Type

Unsigned Integer

Platforms

All
Table 13. Arguments
Argument Type Description

address

String

Input register address

EtherNetIP.Attribute(host, port, path)

Value of EtherNet/IP CIP attribute. Requires EnableEtherNetIPProxy to be set in agent configuration.

Data Type

String

Platforms

All
Table 14. Arguments
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. The argument can be a file path to a PEM/DER certificate or a URL for remote certificate inspection.

X509.Certificate.ExpirationDate(path)

Certificate expiration date (YYYY-MM-DD).

Data Type

String

Platforms

All
Table 15. Arguments
Argument Type Description

path

String

Path to the certificate file or URL for remote inspection

X509.Certificate.ExpirationTime(path)

Certificate expiration UNIX timestamp.

Data Type

Unsigned Integer 64

Platforms

All
Table 16. Arguments
Argument Type Description

path

String

Path to the certificate file or URL for remote inspection

X509.Certificate.ExpiresIn(path)

Days until certificate expiration.

Data Type

Integer

Platforms

All
Table 17. Arguments
Argument Type Description

path

String

Path to the certificate file or URL for remote inspection

X509.Certificate.Issuer(path)

Certificate issuer name.

Data Type

String

Platforms

All
Table 18. Arguments
Argument Type Description

path

String

Path to the certificate file or URL for remote inspection

X509.Certificate.Subject(path)

Certificate subject name.

Data Type

String

Platforms

All
Table 19. Arguments
Argument Type Description

path

String

Path to the certificate file or URL for remote inspection
Examples
X509.Certificate.ExpiresIn(/etc/ssl/certs/server.pem)
X509.Certificate.Subject(https://example.com)

X509.Certificate.TemplateID(path)

Certificate template identifier.

Data Type

String

Platforms

All
Table 20. Arguments
Argument Type Description

path

String

Path to the certificate file or URL for remote inspection

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
Table 21. Arguments
Argument Type Description

store

String

Certificate store name (e.g., MY, Root)

certificate

String

Certificate selector: a thumbprint, or a value prefixed with name:, email:, subject:, template:, cn:, org:, or deviceSerial:
Table 22. Available Metrics
Metric Data Type Description

WindowsCertificateStore.Certificate.ExpirationDate(store, certificate)

String

Expiration date (YYYY-MM-DD)

WindowsCertificateStore.Certificate.ExpirationTime(store, certificate)

Unsigned Integer 64

Expiration UNIX timestamp

WindowsCertificateStore.Certificate.ExpiresIn(store, certificate)

Integer

Days until expiration

WindowsCertificateStore.Certificate.HasPrivateKey(store, certificate)

Integer

Private key presence (1=yes, 0=no)

WindowsCertificateStore.Certificate.Issuer(store, certificate)

String

Issuer name

WindowsCertificateStore.Certificate.Subject(store, certificate)

String

Subject name

WindowsCertificateStore.Certificate.TemplateID(store, certificate)

String

Certificate template identifier

WindowsCertificateStore.Certificate.Thumbprint(store, certificate)

String

SHA-1 thumbprint

VNC.LocalServerState(display)

VNC loopback accessibility.

Data Type

Integer

Platforms

All
Table 23. Arguments
Argument Type Description

display

Integer

Display number

VNC.ServerState(hostDisplay)

VNC remote accessibility.

Data Type

Integer

Platforms

All
Table 24. Arguments
Argument Type Description

hostDisplay

String

host:display

WindowsFirewall.CurrentProfile

Current firewall profile name.

Data Type

String

Platforms

Windows

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
Table 25. Variants
Metric Description

WindowsFirewall.State

Overall firewall status

WindowsFirewall.State(*)

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
Table 26. Variants
Metric Description

ACPI.ThermalZone.CurrentTemp

Temperature in the first ACPI thermal zone

ACPI.ThermalZone.CurrentTemp(*)

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
Table 27. Arguments
Argument Type Description

index

Integer

Adapter index
Table 28. Available Metrics
Metric Data Type Description

Hardware.NetworkAdapter.Availability(index)

Unsigned Integer

Adapter availability

Hardware.NetworkAdapter.Description(index)

String

Adapter description

Hardware.NetworkAdapter.InterfaceIndex(index)

Unsigned Integer

Network stack interface index

Hardware.NetworkAdapter.MACAddress(index)

String

MAC address

Hardware.NetworkAdapter.Manufacturer(index)

String

Manufacturer

Hardware.NetworkAdapter.Product(index)

String

Product name

Hardware.NetworkAdapter.Speed(index)

Unsigned Integer 64

Adapter speed

Hardware.NetworkAdapter.Type(index)

String

Adapter type

System.AntiSpywareProduct., System.AntiVirusProduct., System.FirewallProduct.*

Windows Security Center product status.

Platforms

Windows
Table 29. Available Metrics
Metric Data Type Description

System.AntiSpywareProduct.Active

Integer

Anti-spyware product active

System.AntiSpywareProduct.DisplayName

String

Anti-spyware product display name

System.AntiSpywareProduct.UpToDate

Integer

Anti-spyware product up to date

System.AntiVirusProduct.Active

Integer

Anti-virus product active

System.AntiVirusProduct.DisplayName

String

Anti-virus product display name

System.AntiVirusProduct.UpToDate

Integer

Anti-virus product up to date

System.FirewallProduct.Active

Integer

Firewall active

System.FirewallProduct.DisplayName

String

Firewall product display name

System.FirewallProduct.UpToDate

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
Table 30. Arguments
Argument Type Description

namespace

String

WMI namespace (e.g., root\cimv2)

query

String

WQL query

property

String

Property to return. Array properties can be indexed (e.g., PropertyName[0])

System.KStat(module, instance, name, statistic)

Kernel statistics value.

Data Type

String

Platforms

Solaris
Table 31. Arguments
Argument Type Description

module

String

Module name

instance

Integer

Instance number

name

String

Name

statistic

String

Statistic name
Example
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
Table 32. Arguments
Argument Type Description

volume

String

Logical volume name
Table 33. Available Metrics
Metric Data Type Description

LVM.LogicalVolume.Size(volume)

Unsigned Integer 64

Size of logical volume

LVM.LogicalVolume.Status(volume)

String

Status of logical volume

LVM.PhysicalVolume.metric(volume)

Physical volume information.

Platforms

AIX
Table 34. Arguments
Argument Type Description

volume

String

Physical volume name
Table 35. Available Metrics
Metric Data Type Description

LVM.PhysicalVolume.Free(volume)

Unsigned Integer 64

Free space on physical volume

LVM.PhysicalVolume.FreePerc(volume)

Float

Percentage of free space on physical volume

LVM.PhysicalVolume.ResyncPartitions(volume)

Unsigned Integer 64

Number of resynchronizing partitions on physical volume

LVM.PhysicalVolume.StalePartitions(volume)

Unsigned Integer 64

Number of stale partitions on physical volume

LVM.PhysicalVolume.Status(volume)

String

Status of physical volume

LVM.PhysicalVolume.Total(volume)

Unsigned Integer 64

Total size of physical volume

LVM.PhysicalVolume.Used(volume)

Unsigned Integer 64

Used space on physical volume

LVM.PhysicalVolume.UsedPerc(volume)

Float

Percentage of used space on physical volume

LVM.VolumeGroup.metric(group)

Volume group information.

Platforms

AIX
Table 36. Arguments
Argument Type Description

group

String

Volume group name
Table 37. Available Metrics
Metric Data Type Description

LVM.VolumeGroup.ActivePhysicalVolumes(group)

Unsigned Integer

Number of active physical volumes in volume group

LVM.VolumeGroup.Free(group)

Unsigned Integer 64

Free space in volume group

LVM.VolumeGroup.FreePerc(group)

Float

Percentage of free space in volume group

LVM.VolumeGroup.LogicalVolumes(group)

Unsigned Integer

Number of logical volumes in volume group

LVM.VolumeGroup.PhysicalVolumes(group)

Unsigned Integer

Number of physical volumes in volume group

LVM.VolumeGroup.ResyncPartitions(group)

Unsigned Integer 64

Number of resynchronizing partitions in volume group

LVM.VolumeGroup.StalePartitions(group)

Unsigned Integer 64

Number of stale partitions in volume group

LVM.VolumeGroup.Total(group)

Unsigned Integer 64

Total size of volume group

LVM.VolumeGroup.Used(group)

Unsigned Integer 64

Used space in volume group

LVM.VolumeGroup.UsedPerc(group)

Float

Percentage of used space in volume group

ExternalDataProvider.State(provider)

External data provider operational state.

Data Type

Integer

Platforms

All
Table 38. Arguments
Argument Type Description

provider

String

Provider name