5a558eb09e
TypeScript SDK Compatibility V1.x E2E Tests / Select Node version matrix (push) Has been cancelled
TypeScript SDK Compatibility V1.x E2E Tests / TypeScript SDK Compatibility V1.x E2E Tests Node ${{matrix.node_version}} (push) Has been cancelled
TypeScript SDK E2E Tests / TypeScript SDK E2E Tests Node ${{matrix.node_version}} (push) Has been cancelled
Opik Optimizer - E2E Tests / build-opik (push) Has been cancelled
TypeScript SDK Compatibility V1.x E2E Tests / build-opik (push) Has been cancelled
Python SDK E2E Tests / Select Python version matrix (push) Has been cancelled
Python SDK E2E Tests / Python SDK E2E Tests ${{matrix.python_version}} (push) Has been cancelled
Python SDK E2E Tests / build-opik (push) Has been cancelled
Python SDK Compatibility V1.x E2E Tests / Select Python version matrix (push) Has been cancelled
Python SDK Compatibility V1.x E2E Tests / Python SDK Compatibility V1.x E2E Tests ${{matrix.python_version}} (push) Has been cancelled
Python SDK Compatibility V1.x E2E Tests / build-opik (push) Has been cancelled
TypeScript SDK E2E Tests / Select Node version matrix (push) Has been cancelled
TypeScript SDK E2E Tests / build-opik (push) Has been cancelled
Opik Optimizer - E2E Tests / Opik Optimizer E2E Tests Python ${{matrix.python_version}} (push) Has been cancelled
Opik Optimizer - E2E Tests / Opik Optimizer Integration Smoke Tests (push) Has been cancelled
🐙 Code Quality / detect (push) Has been cancelled
🐙 Code Quality / lint (${{ matrix.leg.name }}) (push) Has been cancelled
🐙 Code Quality / summary (push) Has been cancelled
TypeScript SDK Library Integration Tests / Check Secrets (push) Has been cancelled
TypeScript SDK Library Integration Tests / opik-vercel (Vercel AI SDK / eve) (push) Has been cancelled
SDK Library Integration Tests Runner / Check Secrets (push) Has been cancelled
SDK Library Integration Tests Runner / Missed OpenAI API Key Warning (push) Has been cancelled
SDK Library Integration Tests Runner / Build (push) Has been cancelled
SDK Library Integration Tests Runner / openai_tests (push) Has been cancelled
SDK Library Integration Tests Runner / langchain_tests (push) Has been cancelled
SDK Library Integration Tests Runner / langchain_legacy_tests (push) Has been cancelled
SDK Library Integration Tests Runner / llama_index_tests (push) Has been cancelled
SDK Library Integration Tests Runner / anthropic_tests (push) Has been cancelled
SDK Library Integration Tests Runner / mistral_tests (push) Has been cancelled
SDK Library Integration Tests Runner / groq_tests (push) Has been cancelled
SDK Library Integration Tests Runner / aisuite_tests (push) Has been cancelled
SDK Library Integration Tests Runner / haystack_tests (push) Has been cancelled
SDK Library Integration Tests Runner / dspy_tests (push) Has been cancelled
SDK Library Integration Tests Runner / crewai_v0_tests (push) Has been cancelled
SDK Library Integration Tests Runner / crewai_v1_tests (push) Has been cancelled
SDK Library Integration Tests Runner / genai_tests (push) Has been cancelled
SDK Library Integration Tests Runner / adk_tests (push) Has been cancelled
SDK Library Integration Tests Runner / adk_legacy_1_3_0_tests (push) Has been cancelled
SDK Library Integration Tests Runner / evaluation_metrics_tests (push) Has been cancelled
SDK Library Integration Tests Runner / bedrock_tests (push) Has been cancelled
SDK Library Integration Tests Runner / litellm_tests (push) Has been cancelled
SDK Library Integration Tests Runner / harbor_tests (push) Has been cancelled
SDK Library Integration Tests Runner / Slack Notification (push) Has been cancelled
Lint Opik Helm Chart / render-equality (push) Has been cancelled
Opik Optimizer - Unit Tests / Opik Optimizer Unit Tests Python ${{matrix.python_version}} (push) Has been cancelled
Python BE E2E Tests / Python BE E2E (push) Has been cancelled
Python Backend Tests / run-python-backend-tests (push) Has been cancelled
Python SDK Unit Tests / Python SDK Unit Tests ${{matrix.python_version}} (push) Has been cancelled
Release Drafter / update_release_draft (push) Has been cancelled
SDK E2E Libraries Integration Tests / Check Secrets (push) Has been cancelled
SDK E2E Libraries Integration Tests / Missed OpenAI API Key Warning (push) Has been cancelled
SDK E2E Libraries Integration Tests / build-opik (push) Has been cancelled
SDK E2E Libraries Integration Tests / E2E Lib Integration Python ${{matrix.python_version}} (push) Has been cancelled
TypeScript SDK Integration Build & Publish / build-and-publish (opik-gemini) (push) Has been cancelled
TypeScript SDK Integration Build & Publish / build-and-publish (opik-langchain) (push) Has been cancelled
TypeScript SDK Integration Build & Publish / build-and-publish (opik-openai) (push) Has been cancelled
TypeScript SDK Integration Build & Publish / build-and-publish (opik-otel) (push) Has been cancelled
TypeScript SDK Integration Build & Publish / build-and-publish (opik-vercel) (push) Has been cancelled
TypeScript SDK Build & Publish / build-and-publish (push) Has been cancelled
TypeScript SDK Unit Tests / Test on Node ${{ matrix.node-version }} (push) Has been cancelled
Backend Tests / discover-tests (push) Has been cancelled
Backend Tests / ${{ matrix.name }} (push) Has been cancelled
Build and Publish SDK / build-and-publish (push) Has been cancelled
Build Opik Docker Images / set-version (push) Has been cancelled
Build Opik Docker Images / build-backend (push) Has been cancelled
Build Opik Docker Images / build-sandbox-executor-python (push) Has been cancelled
Build Opik Docker Images / build-python-backend (push) Has been cancelled
Build Opik Docker Images / build-frontend (push) Has been cancelled
Build Opik Docker Images / create-git-tag (push) Has been cancelled
ClickHouse Migration Cluster Check / validate-clickhouse-migrations (push) Has been cancelled
Docs - Publish / run (push) Has been cancelled
E2E Tests - Post Merge (v2) / 🧪 E2E v2 Tests (${{ github.event.inputs.tier || 't1' }}) (push) Has been cancelled
E2E Tests - Post Merge (v2) / 📢 Slack Notification (push) Has been cancelled
Frontend Unit Tests / Test on Node 20 (push) Has been cancelled
Guardrails E2E Tests / Select Python version matrix (push) Has been cancelled
Guardrails E2E Tests / Guardrails E2E Tests ${{matrix.python_version}} (push) Has been cancelled
Guardrails E2E Tests / 📢 Slack Notification (push) Has been cancelled
Guardrails Backend Unit Tests / Guardrails Backend Unit Tests (push) Has been cancelled
Guardrails Backend Unit Tests / 📢 Slack Notification (push) Has been cancelled
Lint Opik Helm Chart / lint-helm-chart (Helm v3.21.0) (push) Has been cancelled
Lint Opik Helm Chart / lint-helm-chart (Helm v4.2.0) (push) Has been cancelled
Lint Opik Helm Chart / unittest-helm-chart (push) Has been cancelled
126 lines
3.8 KiB
Plaintext
126 lines
3.8 KiB
Plaintext
---
|
|
headline: OpenTelemetry | Opik Documentation
|
|
og:description: Integrate OpenTelemetry SDKs with Opik to enhance your ML/AI apps
|
|
with distributed tracing and streamline monitoring.
|
|
og:site_name: Opik Documentation
|
|
og:title: Get Started with OpenTelemetry - Opik
|
|
subtitle: Describes how to send data to Opik using OpenTelemetry
|
|
title: OpenTelemetry
|
|
toc_max_heading_level: 4
|
|
---
|
|
|
|
# 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.
|
|
|
|
<Note>
|
|
OpenTelemetry integration in Opik currently supports HTTP transport. We're actively working on expanding the feature
|
|
set - stay tuned for updates!
|
|
</Note>
|
|
|
|
## OpenTelemetry Endpoint Configuration
|
|
|
|
### Base Endpoint
|
|
|
|
To start sending traces to Opik, configure your OpenTelemetry exporter with one of these endpoints:
|
|
|
|
<Tabs>
|
|
<Tab title="Opik Cloud">
|
|
|
|
```bash wordWrap
|
|
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>"
|
|
```
|
|
|
|
</Tab>
|
|
<Tab title="Self-hosted deployment">
|
|
|
|
```bash wordWrap
|
|
export OTEL_EXPORTER_OTLP_ENDPOINT="http://localhost:5173/api/v1/private/otel"
|
|
```
|
|
|
|
</Tab>
|
|
<Tab title="Enterprise deployment">
|
|
|
|
```bash wordWrap
|
|
export OTEL_EXPORTER_OTLP_ENDPOINT="https://<comet deployment url>/opik/api/v1/private/otel"
|
|
export OTEL_EXPORTER_OTLP_HEADERS="Authorization=<your-api-key>,projectName=<your-project-name>,Comet-Workspace=<your-workspace-name>"
|
|
```
|
|
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
### 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:
|
|
|
|
```bash wordWrap
|
|
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](https://opentelemetry.io/docs/languages/).
|
|
|
|
Here's a Python example showing how to set up OpenTelemetry with Opik:
|
|
|
|
```python wordWrap
|
|
from opentelemetry import trace
|
|
from opentelemetry.exporter.otlp.proto.http.trace_exporter import (
|
|
OTLPSpanExporter
|
|
)
|
|
from opentelemetry.sdk.trace import TracerProvider
|
|
from opentelemetry.sdk.trace.export import BatchSpanProcessor
|
|
|
|
# For Comet-hosted installations
|
|
OPIK_ENDPOINT = "https://<COMET-SERVER>/api/v1/private/otel/v1/traces"
|
|
API_KEY = "<your-api-key>"
|
|
PROJECT_NAME = "<your-project-name>"
|
|
WORKSPACE_NAME = "<your-workspace-name>"
|
|
|
|
# Initialize the trace provider
|
|
provider = TracerProvider()
|
|
processor = BatchSpanProcessor(
|
|
OTLPSpanExporter(
|
|
endpoint=OPIK_ENDPOINT,
|
|
headers={
|
|
"Authorization": API_KEY,
|
|
"projectName": PROJECT_NAME,
|
|
"Comet-Workspace": WORKSPACE_NAME
|
|
}
|
|
)
|
|
)
|
|
provider.add_span_processor(processor)
|
|
trace.set_tracer_provider(provider)
|
|
```
|
|
|
|
<Tip>
|
|
In order to track OpenAI calls, you need to use the OpenTelemetry instrumentations
|
|
for OpenAI:
|
|
|
|
```bash wordWrap
|
|
pip install opentelemetry-instrumentation-openai
|
|
```
|
|
|
|
And then instrument your OpenAI client:
|
|
|
|
```python wordWrap
|
|
from opentelemetry.instrumentation.openai import OpenAIInstrumentor
|
|
|
|
OpenAIInstrumentor().instrument()
|
|
```
|
|
|
|
</Tip>
|
|
|
|
<Warning>
|
|
Make sure to import the `http` trace exporter (`opentelemetry.exporter.otlp.proto.http.trace_exporter`), if you use
|
|
the GRPC exporter you will face errors.
|
|
</Warning> |