coscale/coscale-agent repository overview

⁠CoScale Agent Container

The CoScale Agent allows you to monitor the host, orchestrator, containers and services running inside those containers. Find out more about our solution for monitoring Docker⁠.

The image is only 18 MB in size and is configured through the CoScale web interface.

⁠Quick start

Starting the container requires 3 variables: your application id, access token and template id. The CoScale web interface provides the command with these variables filled in.

docker run -d --rm --privileged --net=host --pid=host --name coscale-agent -e APP_ID=$APP_ID -e ACCESS_TOKEN=$ACCESS_TOKEN -e TEMPLATE_ID=$TEMPLATE_ID -v /var/run/docker.sock:/var/run/docker.sock -v /:/host/:ro coscale/coscale-agent

⁠Logs

The logs of the CoScale agent can be fetched using the docker logs command.

docker logs coscale-agent

⁠Enabling integrations

Integrations for the services running inside your containers can be enabled through the CoScale web interface. There is no need to build your own agent images with a specific configuration, providing a different configuration is done through the TEMPLATE_ID variable.

⁠Permissions

Since the agent monitors metrics from both the host, docker engine and inside other containers, the agent containers requires some special permissions (as seen in the command above):

• --privileged : required to start the plugins in a different namespace and to read from /proc//io
• --pid=host : required to start the plugins in a different namespace and to see the mount points of the host
• --net=host : required to communicate with host services listening on localhost (eg. the Kubernetes api)
• -v /var/run/docker.sock:/var/run/docker.sock : required to communicate with docker engine
• -v /:/host/:ro : required to get the filesystem usage of the host