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
146 lines
4.7 KiB
Plaintext
146 lines
4.7 KiB
Plaintext
---
|
|
description: Configure OpenAI Codex OpenTelemetry export to send trace telemetry to Opik.
|
|
headline: OpenAI Codex | Opik Documentation
|
|
og:description: OpenAI Codex supports opt-in OpenTelemetry export via config.toml; this guide maps Codex settings to Opik endpoints.
|
|
og:site_name: Opik Documentation
|
|
og:title: OpenAI Codex Integration - Opik
|
|
title: Observability for OpenAI Codex with Opik
|
|
---
|
|
|
|
[OpenAI Codex](https://developers.openai.com/codex) supports opt-in OpenTelemetry export through Codex configuration files.
|
|
|
|
## When this guide applies
|
|
|
|
Use this guide if you run Codex (CLI/IDE/app) and want its OTEL trace exporter to send telemetry to Opik.
|
|
|
|
<Callout type="info">
|
|
The block structure below follows the current Codex runtime config shape used in local `config.toml` (`[otel.trace_exporter.otlp-http]`).
|
|
</Callout>
|
|
|
|
## Where to configure Codex
|
|
|
|
Codex reads configuration from:
|
|
- user config: `~/.codex/config.toml`
|
|
- project config: `.codex/config.toml`
|
|
|
|
See [Codex config basics](https://developers.openai.com/codex/config-basic).
|
|
|
|
## Opik OTLP trace endpoint modes
|
|
|
|
For Opik OTEL endpoint behavior, see [Opik OpenTelemetry overview](/integrations/opentelemetry).
|
|
|
|
<Tabs>
|
|
<Tab value="Opik Cloud" title="Opik Cloud">
|
|
```toml
|
|
[otel]
|
|
# Optional environment label in Codex telemetry
|
|
trace_exporter = "otlp-http"
|
|
environment = "prod"
|
|
log_user_prompt = false
|
|
|
|
[otel.trace_exporter.otlp-http]
|
|
endpoint = "https://www.comet.com/opik/api/v1/private/otel/v1/traces"
|
|
protocol = "binary"
|
|
headers = { "Authorization" = "<your-api-key>", "Comet-Workspace" = "<your-workspace>", "projectName" = "<your-project-name>" }
|
|
```
|
|
|
|
Required headers:
|
|
- `Authorization`
|
|
- `Comet-Workspace`
|
|
|
|
Optional headers:
|
|
- `projectName` (recommended)
|
|
</Tab>
|
|
<Tab value="Enterprise deployment" title="Enterprise deployment">
|
|
```toml
|
|
[otel]
|
|
trace_exporter = "otlp-http"
|
|
environment = "prod"
|
|
log_user_prompt = false
|
|
|
|
[otel.trace_exporter.otlp-http]
|
|
endpoint = "https://<comet-deployment-url>/opik/api/v1/private/otel/v1/traces"
|
|
protocol = "binary"
|
|
headers = { "Authorization" = "<your-api-key>", "Comet-Workspace" = "<your-workspace>", "projectName" = "<your-project-name>" }
|
|
```
|
|
|
|
Required headers:
|
|
- `Authorization`
|
|
- `Comet-Workspace`
|
|
|
|
Optional headers:
|
|
- `projectName` (recommended)
|
|
</Tab>
|
|
<Tab value="Self-hosted instance" title="Self-hosted instance">
|
|
```toml
|
|
[otel]
|
|
trace_exporter = "otlp-http"
|
|
environment = "prod"
|
|
log_user_prompt = false
|
|
|
|
[otel.trace_exporter.otlp-http]
|
|
endpoint = "http://localhost:5173/api/v1/private/otel/v1/traces"
|
|
protocol = "binary"
|
|
headers = { "projectName" = "<your-project-name>" }
|
|
```
|
|
|
|
Required headers:
|
|
- none by default (depends on your self-hosted auth setup)
|
|
|
|
Optional headers:
|
|
- `projectName` (recommended)
|
|
- auth headers if your instance enforces auth
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
## Example intent and minimal valid setup
|
|
|
|
Intent:
|
|
Route Codex OTEL trace export to Opik with project/workspace attribution.
|
|
|
|
Applies when:
|
|
You have enabled Codex OTEL export and selected OTLP/HTTP exporter in config.
|
|
|
|
Required fields:
|
|
- `trace_exporter = "otlp-http"` under `[otel]`
|
|
- `otel.trace_exporter` exporter block (`otlp-http`)
|
|
- `endpoint`
|
|
- `protocol` (`binary` or `json`, binary recommended)
|
|
|
|
Optional fields:
|
|
- `headers` (`projectName` strongly recommended)
|
|
- `otel.environment`
|
|
- `otel.log_user_prompt` (keep `false` unless policy allows prompt export)
|
|
|
|
Minimal valid config:
|
|
|
|
```toml
|
|
[otel]
|
|
trace_exporter = "otlp-http"
|
|
log_user_prompt = false
|
|
|
|
[otel.trace_exporter.otlp-http]
|
|
endpoint = "https://www.comet.com/opik/api/v1/private/otel/v1/traces"
|
|
protocol = "binary"
|
|
headers = { "Authorization" = "<your-api-key>", "Comet-Workspace" = "<your-workspace>", "projectName" = "<your-project-name>" }
|
|
```
|
|
|
|
## Validation
|
|
|
|
1. Run a Codex session after updating `config.toml`.
|
|
2. Confirm OTLP HTTP requests are sent to `/otel/v1/traces`.
|
|
3. Verify traces appear in the expected Opik workspace/project.
|
|
|
|
## Notes
|
|
|
|
- Codex telemetry export is opt-in.
|
|
- Keep `log_user_prompt = false` unless your policy explicitly allows prompt text export.
|
|
- If your Codex build uses a different exporter key path, align with your installed version's config reference.
|
|
|
|
## Source references
|
|
|
|
- [Codex security and OTEL opt-in](https://developers.openai.com/codex/security/)
|
|
- [Codex config basics](https://developers.openai.com/codex/config-basic)
|
|
- [Codex config reference](https://developers.openai.com/codex/config-reference)
|
|
- [Opik OpenTelemetry overview](/integrations/opentelemetry)
|