Skip to content

fix: tracing in configs, clarify directions for simple web query#968

Merged
rapids-bot[bot] merged 2 commits intoNVIDIA:release/1.3from
willkill07:wkk_improve-simple-web-query-eval-upload-and-telemetry-bugs
Oct 9, 2025
Merged

fix: tracing in configs, clarify directions for simple web query#968
rapids-bot[bot] merged 2 commits intoNVIDIA:release/1.3from
willkill07:wkk_improve-simple-web-query-eval-upload-and-telemetry-bugs

Conversation

@willkill07
Copy link
Member

@willkill07 willkill07 commented Oct 9, 2025

Description

Closes

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

  • New Features
    • Support environment-variable configuration for S3 endpoint, bucket, and credentials in eval_upload.yml (outputs and datasets).
  • Documentation
    • Expanded simple_web_query_eval README with S3/MinIO setup, required env vars, bucket creation, upload steps, and run command; adjusted headings.
    • Re-indented and clarified redact_pii YAML example in redact_pii README.
  • Refactor
    • Moved tracing configuration in profiler agent from general.tracing.phoenix to telemetry.tracing.phoenix (fields unchanged).

Signed-off-by: Will Killian <wkillian@nvidia.com>
@willkill07 willkill07 self-assigned this Oct 9, 2025
@willkill07 willkill07 requested a review from a team as a code owner October 9, 2025 20:33
@willkill07 willkill07 added bug Something isn't working non-breaking Non-breaking change labels Oct 9, 2025
@coderabbitai
Copy link

coderabbitai bot commented Oct 9, 2025

Walkthrough

Reorganized tracing config path in a profiler agent YAML, switched S3 settings in an evaluation upload config to environment-variable substitutions, expanded README with detailed S3/MinIO setup and commands, and reformatted a redact-PII YAML example in an observability README. No code logic changes.

Changes

Cohort / File(s) Summary of changes
Configuration: telemetry tracing path
examples/advanced_agents/profiler_agent/src/nat_profiler_agent/configs/config.yml
Moves tracing config from general.tracing.phoenix to telemetry.tracing.phoenix; retains _type, endpoint, and project fields.
Configuration: S3 env-var substitutions
examples/evaluation_and_profiling/simple_web_query_eval/src/nat_simple_web_query_eval/configs/eval_upload.yml
Replaces hardcoded S3 credentials with environment-variable substitutions (${S3_ENDPOINT_URL:-null}, ${S3_BUCKET_NAME}, ${AWS_ACCESS_KEY_ID}, ${AWS_SECRET_ACCESS_KEY}) for both output.s3 and dataset.s3.
Documentation: evaluation workflow expansion
examples/evaluation_and_profiling/simple_web_query_eval/README.md
Adds detailed S3/MinIO setup and usage: AWS CLI recommendations, new env vars (S3_ENDPOINT_URL, S3_BUCKET_NAME, AWS creds), bucket creation and upload commands, reorganized headings, and explicit evaluation run instructions.
Documentation: YAML formatting (redact PII)
examples/observability/redact_pii/README.md
Re-indents and reorganizes redact-PII YAML example: promotes redact_keys and formats redact_pii_fields as a proper list; no semantic changes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 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 concisely captures both the tracing configuration fix and the clarification of simple web query instructions using imperative verbs, and remains under the 72-character limit while clearly reflecting the PR’s main objectives.
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 00383c0 and c14ef1d.

📒 Files selected for processing (1)
  • examples/observability/redact_pii/README.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • examples/observability/redact_pii/README.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: CI Pipeline / Check

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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 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 bba10c7 and 00383c0.

📒 Files selected for processing (4)
  • examples/advanced_agents/profiler_agent/src/nat_profiler_agent/configs/config.yml (1 hunks)
  • examples/evaluation_and_profiling/simple_web_query_eval/README.md (1 hunks)
  • examples/evaluation_and_profiling/simple_web_query_eval/src/nat_simple_web_query_eval/configs/eval_upload.yml (1 hunks)
  • examples/observability/redact_pii/README.md (1 hunks)
🧰 Additional context used
📓 Path-based instructions (6)
**/*.{yaml,yml}

📄 CodeRabbit inference engine (.cursor/rules/nat-test-llm.mdc)

In workflow/config YAML, set llms.._type: nat_test_llm to stub responses.

Files:

  • examples/evaluation_and_profiling/simple_web_query_eval/src/nat_simple_web_query_eval/configs/eval_upload.yml
  • examples/advanced_agents/profiler_agent/src/nat_profiler_agent/configs/config.yml
**/*.{py,yaml,yml}

📄 CodeRabbit inference engine (.cursor/rules/nat-test-llm.mdc)

**/*.{py,yaml,yml}: Configure response_seq as a list of strings; values cycle per call, and [] yields an empty string.
Configure delay_ms to inject per-call artificial latency in milliseconds for nat_test_llm.

Files:

  • examples/evaluation_and_profiling/simple_web_query_eval/src/nat_simple_web_query_eval/configs/eval_upload.yml
  • examples/advanced_agents/profiler_agent/src/nat_profiler_agent/configs/config.yml
**/configs/**

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

Configuration files consumed by code must be stored next to that code in a configs/ folder

Files:

  • examples/evaluation_and_profiling/simple_web_query_eval/src/nat_simple_web_query_eval/configs/eval_upload.yml
  • examples/advanced_agents/profiler_agent/src/nat_profiler_agent/configs/config.yml
**/*

⚙️ 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:

  • examples/evaluation_and_profiling/simple_web_query_eval/src/nat_simple_web_query_eval/configs/eval_upload.yml
  • examples/advanced_agents/profiler_agent/src/nat_profiler_agent/configs/config.yml
  • examples/observability/redact_pii/README.md
  • examples/evaluation_and_profiling/simple_web_query_eval/README.md
examples/**/*

⚙️ CodeRabbit configuration file

examples/**/*: - This directory contains example code and usage scenarios for the toolkit, at a minimum an example should
contain a README.md or file README.ipynb.

  • If an example contains Python code, it should be placed in a subdirectory named src/ and should
    contain a pyproject.toml file. Optionally, it might also contain scripts in a scripts/ directory.
  • If an example contains YAML files, they should be placed in a subdirectory named configs/. - If an example contains sample data files, they should be placed in a subdirectory named data/, and should
    be checked into git-lfs.

Files:

  • examples/evaluation_and_profiling/simple_web_query_eval/src/nat_simple_web_query_eval/configs/eval_upload.yml
  • examples/advanced_agents/profiler_agent/src/nat_profiler_agent/configs/config.yml
  • examples/observability/redact_pii/README.md
  • examples/evaluation_and_profiling/simple_web_query_eval/README.md
**/README.@(md|ipynb)

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

Ensure READMEs follow the naming convention; avoid deprecated names; use “NeMo Agent Toolkit” (capital T) in headings

Files:

  • examples/observability/redact_pii/README.md
  • examples/evaluation_and_profiling/simple_web_query_eval/README.md
🪛 markdownlint-cli2 (0.18.1)
examples/evaluation_and_profiling/simple_web_query_eval/README.md

126-126: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


134-134: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

🔇 Additional comments (3)
examples/advanced_agents/profiler_agent/src/nat_profiler_agent/configs/config.yml (1)

18-23: Confirm downstream support for general.telemetry.

Moving tracing under general.telemetry.tracing looks good, but please double-check that all loaders still read from this new path (previous consumers looked under general.tracing).

examples/evaluation_and_profiling/simple_web_query_eval/src/nat_simple_web_query_eval/configs/eval_upload.yml (1)

74-87: Environment placeholders look right.

Adopting env-var substitutions for the S3 credentials improves portability and aligns with the updated docs.

examples/evaluation_and_profiling/simple_web_query_eval/README.md (1)

118-161: Markdown formatting is clear and matches config guidance.

The new S3/MinIO setup instructions are thorough and stay consistent with the updated eval_upload.yml placeholders.

Signed-off-by: Will Killian <wkillian@nvidia.com>
@dagardner-nv
Copy link
Contributor

/merge

@rapids-bot rapids-bot bot merged commit aceca38 into NVIDIA:release/1.3 Oct 9, 2025
27 of 28 checks passed
@willkill07 willkill07 deleted the wkk_improve-simple-web-query-eval-upload-and-telemetry-bugs branch October 23, 2025 18:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working non-breaking Non-breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants