opentelemetry-collector-sentry-demo

Hey, interested in a better way to integrate Sentry and OpenTelemetry? Please see: getsentry/sentry#40712

Summary:

Shows how to use the Open Telemetry Sentry exporter (WIP) to send Open Telemetry traces to Sentry through the Open Telemetry Collector

There are two examples in this demo. One is a script you can run against a running collector, while the other is a docker based setup that leverages synthetic trace generation to create traces.

Setup

Make sure you have docker and go installed.

Clone this repo:

git clone git@github.com:AbhiPrasad/opentelemetry-collector-sentry-demo.git

In another folder, clone the opentelemetry-collector-contrib repo.

git clone git@github.com:getsentry/opentelemetry-collector-contrib.git

Simple Example

Change directory to the simple example

cd simple_example

Setup and activate a Python3 environment.

python3 -m pip install virtualenv
python3 -m virtualenv .venv
source .venv/bin/activate

Install all required dependencies.

pip install -r requirements.txt

If needed, you can deactivate your virtualenv using:

deactivate

Add a DSN to your local config.

simple_example/config.yaml

---
exporters:
  logging: {}
  sentry:
    dsn: INSERT_DSN_HERE

Run the opentelemetry collector.

cd path/to/cloned/opentelemetry-collector-contrib
make otelcontribcol && GO111MODULE=on go run --race ./cmd/otelcontribcol/... --config "PATH_TO/opentelemetry-collector-sentry-demo/simple_example/config.yaml"  --metrics-addr "localhost:1337"

Run the demo script

cd path/to/cloned/opentelemetry-collector-sentry-demo/simple_example
python script.py

You should see a trace now appear in Sentry.

Docker example

Note: this example generates fake traces using a synthetic load generator, so it is recommended that a local sentry install be used to prevent sentry quota issues.

Enter the cloned project and build the docker image. It should be tagged as otelcontribcol:latest. If you have another image you prefer to use, change the image used in the docker-compose.

cd path/to/cloned/opentelemetry-collector-contrib
make docker-otelcontribcol

Now, navigate to the docker_example folder from the demo.

cd path/to/cloned/opentelemetry-collector-sentry-demo/docker_example

Add your Sentry project DSN to the otel-agent-config.yaml and otel-collector-config.yaml configs

If you are using a local sentry install, make sure to use host.docker.internal so docker can resolve the hosts properly

---
exporters:
  logging:
  sentry:
    dsn: INSERT_DSN_HERE

Run docker-compose

docker-compose up

You should see traces come into Sentry.