NXLog Documentation

Agent Visibility

To list the available NXLog agents, click AGENTS. A list similar to the following appears:

The agent list

This list displays the following information:

Status

A coloured sphere shows the agent’s status:

Green - Online

The agent is connected and its latest status response is successful. The agent is functioning normally.

Grey - Offline

The agent is not connected to the agent manager. Check the NXLog agent’s LogFile for error diagnostics.

Red - Error

One or more modules which the agent is configured to use are not running or not configured correctly. For network output modules, there is likely a connection issue and the module is unable to send. Check the NXLog agent’s LogFile for error diagnostics.

Yellow - Unmanaged

The agent is configured to be Unmanaged, and it is not possible to administer it remotely.

Yellow - Untrusted

The agent is connected to the manager without its own certificate. An agent must be issued a valid, unique certificate if it was installed without one.

Yellow - Forged

The agent certificate has a CN (common name) that does not match the reverse DNS of this agent’s IP address. Certificates must be issued to each agent—​they must not be copied or configured from another agent.

Once the agent configuration is updated centrally (by the application), or locally (on the agent side), changes must be deployed via the Update config command in order to apply the central configuration. If the configuration has been changed locally, a confirmation will be requested.
Agent name

Since the agent name is taken from the certificate subject name, the same name must be used for the agent name as is used in the certificate subject. Click the agent name to load the Agent Information page.

Template

The identifier of the template assigned to this agent. Agents inherit all template configuration settings. For more information about templates, see the chapter on Templates.

This column is not displayed by default. To enable or disable column visibility, click the round, grey Configuration button on the top left of the table, then check (or uncheck) the box by the name of the column.
Tags

The tags assigned to this agent. Tags may also be assigned to a template. For more information about configuring tags for templates, see Tags section.

This column is not displayed by default. To enable or disable column visibility, click the round, grey Configuration button on the top left of the table, then check (or uncheck) the box by the name of the column.
Version

The NXLog agent version number.

Host

The IP address of the remote host from which the NXLog agent is connected. Not available when the agent is Offline or Unmanaged.

Started

Shows the time the NXLog agent last started. Not available when the agent is Offline or Unmanaged. This value is set when the NXLog service is started or restarted, but it is not set when using the Reload button.

Load

The system load as reported by the NXLog agent’s host operating system. If this is not implemented on a platform (e.g. Microsoft Windows) Unknown will be displayed. A small graph displays the last 10 average values. This information is not available when the agent is Offline or Unmanaged.

This value represents the system load of the host operating system, not the NXLog agent. Due to other resource intensive processes, this can be high even if the NXLog agent is idle.
Mem. usage

The amount of memory used by the NXLog agent. On some platforms, Unknown is shown if the information is not available. A small graph displays the last 10 average values. This information is not available when the agent is Offline or Unmanaged.

Received

The sum of log messages received by all input modules since the agent has been started. A small graph displays the last 10 average values. This information is not available when the agent is Offline or Unmanaged.

Received today

The sum of log messages received by all input modules in the last 24 hours. A small graph displays the last 10 average values. This information is not available when the agent is Offline or Unmanaged.

Processing

Each NXLog agent module has a separate queue. This number shows the sum of messages in all modules' queues. A small graph displays the last 10 average values. This information is not available when the agent is Offline or Unmanaged.

Sent

The sum of log messages written or sent by all output modules since the agent has been started. A small graph displays the last 10 average values. This information is not available when the agent is Offline or Unmanaged.

If there are two output modules writing or sending logs from a single input, the number under Sent will be double of the value under Received.
Sent today

The sum of log messages written or sent by all output modules in the last 24 hours. A small graph displays the last 10 average values. This information is not available when the agent is Offline or Unmanaged.

If there are two output modules writing or sending logs from a single input, the number under Sent will be double of the value under Received.
Custom labels

Any custom labels set by the xm_admin Labels directive in the agent configuration are displayed at the end of the list. You can enable or disable custom labels from the view the same way as other columns by clicking the round, grey Configuration button on the top left of the table, then checking (or unchecking) the box by the name of the custom label. For example, the screenshot below shows two custom labels, Department and Location.

Agent custom labels

The information shown in the agent list is refreshed every 60 seconds or when Refresh status is clicked.

On the top left, the Filter agents button and the Show n entries drop-down menu are used to reduce the number of items displayed.

Click Filter agents to display the following dialog:

Filter Agents

The agents list can be filtered by 3 criteria:

  • Agent Status

  • Agent Name

  • Template(s) assigned

Click Apply filter to refresh the agent list with only agents which match the filtering criteria. For example, selecting ONLINE status will show the following:

Online agents list

When a filter is applied, click Clear filter to discard the applied filter and show all agents.

On the Filter Agents dialog, there is an option to save the current filter in the configuration database as an Agents View. Click Create View to enter the view name:

Create Agents View

The view name must be unique, and not contain any special characters or spaces. Saved views appear as tabs next to the Agent templates tab. A newly created view is applied to the current list immediately:

Agents view - Online