Documentation forSolarWinds Observability

Agents

SolarWinds Observability Agents (SWO Agents) provide data about monitored entities to SolarWinds Observability. SWO Agents are installed when adding hosts, databases, or network devices for monitoring. SWO Agents contain and supervise plugins - pieces of software with different roles that define the function of individual plugins.

Access Agents

You need to be logged in to SolarWinds Observability with an account of the Administrator role. See Manage Users.

  • In SolarWinds Observability, click Settings > Agents.

The Agents view shows a list of target hosts where you have deployed SWO Agents.

Expand a host for more details and review the Plugins section for a list of plugins deployed on the host. Listed items describe the role plugins perform, such as host-monitoring.

New SWO Agents have the New label for 24 hours from the time they were registered. SWO Agents should be connected all the time.

Update deployed SWO Agents

By default, deployed SWO Agents are updated automatically.

If you want to test new SWO Agent versions before distributing them globally or update SWO Agents during a specific maintenance window, disable the auto update.

  • Click the toggle to disable the auto-update.

If you disable the automatic update, review the Status column for information about updates. You can see the current plugin version next to the Auto update toggle.

  • To update the SWO Agent, click the Auto update toggle and turn the auto-update on. The SWO Agent and all installed plugins will be updated immediately.

Start, stop, or restart plugins

If you see a warning icon next to a target host, expand the item and review the status of its plugins.

  1. In Agents, expand the target host where your plugin is deployed.

  2. Under Plugins, find the plugin you want to start, stop, or restart.

  3. Click the vertical ellipsis at the end of the plugin row and select Start, Stop, or Restart.

Delete SWO Agents

To remove SWO Agents, uninstall the SWO Agent on the target host first, and then remove it from SolarWinds Observability. If you don't uninstall the SWO Agent first, it will keep sending data to SolarWinds Observability, and the entity will be re-created.

When upgrading the operating system or re-installing a SWO Agent server, you don't need to remove the SWO Agent from SolarWinds Observability. Just upgrade or re-install the system and re-install the SWO Agentusing the same API token as before. Based on the MAC address and other properties, the SWO Agent will be recognized, and the same unique number will be reassigned in SolarWinds Observability.

Uninstall the SWO Agent

Follow the steps for the operating system on the target host.

Windows computers

  1. Log in to the machine hosting the SWO Agent.

  2. Run the agent.msi on the target host, select Remove, and complete the SWO Agent Setup wizard. Otherwise, the SWO Agent will re-register and will be automatically added.

Linux computers

  1. Remove the SWO Agent on the target host, based on the package manager used by your Linux distribution.

    For example, run the following command:

    sudo dpkg -P uamsclient

You have uninstalled theSWO Agent on the target machine.

Now, you can remove the SWO Agent from SolarWinds Observability.

Remove the SWO Agent from SolarWinds Observability

  1. In Agents, find the host with the SWO Agent you want to delete.

  2. Click the vertical ellipsis at the end of the row, and then click Delete.

  3. Confirm the message.

You have removed the SWO Agent from SolarWinds Observability.

Now, you can remove the related entities, such as hosts, network devices, or databases.

Troubleshoot SolarWinds Observability Agent issues

Connection issues

If the SWO Agent status says Disconnected, it might be caused by a connection issue.

  1. Check the SWO Agent logs. Search for issues related to accessing endpoints or blocked ports. See Collect SWO Agent logs from target hosts.

    On target hosts, log files are stored in the following default locations:

    • Windows: C:\ProgramData\SolarWinds\UAMSClient\log\uamsclient.log
    • Linux: /var/log/solarwinds/uamsclient/uamsclient.log
  2. Make sure that the firewall on the host allows access to SolarWinds Observability all SolarWinds Observability Agent endpoints. See Endpoint URIs.

Collect SWO Agent logs from target hosts

  1. In SolarWinds Observability, click Settings > Agents.

  2. Click the vertical ellipsis at the end of a SolarWinds Observability Agent row and select Collect Logs. SWO Agent logs available on the target host start to be downloaded to SolarWinds Observability.

  3. When the download is complete, you will see a download logs button next to the agent. Click the button to download the logs to your computer.

SWO Agent logs are downloaded as a ZIP archive and are available for download in SolarWinds Observability for 24 hours. To get a fresh set of logs, repeat the steps above.

Multiple items for one SWO Agent on Agents page

When you see multiple items for one SolarWinds Observability Agent on the Agents page, configure your deployment to override the Client ID.

By default, SWO Agent ID is tied to the external MAC address of the target host. Once the host reboots, a new Client ID is created and a new SWO Agent item based on the ID is displayed in Agents.

To resolve the issue, override the client ID in the dynamic configuration file or using an environment variable.

Set the client override in the dynamic configuration file

  1. Open the dynamic configuration file (dynamic_config.yaml). Default locations:

    • Windows:  %PROGRAMDATA%\SolarWinds\UAMSClient

    • Linux: /opt/solarwinds/uamsclient/etc

  2. In Agents, expand the host with the SWO Agent that appears multiple times.

  3. Find Agent ID and copy it.

  4. Replace [string] in the following code with the agent ID copied previously and add the line to the configuration file.

    client-id-override: [string]

  5. If the client-id-override value is empty, the client ID is generated automatically for each registration request.

When you set the client-id-override value in the dynamic configuration file, the defined value is used and the SWO Agent will not be replicated on the Agents page for each reboot. However, if you set the client ID value in the environment variable, the variable value will overwrite the value in the dynamic configuration.

Set the UAMS_CLIENT_ID_OVERRIDE [string]

Set the client ID value in the UAMS_CLIENT_ID_OVERRIDE [string] variable. If the variable is defined during the client start, the value will be used. This value has priority over the client-id-override value in the dynamic configuration file.

When you set the UAMS_CLIENT_ID_OVERRIDE [string] variable, the defined value will always be used and the SWO Agent will not be replicated on the Agents page for each reboot.