Skip to content

docs: add an application observability page - #14335

Draft
ogabrielluiz wants to merge 2 commits into
release-1.12.0from
docs-application-observability
Draft

docs: add an application observability page#14335
ogabrielluiz wants to merge 2 commits into
release-1.12.0from
docs-application-observability

Conversation

@ogabrielluiz

@ogabrielluiz ogabrielluiz commented Jul 30, 2026

Copy link
Copy Markdown
Contributor

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:

  • The two-variable quickstart, and the lfx[otel] extra for standalone lfx.
  • What each signal actually measures: RED per endpoint, process-level runtime health, queue depth, the flow.execute span, and trace_id correlation.
  • The full OTEL_* configuration table, plus the local Prometheus option and why metrics are pushed rather than only scraped.
  • The stable HTTP semantic conventions rename, with a before/after table and the http/dup value for emitting both while migrating. Anyone with dashboards on http.server.duration needs this.

It also states the boundary plainly, including the parts that are easy to get wrong:

  • Prompts, completions, gen_ai token metrics and outbound LLM call spans do not reach the operator's backend.
  • The log channel is filtered by severity, not content, so an ERROR record can still carry flow-derived text.
  • session_id is 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

  • Documentation
    • Added guidance for monitoring Langflow application health and flow execution through OTLP observability.
    • Documented setup prerequisites, environment variables, supported signals, exported data, and privacy considerations.
    • Clarified that OTLP export is disabled unless an endpoint is configured.
    • Added the OTLP observability guide to the documentation navigation.

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.
@coderabbitai

coderabbitai Bot commented Jul 30, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 79b47b4f-90e9-410b-a0be-281b9a4057d2

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

Walkthrough

Changes

OTLP observability documentation

Layer / File(s) Summary
OTLP overview and setup
docs/docs/Develop/observability-otlp.mdx
Introduces application observability via OTLP, prerequisites, and the quickstart configuration and verification workflow.
Signals, configuration, and export boundaries
docs/docs/Develop/observability-otlp.mdx
Documents measurable signals, environment variables, OTLP metric delivery, exported data boundaries, filtering, and correlation warnings.
Metric migration and documentation navigation
docs/docs/Develop/observability-otlp.mdx, docs/sidebars.js
Describes HTTP semantic-convention migration and adds the new observability page to the documentation sidebar.

Estimated code review effort: 2 (Simple) | ~10 minutes

Suggested reviewers: mendonk

🚥 Pre-merge checks | ✅ 9
✅ Passed checks (9 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: adding an application observability documentation page.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Test Coverage For New Implementations ✅ Passed Docs-only PR: changed files are a new .mdx page and sidebar entry, with no code paths or test files added.
Test Quality And Coverage ✅ Passed Docs-only PR: only two documentation files changed, with no implementation or test code to evaluate for coverage.
Test File Naming And Structure ✅ Passed Changed test files use conventional names and structure (test_*.py, *.test.tsx, *.spec.ts) with descriptive pytest/Playwright cases; no naming issues found.
Excessive Mock Usage Warning ✅ Passed PR changes only docs/sidebar; no test files were modified, so mock usage is not applicable.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs-application-observability

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jul 30, 2026
@github-actions

Copy link
Copy Markdown
Contributor

✅ Test Coverage Advisor

No source changes detected without accompanying tests. Thanks for keeping coverage up! 🎉

Advisory check only — never blocks merge.

@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Jul 30, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2b20764 and 2a400d5.

📒 Files selected for processing (2)
  • docs/docs/Develop/observability-otlp.mdx
  • docs/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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 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

@github-actions

This comment has been minimized.

The repo's docs convention is title and slug only.
@ogabrielluiz
ogabrielluiz marked this pull request as draft July 30, 2026 20:10
@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Jul 30, 2026
@github-actions

github-actions Bot commented Jul 30, 2026

Copy link
Copy Markdown
Contributor

Build successful! ✅
Deploying docs draft.
Deploy successful! View draft

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant