Agent Internal Metrics :: NetXMS Documentation

Agent.ID

Agent unique identifier.

Data Type

String

Platforms

All

Agent.Version

Agent version string.

Data Type

String

Platforms

All

Agent.Uptime

Agent runtime in seconds.

Data Type

Unsigned Integer

Platforms

All

Agent.AccessLevel

Session access level (full/control/read).

Data Type

String

Platforms

All

Agent.Desktop

Desktop associated with agent process.

Data Type

String

Platforms

Windows

Agent.SupportedCiphers

Available encryption algorithms.

Data Type

String

Platforms

All

Agent.SourcePackageSupport

Whether agent supports source packages.

Data Type

Integer

Platforms

All

Agent.FileHandleLimit

Open file descriptor limit.

Data Type

Unsigned Integer

Platforms

Linux, macOS, FreeBSD, NetBSD, OpenBSD, Solaris, AIX

Agent.IsRestartPending

Pending restart flag (1=pending, 0=no).

Data Type

Integer

Platforms

All

Agent.IsUserAgentInstalled

User agent installation status.

Data Type

Integer

Platforms

All

Agent.SessionAgentCount

Number of session agents.

Data Type

Unsigned Integer

Platforms

All

Agent.UserAgentCount

Number of user agents.

Data Type

Unsigned Integer

Platforms

All

Agent.ConfigurationLoadStatus

Configuration load success/failure.

Data Type

Unsigned Integer

Platforms

All

Agent.ConfigurationServer

Configured management server address.

Data Type

String

Platforms

All

Agent.Registrar

Registrar server address.

Data Type

String

Platforms

All

Agent.LogFile.Status

Log file status.

Data Type

Unsigned Integer

Platforms

All

Agent.AcceptedConnections

Total accepted connections since agent start.

Data Type

Counter 32

Platforms

All

Agent.AcceptErrors

Connection acceptance errors.

Data Type

Counter 32

Platforms

All

Agent.ActiveConnections

Currently active connections.

Data Type

Unsigned Integer

Platforms

All

Agent.RejectedConnections

Refused connections.

Data Type

Counter 32

Platforms

All

Agent.AuthenticationFailures

Failed authentication attempts.

Data Type

Counter 32

Platforms

All

Agent.ProcessedRequests

Successfully handled requests.

Data Type

Counter 32

Platforms

All

Agent.FailedRequests

Processing failures.

Data Type

Counter 32

Platforms

All

Agent.UnsupportedRequests

Unknown metric requests.

Data Type

Counter 32

Platforms

All

Agent.Events.Generated

Total events created.

Data Type

Counter 64

Platforms

All

Agent.Events.LastTimestamp

Most recent event timestamp.

Data Type

Unsigned Integer 64

Platforms

All

Agent.DataCollectorQueueSize

Pending data collection items. Deprecated — use Agent.DataSenderQueueSize instead.

Data Type

Unsigned Integer

Platforms

All

Agent.DataSenderQueueSize

Agent data sender queue size.

Data Type

Unsigned Integer

Platforms

All

Agent.DataReconciliation.PendingDataPoints

Number of data points pending reconciliation with server.

Data Type

Unsigned Integer

Platforms

All

Agent.DataReconciliation.TimeSinceLastSync

Time in seconds since last successful data reconciliation with server.

Data Type

Integer 64

Platforms

All

Agent.NotificationProcessor.QueueSize

Pending notifications in queue.

Data Type

Unsigned Integer

Platforms

All

Agent.Heap.Active

Active heap memory (bytes).

Data Type

Unsigned Integer 64

Platforms

All

Agent.Heap.Allocated

Allocated heap memory (bytes).

Data Type

Unsigned Integer 64

Platforms

All

Agent.Heap.Mapped

Mapped heap memory (bytes).

Data Type

Unsigned Integer 64

Platforms

All

Agent.LocalDatabase.FailedQueries

Local database query failures.

Data Type

Counter 64

Platforms

All

Agent.LocalDatabase.FileSize

Local database file size (bytes).

Data Type

Unsigned Integer 64

Platforms

All

Agent.LocalDatabase.LongRunningQueries

Slow database queries.

Data Type

Counter 64

Platforms

All

Agent.LocalDatabase.Status

Database operational status.

Data Type

Unsigned Integer

Platforms

All

Agent.LocalDatabase.TotalQueries

Total database queries.

Data Type

Counter 64

Platforms

All

Agent.Proxy.ActiveSessions

Active proxy connections.

Data Type

Unsigned Integer

Platforms

All

Agent.Proxy.ConnectionRequests

Proxy connection attempts.

Data Type

Counter 64

Platforms

All

Agent.Proxy.IsEnabled

Proxy feature enabled flag.

Data Type

Unsigned Integer

Platforms

All

Agent.SNMP.IsProxyEnabled

SNMP proxy feature flag.

Data Type

Unsigned Integer

Platforms

All

Agent.SNMP.IsTrapProxyEnabled

SNMP trap proxy feature flag.

Data Type

Unsigned Integer

Platforms

All

Agent.SNMP.Requests

SNMP requests forwarded.

Data Type

Counter 64

Platforms

All

Agent.SNMP.Responses

SNMP responses received.

Data Type

Counter 64

Platforms

All

Agent.SNMP.ServerRequests

SNMP server requests.

Data Type

Counter 64

Platforms

All

Agent.SNMP.Traps

SNMP traps forwarded.

Data Type

Counter 64

Platforms

All

Agent.SyslogProxy.IsEnabled

Syslog proxy feature flag.

Data Type

Unsigned Integer

Platforms

All

Agent.SyslogProxy.ReceivedMessages

Syslog messages processed.

Data Type

Counter 64

Platforms

All

Agent.TCPProxy.ConnectionRequests

TCP proxy connection attempts.

Data Type

Counter 64

Platforms

All

Agent.TCPProxy.IsEnabled

TCP proxy feature flag.

Data Type

Unsigned Integer

Platforms

All

Agent.WebServiceProxy.IsEnabled

Web service proxy feature flag.

Data Type

Unsigned Integer

Platforms

All

Agent.Extension.IsConnected(name)

Check if the given agent extension is connected (1=connected, 0=not connected).

Data Type

Integer

Platforms

All

Table 1. Arguments
Argument	Type	Description
name	String	Agent extension name

Agent.Extension.RestartCount(name)

Restart count of the given agent extension.

Data Type

Unsigned Integer

Platforms

All

Table 2. Arguments
Argument	Type	Description
name	String	Agent extension name

Agent.Extension.Uptime(name)

Connection uptime in seconds for the given agent extension.

Data Type

Unsigned Integer 64

Platforms

All

Table 3. Arguments
Argument	Type	Description
name	String	Agent extension name

Agent.IsExternalSubagentConnected(name)

Check if a specific external subagent is connected to the agent.

Data Type

Integer

Platforms

All

Table 4. Arguments
Argument	Type	Description
name	String	Name of the external subagent to check

Table 5. Return Values
Value	Description
1	External subagent is connected
0	External subagent is not connected

Returns no-such-instance error if the specified external subagent name is not registered.

Agent.IsSubagentLoaded(name)

Check if a specific subagent is loaded by the agent process.

Data Type

Integer

Platforms

All (Windows, Linux, Solaris, AIX, FreeBSD, NetBSD, OpenBSD)

Table 6. Arguments
Argument	Type	Description
name	String	Name of the subagent to check

Table 7. Return Values
Value	Description
1	Subagent is loaded
0	Subagent is not loaded

Example

Agent.IsSubagentLoaded(ping)

Agent.PushValue(name)

Retrieve the cached value of a push metric. Push metrics have their values sent to the agent by external sources rather than being collected by the agent itself.

Data Type

String

Platforms

All

Table 8. Arguments
Argument	Type	Description
name	String	Name of the push metric to retrieve

Returns no-such-instance error if the specified push metric has no cached value.

Agent.ThreadPool.metric(pool)

Thread pool monitoring metrics provide visibility into agent internal thread pool utilization.

Data Type

Unsigned Integer

Platforms

All

Table 9. Arguments
Argument	Type	Description
pool	String	Name of the thread pool (e.g., `COMM`, `WEBSVC`, `DATACOLL`, `PROCEXEC`, `TIMER`)

Table 10. Available Metrics
Metric	Description
`Agent.ThreadPool.ActiveRequests(pool)`	Number of currently active requests
`Agent.ThreadPool.AverageWaitTime(pool)`	Average time tasks spend in queue (ms)
`Agent.ThreadPool.CurrSize(pool)`	Current number of threads in the pool
`Agent.ThreadPool.Load(pool)`	Current utilization as percentage
`Agent.ThreadPool.LoadAverage(pool)`	1-minute load average
`Agent.ThreadPool.LoadAverage5(pool)`	5-minute load average
`Agent.ThreadPool.LoadAverage15(pool)`	15-minute load average
`Agent.ThreadPool.MaxSize(pool)`	Maximum configured thread count
`Agent.ThreadPool.MinSize(pool)`	Minimum configured thread count
`Agent.ThreadPool.ScheduledRequests(pool)`	Number of tasks waiting in queue
`Agent.ThreadPool.Usage(pool)`	Thread pool usage as percentage

ExternalCheck.Status(name)

Exit code of a configured external check (Nagios-compatible plugin). The agent returns the exit code unchanged.

Data Type

Integer

Platforms

All

Table 11. Arguments
Argument	Type	Description
name	String	Configured external check name (case-insensitive)

Table 12. Conventional Status Codes
Value	Description
0	OK
1	WARNING
2	CRITICAL
3	UNKNOWN

Returns no-such-instance error for an unknown check name, and a collection error if the check process cannot be started or times out. A missing plugin in shell form is not such an error: the shell starts and its exit code (for example 127) is returned. See External Checks for configuration, caching, and DCI examples.

ExternalCheck.StatusText(name)

Status text from the first line of a configured external check’s output, before the | character. Leading and trailing whitespace is removed; no output produces an empty string.

Data Type

String

Platforms

All

Table 13. Arguments
Argument	Type	Description
name	String	Configured external check name (case-insensitive)

Returns no-such-instance error for an unknown check name, and a collection error if the check process cannot be started or times out. A missing plugin in shell form is not such an error: the shell’s error message is returned. See External Checks for configuration and caching.

ExternalCheck.Value(name, label)

Numeric value of a performance data entry returned by a configured external check. The unit suffix is removed without converting the value: for example, 403MB returns 403. Entries without a numeric value, including U (unknown), are skipped by the parser.

Data Type

Float

Platforms

All

Table 14. Arguments
Argument	Type	Description
name	String	Configured external check name (case-insensitive)
label	String	Performance data label (case-insensitive), without the surrounding single quotes used in plugin output

Returns no-such-instance error for an unknown check name or label, unsupported error for an empty label, and a collection error if the check process cannot be started or times out. A missing plugin in shell form is not such an error: the run produces no performance data, so every label returns no-such-instance. To retrieve all labels and their units, thresholds, and limits, use ExternalCheck.PerfData. See External Checks for configuration, output parsing, and caching.