Agents

The Agents view lists all the agents in your organization. Click Agents from the left navigation menu to access the view.

NXLog Platform Agents view

The agents table shows key information about each agent, such as its status, deployment state, and performance metrics. For a description of each column, see Agent properties.

You can customize the agent list and export it to a CSV file for use with third-party tools. See Customize the Agents view and Download agent information.

Agent actions

Each agent has an Actions menu with agent control functions that vary depending on context, agent status, and deployment state.

Table 1. Agent actions
Action Description

Restart

Stop and start all modules.

Start

Start all stopped modules.

Stop

Stop all modules.

Edit configuration

View and update the agent configuration.

Update configuration

Push a configuration update to the agent.

Assign configuration

Assign a new configuration to the agent. For more information, see Assign a configuration.

Unassign configuration

Unassign the current configuration from the agent. The agent’s configuration remains unchanged. The agent no longer receives updates made to the previously assigned configuration.

Enroll

Onboard the agent to NXLog Platform after establishing the initial connection. For more information, see Enroll an agent or Enroll an agent manually.

Enroll with configuration

Onboard the agent to NXLog Platform after establishing the initial connection and assign a configuration to the agent.

Refresh status

Update the agent details, including status and deployment state.

Renew certificate

Renew the TLS/SSL certificate of the selected agent. You may need to use this function in case of an expired or compromised certificate. For more information, see Manage certificates.

Export

Download a ZIP file with the configuration and the certificates of the selected agent.

View logs

View the NXLog Agent log file. For more information, see View an agent’s logs.

Update display name

Configure the display name for the selected agent. For more information, see Configure agent display names.

Unenroll

Unenroll the agent from NXLog Platform. This action does not stop or uninstall the NXLog Agent. NXLog Platform re-adds it to the agent list in an unenrolled state if the agent is still running.

Agent details

To manage an individual agent, click on its name in the agents table. The agent details page shows agent information and statistics. For a description of each field, see Agent properties. You can also update the agent configuration and control the agent from this page.

NXLog Platform agent details

The Statistics view shows the agent’s resource usage and event processing statistics per module.

NXLog Platform agent statistics