Menu

Collector Docker image installation

The AppSignal collector is available as a Docker image that can be run as a container in Docker (Compose) and Kubernetes infrastructure. We recommend this installation method if you want multiple (instances of) applications to report to one collector rather than install the collector on each application's host.

This guide assumes you have Docker installed or that the application's hosting platform uses it. For information on installing Docker locally, see Docker's official website.

This guide shows you how to configure the AppSignal collector Docker image for your app, using the Docker environment variables options.

Docker image

Add a container/service to your application's infrastructure using the appsignal/collector Docker image. In your applications, configure OpenTelemetry to export data to the container using the container's name.

On this Docker image, all servers are enabled by default to receive data from apps using OpenTelemetry (port 8099).

Supported platforms

The Docker image supports the following platforms. This list can also be viewed per Docker image tag on Docker Hub page for this image.

  • x86 64-bit
  • ARM 64-bit

Configuration

The collector can be configured with environment variables specified in the Docker run command, Docker compose options or Kubernetes configuration.

In the examples below, replace YOUR_PUSH_API_KEY with your actual AppSignal Push API key and configure it with your application details.

A complete list of configuration options can be found in the configuration section.

Docker run
Docker Compose
Docker run
# Docker run example
docker run \
  --env APPSIGNAL_PUSH_API_KEY=YOUR_PUSH_API_KEY \
  --publish "8099:8099" \
  appsignal/collector
Docker Compose
# docker-compose.yml example
version: "3"
 
services:
  appsignal: # Name of the container used as the hostname on which it can be reached
    image: appsignal/collector
    environment:
      - APPSIGNAL_PUSH_API_KEY=YOUR_PUSH_API_KEY
    ports:
      - "8099:8099" # OpenTelemetry

That's it! Once you've completed these steps, you should have the AppSignal collector's Docker image up and running, monitoring the host and, if configured, receiving data from other apps.