System Metrics

System.Architecture

System architecture identifier.

Data Type

String

Platforms

Windows

System.AppAddressSpace

Application address space size (MB).

Data Type

Unsigned Integer

Platforms

Windows

System.ConnectedUsers

Number of currently logged-in users.

Data Type

Integer

Platforms

Linux, Windows

System.CurrentDate

Current date string.

Data Type

String

Platforms

All

System.CurrentTime

Current system time (UNIX timestamp).

Data Type

Integer 64

Platforms

All

System.CurrentTime.ISO8601.Local

Current time in ISO 8601 format, local timezone.

Data Type

String

Platforms

All

System.CurrentTime.ISO8601.UTC

Current time in ISO 8601 format, UTC.

Data Type

String

Platforms

All

System.FQDN

Fully qualified domain name.

Data Type

String

Platforms

All

System.HandleCount

System-wide handle/file descriptor count.

Data Type

Integer

Platforms

Linux, Windows, Solaris, AIX

System.HardwareId

Hardware identifier.

Data Type

String

Platforms

All

System.Hostname

System hostname.

Data Type

String

Platforms

All

System.IsRestartPending

Reboot required indicator (1=yes, 0=no).

Data Type

Integer

Platforms

Windows

System.IsVirtual

Running in virtual machine (1=yes, 0=no).

Data Type

Integer

Platforms

Linux, Windows, FreeBSD, Solaris

System.PlatformName

Platform identifier (e.g., linux-x86_64).

Data Type

String

Platforms

All

System.ProcessCount

Total number of running processes.

Data Type

Unsigned Integer (Integer on Solaris and AIX)

Platforms

All

System.ThreadCount

Total number of running threads.

Data Type

Unsigned Integer (Integer on AIX)

Platforms

Linux, Windows, macOS, FreeBSD, NetBSD, AIX

System.TimeZone

Timezone name.

Data Type

String

Platforms

All

System.TimeZoneOffset

UTC offset string.

Data Type

String

Platforms

All

System.Uname

Full system identification string.

Data Type

String

Platforms

All

System.Uptime

System uptime in seconds.

Data Type

Unsigned Integer

Platforms

All

System.BIOS.Date

BIOS release date.

Data Type

String

Platforms

Linux, Windows, FreeBSD, Solaris

System.BIOS.Vendor

BIOS manufacturer.

Data Type

String

Platforms

Linux, Windows, FreeBSD, Solaris

System.BIOS.Version

BIOS version.

Data Type

String

Platforms

Linux, Windows, FreeBSD, Solaris

System.OS.Build

Operating system build number.

Data Type

String

Platforms

Linux, Windows, FreeBSD

System.OS.LicenseKey

Operating system license key.

Data Type

String

Platforms

Windows

System.OS.ProductId

Operating system product identifier.

Data Type

String

Platforms

Windows

System.OS.ProductName

Operating system product name.

Data Type

String

Platforms

Linux, Windows, FreeBSD, Solaris, AIX

System.OS.ProductType

Operating system type (workstation/server).

Data Type

String

Platforms

Linux, Windows, FreeBSD

System.OS.ServicePack

Service pack or update level.

Data Type

String

Platforms

Windows, AIX

System.OS.Version

Operating system version string.

Data Type

String

Platforms

Linux, Windows, FreeBSD, Solaris, AIX

System.OSPlatformName

Operating system platform name. Used by the server to match packages to nodes during package deployment.

Data Type

String

Platforms

All

System.MsgQueue.Bytes(id)

Queue byte usage.

Data Type

Unsigned Integer 64

Platforms

Linux, Solaris, AIX
Table 1. Arguments
Argument Type Description

id

String

Queue ID

System.MsgQueue.BytesMax(id)

Queue byte limit.

Data Type

Unsigned Integer 64

Platforms

Linux, Solaris, AIX
Table 2. Arguments
Argument Type Description

id

String

Queue ID

System.MsgQueue.ChangeTime(id)

Last change timestamp.

Data Type

Unsigned Integer 64

Platforms

Linux, Solaris, AIX
Table 3. Arguments
Argument Type Description

id

String

Queue ID

System.MsgQueue.Messages(id)

Number of messages in queue.

Data Type

Unsigned Integer

Platforms

Linux, Solaris, AIX
Table 4. Arguments
Argument Type Description

id

String

Queue ID

System.MsgQueue.RecvTime(id)

Last receive timestamp.

Data Type

Unsigned Integer 64

Platforms

Linux, Solaris, AIX
Table 5. Arguments
Argument Type Description

id

String

Queue ID

System.MsgQueue.SendTime(id)

Last send timestamp.

Data Type

Unsigned Integer 64

Platforms

Linux, Solaris, AIX
Table 6. Arguments
Argument Type Description

id

String

Queue ID

System.EnergyConsumption.PowerZone(zone)

Energy consumption for power zone.

Data Type

Counter 64

Platforms

Linux
Table 7. Arguments
Argument Type Description

zone

String

Zone name

System.EnergyConsumption.Total

Total energy consumption.

Data Type

Counter 64

Platforms

Linux

System.ServiceState(name)

Return the operational state of a system service.

Data Type

Integer

Platforms

Linux, Windows
Table 8. Arguments
Argument Type Description

name

String

Service name (as registered with the operating system)
Table 9. Return Values
Value Description

0

Service running

1

Service paused

2

Service starting (start pending)

3

Service pausing (pause pending)

4

Service starting after pause (continue pending)

5

Service stopping (stop pending)

6

Service stopped

255

Unable to get current service state

System.Registry.Value(key, value)

Read a value from the Windows Registry.

Data Type

String

Platforms

Windows
Table 10. Arguments
Argument Type Description

key

String

Registry key path. Must begin with HKEY_CLASSES_ROOT, HKEY_CURRENT_CONFIG, HKEY_CURRENT_USER, HKEY_LOCAL_MACHINE, or HKEY_USERS

value

String

Registry value name
Example
System.Registry.Value(HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion, ProductName)

System.Update.LastDetectTime

Last update detection timestamp.

Data Type

Integer 64

Platforms

Windows

System.Update.LastDownloadTime

Last update download timestamp.

Data Type

Integer 64

Platforms

Windows

System.Update.LastInstallTime

Last update installation timestamp.

Data Type

Integer 64

Platforms

Windows