Files
comet-ml--opik/apps/opik-documentation/documentation/fern/docs-v2/observability/diagnostics.mdx
T
wehub-resource-sync 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
chore: import upstream snapshot with attribution
2026-07-13 13:25:44 +08:00

83 lines
3.7 KiB
Plaintext

---
headline: Diagnostics | Opik Documentation
og:description: Opik Diagnostics automatically scans your project's traces with
Ollie and surfaces recurring agent issues, complete with root cause, a suggested
fix, and affected traces.
og:site_name: Opik Documentation
og:title: Diagnostics - Opik
title: Diagnostics
---
Skimming traces for recurring failures doesn't scale once your agent is handling real traffic. Diagnostics scans your project's traces on a schedule, groups repeated failures into a single issue, and surfaces a root cause, a suggested fix, and the traces to prove it, so you catch problems before your users report them.
<Frame>
<img src="/img/v2/observability/diagnostics-overview.png" alt="Diagnostics page showing a detected issue with summary and Ollie fix" />
</Frame>
## How it works
Diagnostics is powered by Ollie, so it doesn't rely on fixed rules or thresholds. It reads full
traces the same way you would, looking for patterns like tool-call loops, malformed API calls,
hallucinated outputs, or latency regressions.
- **Daily scans:** once enabled, Opik automatically scans each project's traces from the last 24
hours every day at 00:05 UTC.
- **On-demand scans:** click **Run diagnostic** at any time to analyze the last 24 hours
immediately, without waiting for the daily schedule.
- **Deduplicated issues:** matching failures across traces are grouped into a single issue rather
than reported one by one, so a bug that shows up in 40 traces still only needs one fix.
<Note>
Diagnostics requires the Ollie AI assistant to be enabled for your workspace. Scans run on your
Ollie tokens, see the settings dialog for billing details.
</Note>
## Turning on diagnostics
The first time you open a project's **Diagnostics** page, you'll be prompted to turn it on. Once
enabled, a scan kicks off immediately, and then runs automatically every day.
## Reviewing issues
Each issue in the list shows its severity (`critical`, `high`, `medium`, or `low`), how many times
it's occurred, and when it was last seen, so you can sort and prioritize before opening any single
issue.
Opening an issue shows:
- **First seen / last seen** and **occurrences** (total and in the latest scan)
- **Users impacted**
- **Summary:** what Ollie found, in plain language
- **Ollie fix:** the likely root cause and a suggested fix, with a **Continue with Ollie** button
that hands off to the Ollie chat sidebar to dig deeper or apply a code fix directly
- **Occurrence over time:** a chart of how often the issue has fired since it was first detected
- **Affected traces sample:** a handful of traces that show the issue, linking directly to the
trace view
<Frame>
<img src="/img/v2/observability/diagnostics-ollie-fix.png" alt="Occurrence over time chart and affected traces sample for a diagnostics issue" />
</Frame>
## Resolving issues
Once you've fixed the underlying problem, click **Resolve** on the issue. Resolved issues move to
the **Resolved issues** page, where you can reopen them at any time if the pattern comes back.
## Settings
Use the settings icon next to **Run diagnostic** to turn the daily automated scan on or off. This
doesn't affect on-demand scans: you can still click **Run diagnostic** manually while automated
scans are paused.
<Frame>
<img src="/img/v2/observability/diagnostics-settings.png" alt="Diagnostics settings dialog with daily scan toggle" />
</Frame>
## Next steps
- [Ollie overview](/ollie): what Ollie can do and how to set it up
- [Debugging agents with Ollie](/tracing/debug-agents): take a single failing trace from root
cause to verified fix
- [Alerts](/production/alerts/alerts): get notified in Slack, PagerDuty, or a custom webhook for
specific events