docs: add an application observability page - #14335
Conversation
Documents the OTLP export surface for operators: the two-variable quickstart, what each signal measures, the standard OTEL_* configuration, and the local Prometheus option. States the boundary plainly, including the parts that are easy to get wrong: the log channel is filtered by severity rather than content, so an ERROR record can still carry flow-derived text, and session_id reaches the backend exactly as the caller supplies it. Also documents the stable HTTP semantic conventions rename, with a before/after table and the http/dup value for running both while migrating.
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
WalkthroughChangesOTLP observability documentation
Estimated code review effort: 2 (Simple) | ~10 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 9✅ Passed checks (9 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
✅ Test Coverage AdvisorNo source changes detected without accompanying tests. Thanks for keeping coverage up! 🎉
|
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/docs/Develop/observability-otlp.mdx`:
- Line 4: Remove the unsupported description frontmatter field from the
observability OTLP documentation page, leaving only the existing title and slug
fields in its frontmatter.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: 5cd486e9-fdca-4b48-a437-97cbf3d0ecf0
📒 Files selected for processing (2)
docs/docs/Develop/observability-otlp.mdxdocs/sidebars.js
| --- | ||
| title: Application observability | ||
| slug: /observability-otlp | ||
| description: Export Langflow's own request rate, error rate, latency, runtime health, and correlated logs to any OTLP backend. |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Remove the unsupported frontmatter field.
Line 4 violates the page-frontmatter convention; retain only title and slug.
As per coding guidelines, “Use only title and slug in frontmatter for Docusaurus pages; do not include description or sidebar_position.”
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/docs/Develop/observability-otlp.mdx` at line 4, Remove the unsupported
description frontmatter field from the observability OTLP documentation page,
leaving only the existing title and slug fields in its frontmatter.
Source: Coding guidelines
This comment has been minimized.
This comment has been minimized.
The repo's docs convention is title and slug only.
|
Build successful! ✅ |
Adds a docs page for the application observability surface introduced in #14213, so it should land after that one.
The code shipped with good docstrings, but operators do not read docstrings. The new page covers:
lfx[otel]extra for standalonelfx.flow.executespan, andtrace_idcorrelation.OTEL_*configuration table, plus the local Prometheus option and why metrics are pushed rather than only scraped.http/dupvalue for emitting both while migrating. Anyone with dashboards onhttp.server.durationneeds this.It also states the boundary plainly, including the parts that are easy to get wrong:
gen_aitoken metrics and outbound LLM call spans do not reach the operator's backend.ERRORrecord can still carry flow-derived text.session_idis exported exactly as the caller supplies it, so deployments using emails or usernames as session IDs will send those.Placed at the top level of the Observability sidebar next to Logs and Traces, rather than under Monitoring, since that subcategory is the LLM tracing vendors and this is the operator lens. The page says so up front and links across, so the two do not get conflated.
No code changes.
Summary by CodeRabbit