Agent Status Telemetry

The Agent Status telemetry captures the agent's operational heartbeat, providing a clear snapshot of runtime health. It reports key metrics such as CPU utilization, memory footprint, cache performance, flow table activity, packet throughput, and overall uptime, all in a single, structured record. These metrics give you immediate insight into how the engine performs under current network conditions.


Requirements

Agent Status telemetry was introduced in the Core Plugin in version 1.0.20. To begin streaming the telemetry:

  • Install and configure the Netify Agent
  • Install and configure a Sink Plugin for receiving the telemetry
  • Install and configure the Core Plugin and add stream-stats to types
Source
Core Plugin
Plugin Release
1.0.20

Optimizations

Time-series analysis transforms these records into actionable insights. Early detection of patterns like abnormal CPU growth or cache lag allows teams to preemptively resolve bottlenecks, preserving high-quality detection and total flow visibility.

Attributes

type

string
Telemetry record type. Always agent_status.

agent_version

string
Semantic version of the running Netify Agent.

build_version

string
Full agent build string including platform and enabled feature flags.

cpu_cores

integer
Number of CPU cores available to the agent process.

cpu_system

number
Current cumulative system CPU usage reported by the agent.

cpu_system_prev

number
Previous system CPU usage sample.

cpu_user

number
Current cumulative user CPU usage reported by the agent.

cpu_user_prev

number
Previous user CPU usage sample.

dhc_status

boolean
Status flag for the DNS hint cache subsystem.

fhc_status

boolean
Status flag for the flow hash cache subsystem.

flow_count

integer
Current number of tracked flows.

flow_count_prev

integer
Previous tracked flow count sample.

flows_active

integer
Number of active flows.

flows_expired

integer
Number of flows that have expired.

flows_expiring

integer
Number of flows currently in the process of expiring.

flows_in_use

integer
Number of flow table entries currently in use.

flows_purged

integer
Number of flows purged by maintenance routines.

maxrss_kb

integer
Current high-water resident set size in kilobytes.

maxrss_kb_prev

integer
Previous high-water resident set size sample in kilobytes.

memrss_kb

integer
Current resident memory usage in kilobytes.

memrss_kb_prev

integer
Previous resident memory usage sample in kilobytes.

tcm_kb

integer
Current TCMalloc-managed memory in kilobytes.

tcm_kb_prev

integer
Previous TCMalloc-managed memory sample in kilobytes.

timestamp

integer
Unix epoch timestamp (seconds) when the status record was generated.

update_imf

integer
Internal update indicator for incremental maintenance/metrics refresh.

update_interval

integer
Status publication interval in seconds.

uptime

integer
Agent uptime in seconds.

Agent Status Attributes - Example

{
  "agent_version": "5.2.0",
  "build_version": "Netify Agent/5.2.0-...",
  "cpu_cores": 8,
  "cpu_system": 3.148931,
  "cpu_system_prev": 3.134846,
  "cpu_user": 6.237091,
  "cpu_user_prev": 6.206476,
  "dhc_status": true,
  "fhc_status": true,
  "flow_count": 140,
  "flow_count_prev": 135,
  "flows_active": 55,
  "flows_expired": 21,
  "flows_expiring": 0,
  "flows_in_use": 120,
  "flows_purged": 11,
  "maxrss_kb": 85504,
  "maxrss_kb_prev": 85504,
  "memrss_kb": 84508,
  "memrss_kb_prev": 84380,
  "tcm_kb": 48141,
  "tcm_kb_prev": 48076,
  "timestamp": 1772661775,
  "type": "agent_status",
  "update_imf": 1,
  "update_interval": 15,
  "uptime": 1740
}