fix: tracing in configs, clarify directions for simple web query#968
Conversation
Signed-off-by: Will Killian <wkillian@nvidia.com>
WalkthroughReorganized 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
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ 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)
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. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 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.ymlexamples/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.ymlexamples/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.ymlexamples/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
raisestatements to maintain the original stack trace,
and uselogger.error()(notlogger.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.txtfile, words that might appear to be
spelling mistakes but are listed in theci/vale/styles/config/vocabularies/nat/accept.txtfile 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.ymlexamples/advanced_agents/profiler_agent/src/nat_profiler_agent/configs/config.ymlexamples/observability/redact_pii/README.mdexamples/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 apyproject.tomlfile. Optionally, it might also contain scripts in ascripts/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 nameddata/, 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.ymlexamples/advanced_agents/profiler_agent/src/nat_profiler_agent/configs/config.ymlexamples/observability/redact_pii/README.mdexamples/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.mdexamples/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 forgeneral.telemetry.Moving tracing under
general.telemetry.tracinglooks good, but please double-check that all loaders still read from this new path (previous consumers looked undergeneral.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.ymlplaceholders.
Signed-off-by: Will Killian <wkillian@nvidia.com>
|
/merge |
Description
Closes
By Submitting this PR I confirm:
Summary by CodeRabbit