Skip to content

docs: document observability provider support by providers#1060

Merged
rapids-bot[bot] merged 1 commit intoNVIDIA:release/1.3from
willkill07:wkk_document-observability-support-by-providers
Oct 21, 2025
Merged

docs: document observability provider support by providers#1060
rapids-bot[bot] merged 1 commit intoNVIDIA:release/1.3from
willkill07:wkk_document-observability-support-by-providers

Conversation

@willkill07
Copy link
Member

@willkill07 willkill07 commented Oct 21, 2025

Description

Detail observability support by providers

Closes nvbugs-5452930

By Submitting this PR I confirm:

  • I am familiar with the Contributing Guidelines.
  • We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license.
    • Any contribution which contains commits that are not Signed-Off will not be accepted.
  • When the PR is ready for review, new or existing tests cover these changes.
  • When the PR is ready for review, the documentation is up to date with these changes.

Summary by CodeRabbit

  • Documentation
    • Added "Observability Support by Providers" section with a feature matrix displaying provider capabilities including Logging, Tracing, Redaction, and Evaluation Metrics support.

Signed-off-by: Will Killian <wkillian@nvidia.com>
@willkill07 willkill07 requested a review from a team as a code owner October 21, 2025 19:16
@coderabbitai
Copy link

coderabbitai bot commented Oct 21, 2025

Walkthrough

A provider-feature table was added to the observability documentation, detailing which providers support logging and tracing capabilities. The W&B Weave provider includes additional features for redaction and evaluation metrics. This is a documentation-only change with no code or exported entity modifications.

Changes

Cohort / File(s) Summary
Documentation Enhancement
docs/source/workflows/observe/index.md
Added new "Observability Support by Providers" section with a table mapping providers (e.g., W&B Weave) to supported features (Logging, Tracing, Redaction, Evaluation Metrics)

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title "docs: document observability provider support by providers" meets the specified requirements. It is concise at 58 characters, well under the 72-character limit, and uses imperative mood with the action verb "document." The title is fully descriptive and directly related to the changeset, which adds documentation of a provider-feature table detailing observability support across different providers in the documentation file. The prefix "docs:" clearly indicates this is a documentation change, and the descriptive portion accurately summarizes the main objective of the PR.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5173df6 and 0ca6424.

📒 Files selected for processing (1)
  • docs/source/workflows/observe/index.md (1 hunks)
🧰 Additional context used
📓 Path-based instructions (3)
docs/source/**/*.md

📄 CodeRabbit inference engine (.cursor/rules/general.mdc)

docs/source/**/*.md: Use the official naming throughout documentation: first use “NVIDIA NeMo Agent toolkit”, subsequent “NeMo Agent toolkit”; never use deprecated names (Agent Intelligence toolkit, aiqtoolkit, AgentIQ, AIQ/aiq)
Documentation sources are Markdown files under docs/source; images belong in docs/source/_static
Keep docs in sync with code; documentation pipeline must pass Sphinx and link checks; avoid TODOs/FIXMEs/placeholders; avoid offensive/outdated terms; ensure spelling correctness
Do not use words listed in ci/vale/styles/config/vocabularies/nat/reject.txt; accepted terms in accept.txt are allowed

Files:

  • docs/source/workflows/observe/index.md
**/*

⚙️ CodeRabbit configuration file

**/*: # Code Review Instructions

  • Ensure the code follows best practices and coding standards. - For Python code, follow
    PEP 20 and
    PEP 8 for style guidelines.
  • Check for security vulnerabilities and potential issues. - Python methods should use type hints for all parameters and return values.
    Example:
    def my_function(param1: int, param2: str) -> bool:
        pass
  • For Python exception handling, ensure proper stack trace preservation:
    • When re-raising exceptions: use bare raise statements to maintain the original stack trace,
      and use logger.error() (not logger.exception()) to avoid duplicate stack trace output.
    • When catching and logging exceptions without re-raising: always use logger.exception()
      to capture the full stack trace information.

Documentation Review Instructions - Verify that documentation and comments are clear and comprehensive. - Verify that the documentation doesn't contain any TODOs, FIXMEs or placeholder text like "lorem ipsum". - Verify that the documentation doesn't contain any offensive or outdated terms. - Verify that documentation and comments are free of spelling mistakes, ensure the documentation doesn't contain any

words listed in the ci/vale/styles/config/vocabularies/nat/reject.txt file, words that might appear to be
spelling mistakes but are listed in the ci/vale/styles/config/vocabularies/nat/accept.txt file are OK.

Misc. - All code (except .mdc files that contain Cursor rules) should be licensed under the Apache License 2.0,

and should contain an Apache License 2.0 header comment at the top of each file.

  • Confirm that copyright years are up-to date whenever a file is changed.

Files:

  • docs/source/workflows/observe/index.md
docs/source/**/*

⚙️ CodeRabbit configuration file

This directory contains the source code for the documentation. All documentation should be written in Markdown format. Any image files should be placed in the docs/source/_static directory.

Files:

  • docs/source/workflows/observe/index.md
🔇 Additional comments (1)
docs/source/workflows/observe/index.md (1)

148-162: Provider-feature table is well-structured and comprehensive.

The new observability support table clearly documents which features each provider supports. All 10 providers listed are consistent with the earlier tracing exporters list (lines 133–144), and the feature column accurately reflects logging and tracing support across the ecosystem. The W&B Weave row appropriately highlights its additional capabilities (Redaction and Evaluation Metrics).

Please verify that the feature support matrix in the table accurately reflects the current code implementation for each provider, particularly the W&B Weave additional features (Redaction and Evaluation Metrics).


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 and usage tips.

@willkill07 willkill07 added doc Improvements or additions to documentation non-breaking Non-breaking change labels Oct 21, 2025
@willkill07 willkill07 self-assigned this Oct 21, 2025
@willkill07
Copy link
Member Author

/merge

@rapids-bot rapids-bot bot merged commit 7d1e477 into NVIDIA:release/1.3 Oct 21, 2025
17 checks passed
@willkill07 willkill07 deleted the wkk_document-observability-support-by-providers branch October 23, 2025 18:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Improvements or additions to documentation non-breaking Non-breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants