Troubleshooting relay agents

An agent's status is shown in SquaredUp Settings > Relay Agents as a green tick, amber exclamation mark, red cross or gray question mark. Hovering over the status will show information about the last connection.

If the agent status is not green:

1. Check that the agent service is running (for Windows agents this is in Services on the server running the agent).
2. Check that the API key is correct. In SquaredUp you can see the last 4 digits of the API key in Settings > Relay Agents and compare this with what's in the appsettings.json file in the agent folder /agent/transient/logs. If necessary, you can edit the agent and click Regenerate API Key to get a new key, then copy that into the appsettings.json file.
   
   How to find the agent folder location or Service name in Properties

   Look at the Properties of the SquaredUp Cloud Agent service:

   1. On the server running the agent, open Services
   2. Scroll down to the SquaredUp Cloud Agent in the list
   3. Right-click on the SquaredUp Cloud Agent service and then Properties
      Here you can see the Service name, Display name and Path to the agent folder.
   4. The Log On tab shows you which account the service is logging on with. (Needed for the SCOM and CSV plugins)
      

   5. You can also start or stop the service from the General tab.

3. Check the agent logs for any connectivity errors. Support may ask you to change the LogLevel from Information to Debug in the appsettings.json file.
4. Check SquaredUp for any reported outages: https://squaredup.statuspage.io/

Agents running in a container

If the agent status is not green and the agent is running in a container:

• Check that the container is still running: docker ps -a --filter name=SquaredUp-Agent. A container that exited shortly after starting usually indicates a configuration problem, which the logs will show.
• Check the logs: docker logs SquaredUp-Agent.
• Access to the path '/app/appsettings.json' is denied means the mounted file is not readable by the container user. See Configuration file via volume mount.
• If the agent starts but behaves as though it has no configuration, the volume mount may have used a relative path. Run docker volume ls and look for a volume named appsettings.json. If one exists, remove the container and that volume, then recreate the container using an absolute path.
• After correcting any configuration, remove and recreate the container. Restarting it is not sufficient. See Changing the configuration of a running agent.

For more information see Relay Agents.

Was this article helpful?