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
140 lines
6.4 KiB
Plaintext
140 lines
6.4 KiB
Plaintext
---
|
|
headline: Observability Overview | Opik Documentation
|
|
og:description: Monitor, debug, and optimize your LLM applications with Opik's observability
|
|
platform for traces, spans, and conversations
|
|
og:site_name: Opik Documentation
|
|
og:title: Observability Overview — Opik
|
|
title: Observability Overview
|
|
---
|
|
|
|
<Tip>
|
|
If you want to jump straight to code, head to the [Getting started](/tracing/getting-started) guide to add tracing in under five minutes.
|
|
</Tip>
|
|
|
|
LLM applications are more than a single API call. A typical agent involves retrieval steps, tool calls, prompt assembly, multiple LLM invocations, and post-processing — all wired together in ways that are invisible at runtime. When something goes wrong, you need to see exactly what happened at every step.
|
|
|
|
Opik gives you full visibility into every request your agent handles. Every LLM call, every tool invocation, every retrieval step is captured as a trace you can inspect, search, and analyze.
|
|
|
|
<Frame>
|
|
<img src="/img/v2/observability/traces_overview.png" />
|
|
</Frame>
|
|
|
|
## Why use Opik for observability
|
|
|
|
Debugging LLM applications without observability means guessing. You see the final output but not why the model hallucinated, which retrieval step returned irrelevant context, or where latency spiked.
|
|
|
|
With Opik, you can:
|
|
|
|
- **See the full execution path** of every request — from user input through tool calls and LLM completions to the final response
|
|
- **Root-cause production issues fast** — filter and search traces by status, latency, cost, or custom tags to find the problem in seconds
|
|
- **Track costs and latency over time** — monitor token usage and spending across models and providers
|
|
- **Capture multi-turn conversations** — group related traces into threads to understand how interactions evolve across turns
|
|
- **Close the feedback loop** — attach human or automated scores to traces and use them to drive evaluations
|
|
|
|
## What you can capture
|
|
|
|
<CardGroup cols={3}>
|
|
<Card title="Traces & spans" href="/tracing/concepts" icon="fa-regular fa-diagram-project">
|
|
Full execution trees with inputs, outputs, timing, and metadata for every step
|
|
</Card>
|
|
<Card title="Conversations" href="/tracing/advanced/log_chat_conversations" icon="fa-regular fa-comments">
|
|
Multi-turn threads that group related traces into coherent sessions
|
|
</Card>
|
|
<Card title="Cost tracking" href="/tracing/advanced/cost_tracking" icon="fa-regular fa-dollar-sign">
|
|
Token usage and spending broken down by model, provider, and trace
|
|
</Card>
|
|
<Card title="Media & attachments" href="/tracing/advanced/log_multimodal_traces" icon="fa-regular fa-image">
|
|
Images, audio, video, and files logged alongside your traces
|
|
</Card>
|
|
<Card title="User feedback" href="/tracing/advanced/annotate_traces" icon="fa-regular fa-thumbs-up">
|
|
Qualitative and quantitative scores attached to individual traces
|
|
</Card>
|
|
<Card title="Agent graphs" href="/tracing/advanced/log_agent_graphs" icon="fa-regular fa-share-nodes">
|
|
Visual execution graphs showing how your agent's steps connect
|
|
</Card>
|
|
</CardGroup>
|
|
|
|
## How it works
|
|
|
|
<Steps>
|
|
<Step title="Connect your project">
|
|
Run `opik connect` from your agent's directory to pair it with Opik:
|
|
|
|
```bash
|
|
opik connect --project <YOUR_PROJECT_NAME>
|
|
```
|
|
</Step>
|
|
<Step title="Instrument your code">
|
|
The fastest way to add tracing is with [opik-skills](https://github.com/comet-ml/opik-skills) — install the skill and let your coding agent handle the rest:
|
|
|
|
```bash
|
|
npx skills add comet-ml/opik-skills
|
|
```
|
|
|
|
Then ask your coding agent:
|
|
|
|
```
|
|
Instrument my agent with Opik using the /instrument command.
|
|
```
|
|
|
|
This works with Claude Code, Cursor, Codex, OpenCode, and other coding agents. You can also instrument manually with the SDK:
|
|
|
|
<CodeBlocks>
|
|
```python title="Python"
|
|
import opik
|
|
|
|
@opik.track
|
|
def my_agent(user_message):
|
|
context = retrieve_context(user_message)
|
|
response = call_llm(user_message, context)
|
|
return response
|
|
```
|
|
|
|
```ts title="TypeScript"
|
|
import { Opik } from "opik";
|
|
const client = new Opik();
|
|
|
|
const myAgent = client.track({
|
|
name: "my-agent",
|
|
fn: async (userMessage: string) => {
|
|
const context = await retrieveContext(userMessage);
|
|
return await callLlm(userMessage, context);
|
|
},
|
|
});
|
|
```
|
|
</CodeBlocks>
|
|
</Step>
|
|
<Step title="View traces in the dashboard">
|
|
Every request creates a trace with detailed span-level information. You can inspect the full execution tree, see inputs and outputs at each step, and filter by duration, cost, status, or tags.
|
|
|
|
<Frame>
|
|
<img src="/img/v2/home/traces_page_for_quickstart.png" />
|
|
</Frame>
|
|
</Step>
|
|
<Step title="Analyze and improve">
|
|
Use traces to debug failures, identify slow steps, and track quality over time. Attach feedback scores, run evaluations against datasets, and use [Ollie](/tracing/debug-agents) — Opik's AI assistant — to help root-cause issues automatically.
|
|
</Step>
|
|
</Steps>
|
|
|
|
## Integrations
|
|
|
|
Opik has first-class support for 30+ frameworks in Python, TypeScript, and OpenTelemetry — so you can start capturing traces without changing how your application is built.
|
|
|
|
<CardGroup cols={3}>
|
|
<Card title="LangChain" href="/integrations/langchain" icon={<img src="/img/tracing/langchain.svg" />} iconPosition="left"/>
|
|
<Card title="LlamaIndex" href="/integrations/llama_index" icon={<img src="/img/tracing/llamaindex.svg" />} iconPosition="left"/>
|
|
<Card title="Anthropic" href="/integrations/anthropic" icon={<img src="/img/tracing/anthropic.svg" />} iconPosition="left"/>
|
|
<Card title="AWS Bedrock" href="/integrations/bedrock" icon={<img src="/img/tracing/bedrock.svg" />} iconPosition="left"/>
|
|
<Card title="Google Gemini" href="/integrations/gemini" icon={<img src="/img/tracing/gemini.svg" />} iconPosition="left"/>
|
|
<Card title="CrewAI" href="/integrations/crewai" icon={<img src="/img/tracing/crewai.svg" />} iconPosition="left"/>
|
|
</CardGroup>
|
|
|
|
**[View all integrations →](/integrations/overview)**
|
|
|
|
## Next steps
|
|
|
|
- [Getting started](/tracing/getting-started) — Add observability to your agent in minutes
|
|
- [Concepts](/tracing/concepts) — Understand traces, spans, threads, and feedback scores
|
|
- [Debugging agents with Ollie](/tracing/debug-agents) — Use AI-assisted root-cause analysis
|
|
- [Cost tracking](/tracing/advanced/cost_tracking) — Monitor token usage and spending
|