Skip to content

docs(skills): update typed OpenTelemetry guidance#557

Draft
willkill07 wants to merge 1 commit into
mainfrom
docs/opentelemetry-skills
Draft

docs(skills): update typed OpenTelemetry guidance#557
willkill07 wants to merge 1 commit into
mainfrom
docs/opentelemetry-skills

Conversation

@willkill07

Copy link
Copy Markdown
Member

Overview

Updates the public observability skills for the typed OpenTelemetry endpoint model introduced by #556. This follow-up is intentionally isolated from the breaking implementation and should merge after #556.

  • I confirm this contribution is my own work, or I have the right to submit it under this project's license.
  • I searched existing issues and open pull requests, and this does not duplicate existing work.

Details

  • Reframes the observability skill around typed OpenTelemetry projections: full, gen_ai, and openinference.
  • Replaces standalone OpenInference configuration and subscriber guidance with OpenTelemetryConfig, OpenTelemetrySubscriber, and type = "openinference".
  • Documents fixed projection behavior, deterministic Relay-derived trace and span IDs, exporter-owned gRPC runtime behavior, and per-endpoint header_env secret injection.
  • Updates observability eval expectations and troubleshooting guidance for the unified endpoint model.
  • Bumps public ATOF and CLI skill examples to observability configuration version 3.
  • Aligns the skills index, skill card, debug guidance, and projection references with the breaking API and configuration changes in feat(observability)!: unify OpenTelemetry exporters #556.

Where should the reviewer start?

Start with skills/nemo-relay-plugin-observability/SKILL.md, then review skills/nemo-relay-plugin-observability/references/opentelemetry.md and skills/nemo-relay-plugin-observability/references/openinference.md for the updated public workflow and projection-specific guidance.

Validation performed on commit f02e7abf:

git diff --check
uv run pre-commit run --files <nine changed skills files>

All targeted hooks passed, including JSON validation and documentation link checking.

Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)

Signed-off-by: Will Killian <wkillian@nvidia.com>
@coderabbitai

coderabbitai Bot commented Jul 25, 2026

Copy link
Copy Markdown

Important

Review skipped

Draft detected.

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: ASSERTIVE

Plan: Enterprise

Run ID: 36652bc1-749e-42db-af6a-caa28f5f1f2a

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
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/opentelemetry-skills

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

@github-actions github-actions Bot added size:M PR is medium Documentation documentation-related labels Jul 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation documentation-related size:M PR is medium

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant