Step 1. Setup OTel Collector

The OpenTelemetry (OTel) Collector helps collect telemetry data such as logs, traces and metrics from your application. Please follow the documentation here to setup the OpenTelmetry Collector in your VM. Make sure to use the latest OTel Collector release.

Step 2. Setup GitHub Receiver

Update the config.yaml file that you created in otelcol-contrib folder while setting up OTel Collector to include the github receiver under the receivers section.

...
receivers:
  github:
    webhook:
      endpoint: 0.0.0.0:19418
      path: /events
      health_path: /health #optional
      secret: ${GITHUB_WEBHOOK_SECRET}
      service_name: <service-name> #optional
    scrapers:
      scraper:
...

• GITHUB_WEBHOOK_SECRET: This environment variable, which you will create in Step 4, contains the shared secret used to verify that incoming webhook requests are from GitHub. It ensures authenticity and helps prevent tampered or spoofed requests.
• <service-name>: Specifies the service that emits the traces, making it easier to identify and filter traces related to a specific GitHub integration.

Step 3. Add GitHub Receiver to pipelines

In the config.yaml file, under the service section, locate the pipelines block. Within the traces pipeline, add github to the list of receivers.

...
service:
  pipelines:
    traces:
      receivers: [github]
      processors: []
      exporters: [otlp,debug]
...

Step 4. Run the OTel Collector

Set an environment variable named GITHUB_WEBHOOK_SECRET. Inside otelcol-contrib folder, run the otelcol-contrib command.

export GITHUB_WEBHOOK_SECRET=<webhook-secret>
./otelcol-contrib --config ./config.yaml

• <webhook-secret>: Your GitHub webhook secret.