Ruby on Rails - ClickHouse Documentation

Use the OpenTelemetry Ruby SDK to send traces to ClickHouse Observability.

Set up OpenTelemetry

Follow the official OpenTelemetry Ruby setup instructions to initialize the SDK and instrument your application. Configure OTLP export over HTTP for traces, using the connection settings below. Replace any example destinations from the upstream instructions, including signal-specific endpoint overrides.

Configure your destination

Fully managed
Self-managed

Open Team Settings → Data → Managed Telemetry in your service and copy the OTLP HTTP endpoint and API key. Use the complete HTTPS endpoint, including its port:

export OTEL_EXPORTER_OTLP_ENDPOINT='https://YOUR_OTEL_ENDPOINT:4318'
export OTEL_EXPORTER_OTLP_HEADERS='authorization=Bearer%20YOUR_INGESTION_API_KEY'
export OTEL_EXPORTER_OTLP_PROTOCOL='http/protobuf'

Use your collector’s OTLP HTTP endpoint and ingestion key. Use http:// instead of https:// if your collector does not have TLS configured. For collector setup, see Ingesting with OpenTelemetry.

export OTEL_EXPORTER_OTLP_ENDPOINT='https://YOUR_COLLECTOR_HOST:4318'
export OTEL_EXPORTER_OTLP_HEADERS='authorization=YOUR_INGESTION_API_KEY'
export OTEL_EXPORTER_OTLP_PROTOCOL='http/protobuf'

Verify ingestion

Start your instrumented application and generate activity. In ClickHouse Observability, select a recent time range and find your application’s service name in Traces. For instrumentation and exporter troubleshooting, see the OpenTelemetry Ruby documentation.