Skip to content

docs: document ComponentInputsPayload and ComponentIndexPayload on telemetry page#14051

Open
saitejabandaru-in wants to merge 1 commit into
langflow-ai:mainfrom
saitejabandaru-in:doc/telemetry-payload-completions
Open

docs: document ComponentInputsPayload and ComponentIndexPayload on telemetry page#14051
saitejabandaru-in wants to merge 1 commit into
langflow-ai:mainfrom
saitejabandaru-in:doc/telemetry-payload-completions

Conversation

@saitejabandaru-in

@saitejabandaru-in saitejabandaru-in commented Jul 13, 2026

Copy link
Copy Markdown

Resolves #14024.

Description

Currently, the contributing telemetry documentation does not list all telemetry events that Langflow collects, omitting ComponentInputsPayload and ComponentIndexPayload which are defined in schema.py.

Changes

  • Added documentation for Component inputs (ComponentInputsPayload) explaining that it sends component inputs during flow execution along with field details.
  • Added documentation for Component index (ComponentIndexPayload) detailing the loading metrics collected during component indexing.
  • Kept the telemetry document fully aligned and complete with the actual implementation schemas.

Summary by CodeRabbit

  • Documentation
    • Expanded telemetry documentation to include tenant identification details.
    • Added descriptions of telemetry collected for component inputs, including run metadata and chunking information.
    • Documented component indexing metrics, such as component counts, data sources, filtering details, and load times.

@coderabbitai

coderabbitai Bot commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: a3298db9-fc71-43ae-98f6-bbd81b4d2342

📥 Commits

Reviewing files that changed from the base of the PR and between def832f and a84e599.

📒 Files selected for processing (1)
  • docs/docs/Develop/contributing-telemetry.mdx

Walkthrough

The telemetry documentation restores the WxoTenantId field and adds descriptions for component input and component index telemetry events, including their collected identifiers, payload details, metrics, and timing data.

Changes

Telemetry documentation

Layer / File(s) Summary
Document additional telemetry events
docs/docs/Develop/contributing-telemetry.mdx
Restores WxoTenantId and documents component input payload fields and component index metrics.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Suggested reviewers: aimurphy, 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 clearly describes the main documentation update for the telemetry payloads.
Linked Issues check ✅ Passed The docs now cover ComponentInputsPayload and ComponentIndexPayload as requested in #14024.
Out of Scope Changes check ✅ Passed The added telemetry doc edits stay within the requested scope and do not introduce unrelated changes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Test Coverage For New Implementations ✅ Passed Docs-only PR: only contributing-telemetry.mdx changed, with no code or test files added/updated. Test coverage requirements don’t apply.
Test Quality And Coverage ✅ Passed PR only updates telemetry docs; no implementation or test files changed, so the test-quality check is not applicable.
Test File Naming And Structure ✅ Passed No test files were added or modified; the PR only updates a docs page, so test file naming/structure is not applicable.
Excessive Mock Usage Warning ✅ Passed Docs-only change; no test files or mock-heavy test code were modified.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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 documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Jul 13, 2026
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.

docs: telemetry page's event list omits component_inputs (which sends configured input values)

1 participant