Documentation forSolarWinds Observability SaaS

Run the SolarWinds Observability Agent as a Docker image or Kubernetes deployment

You can deploy Agents using a Docker image and use the Agent for OTel integrations. When adding an integration, just select the deployed Agent to install the appropriate integration plugin on it.

SolarWinds Observability Agent support for Docker and Kubernetes

Agent is published as a Docker image with every build. The primary use case for the Docker image is to run it in a Kubernetes cluster to monitor nodes and/or pods. You can also just start a container with the docker run command.

Limitations

Review the following differences between the regular Agent deployment and using the Agent Docker image.

Use Docker volumes

Use Docker volumes as the working directory of the SolarWinds Observability Agent running in the container to preserve the state of the application between runs of the container. See Run the SolarWinds Observability Agent as a Docker image or Kubernetes deployment.

Auto-update is disabled

Auto-update process for Agent in Docker would cause the process to stop and that leads to stopping the Docker container. This is why the auto-update functionality for Agent is disabled. Agents running in containers require a manual update. The latest version is displayed when you hover your mouse over the Warning status.

Auto-update for plugins is enabled.

Agent ID override

MAC Addresses and other properties used to calculate the Agent ID change with each run of the Docker container. This behavior would cause assigning a new Agent ID every time the Docker container starts.

There are the following options to handle this:

  • (Recommended): Copy the UAMS_CLIENT_ID_OVERRIDE from the code generated in the Add Agent wizard (click Add New Agent on the Agents page > select Docker Image> provide a token > Instruction step) and provide this environment variable to the Agent.

  • Use a UUID generator, such as https://www.uuidgenerator.net/, to generate the UAMS_CLIENT_ID_OVERRIDE. Provide this environment variable to the Agent. This ID is the same between runs and it is in the GUID/UUID format, such as 3ce8658f-343f-4d60-a382-cba1a1bc0e63.

  • Ensure that a unique and repeatable Agent ID is assigned to each Agent container by providing the UAMS_CLIENT_ID_OVERRIDE_SOURCE_NAME environment variable. This variable can contain arbitrary text used to generate the same UUID every time. For example:

    • When the Agent is part of a DeamonSet, set its value to spec.nodeName to ensure that the Agent ID is always the same on a particular node.

    • When the Agent is replicated within StatefulSet, set its value to metadata.name to ensure that the Agent ID is always the same for a particular replica.

Enable host monitoring to use the Agent for database monitoring

If you want to use the Agent deployed in Docker/Kubernetes to monitor a database, add the host for monitoring first or enable host monitoring for the agent.

Supported environment variables for containers

Configure the Agent container by providing the following environment variables:

Parameter Optional/
Required		 Description
SWO_URL optional

The correct endpoint for your organization.

The default value is na-01: North American AWS data center
UAMS_ACCESS_TOKEN required An access token used to register the client.
UAMS_CLIENT_ID_OVERRIDE required if you do not want to register a new client after each run of a new docker container A constant Client ID that does not change between runs.

UAMS_CONTAINER_HOSTNAME

optional but strongly recommended. Sets a custom hostname because the autodetection of hostnames in some container runtimes does not work as expected. For example, setting this variable addresses a situation where a container might return the hostname of the parent system.
UAMS_HTTPS_PROXY optional

The proxy only for the Agent

Use a proxy IP address, hostname, or domain name in one of the following formats:

  • proxyAddress
  • proxyAddress:port,
  • http://user:password@proxyAddress:port
UAMS_IS_EPHEMERAL optional Marks an Agent as ephemeral. Ephemeral Agents are automatically removed from SolarWinds Observability SaaS when they are disconnected for at least 24 hours. Use this parameter for temporary Agents.
UAMS_MANAGED_LOCALLY optional

Supported value: true

Set to true to install the Agent as a locally-managed Agent.

By default, the configuration source for Agents is set to Remote.
UAMS_METADATA optional Custom metadata to be sent to the cluster on the first registration.
UAMS_OVERRIDE_HOSTNAME optional Set a custom Agent name. By default, Agent name is set to the hostname. SolarWinds recommends that you use it together with UAMS_CONTAINER_HOSTNAME and set the same value for both variables.

Learn more