README.md

grafana-ci-otel-collector

The Grafana CI OTel Collector is a distribution of the Open Telemetry collector tailored to CI/CD Observability.

Components

The following is a list of components that are included in the Grafana CI OTel Collector.

Highlighted components are currently being developed by us.

Receivers

• otlpreceiver
• dronereceiver
• githubactionsreceiver

Processors

• attributesprocessor
• batchprocessor
• resourceprocessor

Connectors

• routingconnector
• spanmetricsconnector

Exporters

• debugexporter
• lokiexporter
• otlpexporter
• prometheusexporter
• prometheusremotewriteexporter

Extensions

• basicauthextension
• healthcheckextension

Configuration

The collector is configured using the config.yaml file in the root of the repository. You can learn more about the OpenTelemetry Collector configuration here.

Refer to each component's documentation (linked above) for specific configuration options.

A barebones configuration file can be found in the config.example.yaml file in the root of the repository, with preconfigured exporters for Loki, Tempo, and Prometheus. You can use this file as a starting point for your own configuration.

Running Tempo, Loki, and Prometheus

A basic Docker compose file is provided in the root of the repository to run Tempo, Loki, and Prometheus.

To start the services, run:

docker compose up