OpenTelemetry Beta

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

Install the AppSignal collector

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

• Linux package: run the collector on the host you want to monitor.
• Docker image: run the collector in a Docker container to connect to other containers.
• Platform as a Service: run the collector in a Docker container, hosted by your hosting provider.

If you have more than one application, or instances of an application, we recommend installing the collector to your infrastructure on its own instance, which all applications can report to. This will improve our reporting as we can piece together instrumentation data across different applications (distributed tracing). It is also more resource intensive to install the collector separately on each host.

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.

# /etc/appsignal-collector.conf
push_api_key = "0000-0000-0000-0000"

docker run \
  --env APPSIGNAL_PUSH_API_KEY="0000-0000-0000-0000" \
  --publish "8099:8099" \
  appsignal/collector

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:

• Ruby
• Elixir
• Node.js
• Python
• Go
• PHP
• Java
• Vercel

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.