Docker Agent

Overview

The Granulate Docker Agent is the containerized version of the gAgent. Images are available for 64-bit x86 and Arm v8 architectures.

Setup

If you haven't installed the Docker Agent, you can follow the in-app installation instructions or see below. You can use the two-step setup process.

  1. Use Granulate provided Docker Hub credentials to retrieve the official Granulate gAgent docker image. The credential can be retrieved through your Granulate point-of-contact or using the in-app self-onboarding instruction.

  2. Run the Docker Image to deploy the gAgent Docker Agent with the appropriate Client ID license and Service ID:

docker login
docker run -d --restart=always --name granulate-agent --pid=host
--network=host -t --privileged -v /:/host --env "CLIENT_ID=<Client ID>"
--env "SERVICE_ID=<Service ID>" index.docker.io/granulate/gagent:latest

Additional Configuration

Once the Agent is up and running, Granulate's autodiscovery process identifies the environment and running containers to learn the application dataflow, resource usage patterns, and collected metrics.

Environment Variables

Find below the list of environment variables available for the Granulate gAgent.

Env Variable

Description

CLIENT_ID

You Granulate API authentication key (required)

SERVICE_ID

A tag to aggregate the agents installed on the same service

PROXY_SERVER

Optional setting to configure communication using HTTP/SOCKS5 proxy

ADDRESS

Destination site for your K8s collected metrics. Defaults to granulate.io

CONTAINER_UNITS

Optional setting to override the URL for metric submission