Menu

OpenTelemetry Beta

The OpenTelemetry beta involves more installation steps than usual. Please ensure you follow all the steps carefully to set it up correctly.

Previous versions of this documentation described how to install the standalone agent. This is no longer recommended. The AppSignal Collector replaces the standalone agent for this beta. Installation and configuration works differently in the collector, so we recommend following this guide again and updating the your application if necessary.

Install the AppSignal collector

To report data to AppSignal, you need to install the AppSignal collector via one of the following installation methods:

Configuring the AppSignal collector

When configuring the collector, use the organization-level Push API key from the API keys settings page. This will authenticate requests with AppSignal. Without a Push API key the collector will not start.

Linux package
# /etc/appsignal-collector.conf
push_api_key = "0000-0000-0000-0000"
Docker run
docker run \
  --env APPSIGNAL_PUSH_API_KEY="0000-0000-0000-0000" \
  --publish "8099:8099" \
  appsignal/collector
Docker Compose
version: "3.8"
 
services:
  appsignal-collector:
    image: appsignal/collector:latest
    environment:
      - APPSIGNAL_PUSH_API_KEY="0000-0000-0000-0000"

Install OpenTelemetry for your application

To install the OpenTelemetry packages in your app, follow the instructions for the language your app uses:

Make sure to follow the instructions, including installing any additional packages needed to have OpenTelemetry instrument the frameworks and libraries that your application uses.

For other languages, you can follow the installation instructions in the OpenTelemetry documentation for that language, alongside with our language-agnostic generic installation instructions. You might also find it useful to use our installation instructions for the languages we support as reference.