Skip to content

docs: add OpenTelemetry reference - #659

Merged
ayushag-nv merged 3 commits into
mainfrom
nachiketb/docs-opentelemetry-reference
Sep 9, 2026
Merged

docs: add OpenTelemetry reference#659
ayushag-nv merged 3 commits into
mainfrom
nachiketb/docs-opentelemetry-reference

Conversation

@nachiketb-nvidia

@nachiketb-nvidia nachiketb-nvidia commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

What

Add a concise OpenTelemetry reference for libsy and its LLM client under Reference > OpenTelemetry, linked from Getting Started.

Why

Library users need one place to check emitted fields and metrics, without a general OpenTelemetry tutorial.

How

  • Explain host-owned collection and link to official OpenTelemetry setup docs.
  • List routing and model-call span attributes, types, and when they are present.
  • Document routing/client metrics and Stage Router and Advisor Gate instruments.
  • Explain streaming lifetimes and logical calls versus HTTP attempts.
  • State data-exposure limits without claiming all existing logs are redacted.
  • Link directly to implementation sources.

What to review

Check emitted names and types, metric timing/counting boundaries, and privacy wording. Library documentation only; no runtime behavior changes or new instrumentation.

Validation

  • Strict MkDocs build passed using locked docs dependencies in a temporary environment.
  • git diff --check passed.
  • No Rust or Python application tests run; documentation only.

Signed-off-by: nachiketb <nachiketb@nvidia.com>
@nachiketb-nvidia
nachiketb-nvidia requested a review from a team as a code owner September 9, 2026 23:11
@github-actions

github-actions Bot commented Sep 9, 2026

Copy link
Copy Markdown
PR Preview Action v1.8.1

🚀 View preview at
https://NVIDIA-NeMo.github.io/Switchyard/pr-preview/pr-659/

Built to branch gh-pages at 2026-09-09 23:25 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@coderabbitai

coderabbitai Bot commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

Review Change StackReview 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: Enterprise

Run ID: ff8618ba-1d69-494e-8ad1-be14f8cbe5e0

📥 Commits

Reviewing files that changed from the base of the PR and between 578e1b7 and 4a35bec.

📒 Files selected for processing (3)
  • docs/getting_started.md
  • docs/reference/opentelemetry.md
  • mkdocs.yml

Included review availability: Your plan provides up to 12 included reviews per hour; 10 remain after this review.


Walkthrough

The pull request adds an OpenTelemetry reference, exposes it in MkDocs navigation, and updates the getting-started observability link.

Changes

OpenTelemetry documentation

Layer / File(s) Summary
OpenTelemetry reference and documentation links
docs/reference/opentelemetry.md, mkdocs.yml, docs/getting_started.md
Adds OpenTelemetry documentation for configuration, tracing, metrics, endpoints, privacy boundaries, and source references. Adds the page to navigation and links to it from the getting-started guide.

Priority: ⬇️ Low

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

Merge Risk: ⚪ Minimal · up to 4a35b

This adds and links an OpenTelemetry reference without changing runtime behavior or telemetry configuration. No merge-blocking risk is identified.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: adding an OpenTelemetry reference to the documentation.

A rabbit reads spans in the moonlit glow
Metrics hop neatly in rows below
OTLP paths shine clear and bright
MkDocs guides them through the night
Documentation settles, crisp and light

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

Signed-off-by: nachiketb <nachiketb@nvidia.com>

@ayushag-nv ayushag-nv 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.

havn't read the entire doc. See if you can cut the lines , that will be good.

Signed-off-by: nachiketb <nachiketb@nvidia.com>
@ayushag-nv
ayushag-nv merged commit 8dc8911 into main Sep 9, 2026
16 checks passed
@ayushag-nv
ayushag-nv deleted the nachiketb/docs-opentelemetry-reference branch September 9, 2026 23:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants