Agent properties

This page lists the agent properties you can use to search for NXLog Agent instances in NXLog Platform.

You can create search expressions by combining one or more properties to find the NXLog Agent instances you need. This is useful when you are viewing agents or setting up auto-enrollment rules. To learn about the operators for building search expressions, see Selector operators.

Table 1. Properties associated with a connected NXLog Agent instance
Property name	UI name	Description
`added-time`		Timestamp when the agent first connected to NXLog Platform. Example: `2026-08-27 17:15:26.139781467 UTC`.
`address`	IP address (agents table)	Source IP address and port number used by the agent to connect to NXLog Platform or null when the agent is offline. Example: `10.10.22.21:55076`. The port is optional when querying agents by address. The NXLog Platform UI doesn’t display the port.
`arch`	Arch (agents table, filter panel) Architecture (agent details)	CPU architecture of the agent’s host. Possible values: `x86_64`, `arm`.
`cached-logs`		Most recent data records sent by this agent to NXLog Platform.
`certificate`		Information about the stored certificate, including the start and expiration time.
`comment`		Optional description associated with the agent.
`config`		Either the actual content of the agent `managed.conf` file, or the expected content when it has been changed from NXLog Platform but not yet updated on the agent. Example: `config REGEX "(?s:.)AllowUntrusted(\s)(?i)true(?-i)(?s:.)*"`
`config-synced-with-template`		Synchronization status of the agent configuration and the corresponding configuration in NXLog Platform. `true` if the agent configuration is identical to the most recent version of the configuration assigned to the agent. `false` if the agent configuration is not identical to the most recent version of the configuration assigned to the agent. `null` if the agent configuration is not related to any configuration.
`configuration-author`		UUID of the user who created the configuration version assigned to the agent, or `null` when a configuration is not assigned. Note that this is the UUID of the user, not the username chosen by or assigned to the user on NXLog Platform.
`configuration-id, template-id`		UUID of the configuration assigned to the agent, or `null` when the agent is not assigned a configuration.
`configuration-name, template-name`	Configuration (agents table)	Name of the configuration assigned to the agent, or `null` when the agent is not assigned a configuration.
`configuration-timestamp`		Timestamp when the version of the configuration assigned to the agent was created, or `null` when the agent is not assigned a configuration.
`configuration-version`	Configuration (agents table)	Version number of the configuration assigned to the agent, or `null` when the agent is not assigned a configuration.
`configured`	Contributes to Deployment state	Configuration status: `true` if the agent has at least one input or output module configured, `false` otherwise.
`connected-time`	Last offline (agents table)	Timestamp of the agent’s most recent transition from offline to online. The value clears when the agent goes offline again. In the agents table, the value appears as a relative time, such as `2 hours ago`. Hover the value to see the exact timestamp. Example: `2026-08-27 17:15:26.139781467 UTC`.
`cpu-load`	CPU load (agents table, agent details)	Average CPU load of the agent process, measured since the process started. The NXLog Platform UI displays the value as a percentage rounded to two decimal places.
`cpu-usage-time`		CPU usage time of the agent process, measured in milliseconds since the process started.
`egress-bps`	Egress MBps (agents table)	Data output rate in bytes per second. The NXLog Platform UI converts this to megabytes per second for display.
`egress-eps`	Egress EPS (agents table)	Data output rate in events per second.
`enrolled`	Contributes to Deployment state	Enrollment status of the agent: `true` if the enrollment process completed successfully, `false` otherwise.
`enrolled-time`		Timestamp of the agent’s last enrollment in NXLog Platform. Example: `2026-08-27 17:15:26.139781467 UTC`.
`eps`		Same as `events-per-second`. The NXLog Platform UI displays the value rounded to two decimal places.
`errors`		Information on any errors related to the agent. For example, if the agent has an invalid configuration.
`events-per-second`		Log processing rate in events per second (EPS). The NXLog Platform UI displays the value rounded to two decimal places.
`fd-count`		Number of file descriptors currently in use by the agent.
`file-acls`		Directories that can be used with the GetFile and PutFile web service requests. The name of the ACL is used in these requests together with the filename. ACLs are configured through the Remote Management extension.
`file-names`		Name of the files associated with the agent, namely the certificate files and the configuration file.
`files`		Content of the files associated with the agent, namely the certificate files and the configuration file.
`files-sync`		Synchronization information for the files associated with the agent, namely the certificate files and the configuration file.
`files-synced`		Synchronization status of the agent files: `true` if the certificate and configuration files are synchronized with NXLog Platform, `false` otherwise.
`host`		Same as `hostname`.
`hostname`	Name (agents table) Host name (agent details)	The hostname of the machine where the agent is running, as reported by the agent.
`id`	ID (agent details)	The UUID of the agent in UUID Version 1 format. The agent typically reports its ID, but NXLog Platform can generate or overwrite it. For example, to avoid duplication when you create a second agent instance by cloning a VM.
`ingress-bps`	Ingress MBps (agents table)	Data input rate in bytes per second. The NXLog Platform UI converts this to megabytes per second for display.
`ingress-eps`	Ingress EPS (agents table)	Data input rate in events per second.
`label-names`		Names of all labels configured in the agent. Labels are configured through the Remote Management extension.
`labels`		Custom key-value pairs defined with supplementary details about the agent. For example, the display name or local contact information. Labels are configured through the Remote Management extension.
`last-processed-event-time`		Timestamp of the last event processed by the agent. Example: `2026-08-27 17:15:26.139781467 UTC`.
`manager-address`		The NXLog Platform IP address and port number to which the agent is connected or `null` when the agent is offline. Example: `10.10.22.254:5515`
`memory-used`	Memory usage (agents table) Mem (agent details)	Amount of RAM used by the agent in bytes. The NXLog Platform UI displays the value in megabytes or gigabytes.
`module-names`	Module (Filter panel)	Names of the modules included in the agent configuration.
`modules`		Information about the modules included in the agent configuration.
`name`		Same as `hostname`.
`online`	Contributes to Status	Connection status of the agent: `true` if the agent is connected to NXLog Platform, `false` otherwise.
`os`	OS (Filter panel, agent details)	Type of operating system where the agent is running. Possible values: `Android`, `Linux`, `Windows`, `AIX`, `FreeBSD` (for FreeBSD, NetBSD), `OpenBSD`, `BSD`, `HP-UX`, `Irix`, `macOS`, `Solaris`, `Unix`, `Unknown`.
`os-release`	OS version (agents table, filter panel, agent details)	Operating system type and version. Example: `Fedora Linux 39 (Workstation Edition)`
`persisted`		`true` if the agent is set to store data on disk instead of in memory, `false` otherwise.
`persisted-time`		Timestamp when the agent was set to persist data on disk, `null` if the agent is not set to persist data. Example: `2026-08-27 17:15:26.139781467 UTC`.
`pid`	PID (agent details)	Process identifier of the agent instance. Example: `9188`
`polled-time`	Last online (agents table)	Timestamp when NXLog Platform last requested data from the agent. NXLog Platform polls agents once every 60 seconds. Available for agents in any status. In the agents table, the value appears as a relative time, such as `2 hours ago`. Hover the value to see the exact timestamp. Example: `2026-08-27 17:15:26.139781467 UTC`.
`route-names`		Names of the routes included in the agent configuration.
`routes`		Information about the routes included in the agent configuration.
`started-time`	Started (agent details)	Timestamp of the most recent agent start or restart. Example: `2026-08-27 17:15:26.139781467 UTC`.
`status`	Contributes to Status	The agent management status as `ok`, `warning`, or `error`. The `errors` property contains a list of the detailed error types and messages.
`synced`		Overall synchronization status of the agent files with NXLog Platform, determined by the `files-synced` and `config-synced-with-template` fields. `true` if all agent files are synchronized and either the agent is not assigned a configuration, or the agent configuration is identical to the most recent version in NXLog Platform. `false` if the agent files are not synchronized, or the agent configuration is not identical to the most recent version of the configuration it is assigned in NXLog Platform.
`thread-count`		Number of threads the agent is using.
`version`	Version (agents table, filter panel, agent details)	Version of the agent. Example: `6.15.10900`.
`warnings`		Information on any warnings related to the agent. For example, if the agent files are not synchronized with NXLog Platform.

UI-only fields

Some fields shown in the NXLog Platform UI are not backed by a single agent property and so cannot be used directly in selectors.

Table 2. Fields without a corresponding agent property
Field	Description
`Agent time`	The current date and time on the agent host machine.
`Deployment state`	The agent’s stage in the deployment process. See Agent deployment state.
`Display name`	A customizable name consisting of one or more agent fields. For more information, see Configure display names.
`Ratio`	Displayed in the agents table as the data output rate divided by the data input rate, computed as `egress-bps / ingress-bps`.
`Status`	The agent’s connectivity to NXLog Platform. See Agent status.

See also