"Get Started with OpenTelemetry"

Opik provides native support for OpenTelemetry (OTel), allowing you to instrument your ML/AI applications with distributed tracing. This guide will show you how to directly integrate OpenTelemetry SDKs with Opik.

OpenTelemetry Endpoint Configuration

Base Endpoint

To start sending traces to Opik, configure your OpenTelemetry exporter with one of these endpoints:

$
export OTEL_EXPORTER_OTLP_ENDPOINT="https://www.comet.com/opik/api/v1/private/otel"
>
export OTEL_EXPORTER_OTLP_HEADERS="Authorization=<your-api-key>,projectName=<your-project-name>,Comet-Workspace=<your-workspace-name>"

Signal-Specific Endpoint

If your OpenTelemetry setup requires signal-specific configuration, you can use the traces endpoint. This is particularly useful when different signals (traces, metrics, logs) need to be sent to different endpoints:

$
export OTEL_EXPORTER_OTLP_TRACES_ENDPOINT="http://<YOUR-OPIK-INSTANCE>/api/v1/private/otel/v1/traces"

Custom via OpenTelemetry SDKs

You can use any OpenTelemetry SDK to send traces directly to Opik. OpenTelemetry provides SDKs for many languages (C++, .NET, Erlang/Elixir, Go, Java, JavaScript, PHP, Python, Ruby, Rust, Swift). This extends Opik’s language support beyond the official SDKs (Python and TypeScript). For more instructions, visit the OpenTelemetry documentation.

Here’s a Python example showing how to set up OpenTelemetry with Opik:

1
from opentelemetry import trace
2
from opentelemetry.exporter.otlp.proto.http.trace_exporter import (
3
    OTLPSpanExporter
4
)
5
from opentelemetry.sdk.trace import TracerProvider
6
from opentelemetry.sdk.trace.export import BatchSpanProcessor
7
8
# For Comet-hosted installations
9
OPIK_ENDPOINT = "https://<COMET-SERVER>/api/v1/private/otel/v1/traces"
10
API_KEY = "<your-api-key>"
11
PROJECT_NAME = "<your-project-name>"
12
WORKSPACE_NAME = "<your-workspace-name>"
13
14
# Initialize the trace provider
15
provider = TracerProvider()
16
processor = BatchSpanProcessor(
17
    OTLPSpanExporter(
18
        endpoint=OPIK_ENDPOINT,
19
        headers={
20
            "Authorization": API_KEY,
21
            "projectName": PROJECT_NAME,
22
            "Comet-Workspace": WORKSPACE_NAME
23
        }
24
    )
25
)
26
provider.add_span_processor(processor)
27
trace.set_tracer_provider(provider)

$
pip install opentelemetry-instrumentation-openai

1
from opentelemetry.instrumentation.openai import OpenAIInstrumentor
2
3
OpenAIInstrumentor().instrument()