[None][chore] Add unittest for otlp tracing #8716
Conversation
📝 WalkthroughWalkthroughA new test module introduces end-to-end tracing validation for RemoteOpenAIServer. It implements a fake in-process gRPC TraceService, provides fixtures for server setup and client creation, supplies OpenTelemetry attribute decoding utilities, and includes a comprehensive test verifying trace export correctness. Changes
Sequence DiagramsequenceDiagram
participant Test as test_tracing
participant Client as OpenAI Client
participant Server as RemoteOpenAIServer
participant OTLP as FakeTraceService
Test->>Server: Fixture: Start server with OTLP endpoint
Test->>Client: Fixture: Create client
Test->>Client: Send chat completion request
Client->>Server: POST /v1/chat/completions
activate Server
Server->>Server: Process request
Server->>OTLP: Export trace (async)
OTLP->>OTLP: Record export request & signal event
Server-->>Client: Return completion response
deactivate Server
Client-->>Test: Response with id, choice, content
Test->>Test: Validate response structure
Test->>OTLP: Wait for trace export (with timeout)
Test->>Test: Decode trace attributes<br/>(usage, temperature, top_p, latency)
Test->>Test: Assert all expected attributes present
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes
Pre-merge checks and finishing touches❌ Failed checks (2 warnings)
✅ Passed checks (1 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🧹 Nitpick comments (6)
tests/unittest/others/test_tracing.py (6)
75-96: Use a unique NamedTemporaryFile to avoid cross-test collisions.Writing to a fixed path in the OS temp dir is racy under parallel runs. Use NamedTemporaryFile(delete=False).
-@pytest.fixture(scope="module") -def temp_extra_llm_api_options_file(request): - temp_dir = tempfile.gettempdir() - temp_file_path = os.path.join(temp_dir, "extra_llm_api_options.yaml") +@pytest.fixture(scope="module") +def temp_extra_llm_api_options_file(_request): + tmp = tempfile.NamedTemporaryFile("w", delete=False, suffix=".yaml") + temp_file_path = tmp.name try: extra_llm_api_options_dict = { @@ - with open(temp_file_path, 'w') as f: - yaml.dump(extra_llm_api_options_dict, f) + yaml.dump(extra_llm_api_options_dict, tmp) + tmp.close() @@ finally: if os.path.exists(temp_file_path): os.remove(temp_file_path)
37-41: Silence ruff ARG002/ARG001: underscore unused args.Rename unused parameters to underscore to keep linters green.
-def Export(self, request, context): +def Export(self, request, _context): @@ -def temp_extra_llm_api_options_file(request): +def temp_extra_llm_api_options_file(_request):Also applies to: 76-76
131-131: Shorten exception messages to satisfy TRY003 and improve clarity.Keep messages concise; the assertion context already provides details.
- raise ValueError(f"Couldn't decode value: {value}") + raise ValueError("Unsupported AnyValue type") @@ - if not trace_service.evt.wait(timeout): - raise TimeoutError( - f"The fake trace service didn't receive a trace within " - f"the {timeout} seconds timeout") + if not trace_service.evt.wait(timeout): + raise TimeoutError("No trace received before timeout")Also applies to: 184-191
24-26: Logger is unused. Remove or log a debug line.Keep the module clean or emit a targeted debug message during setup.
143-146: Unused async_client fixture.If not used in this module, consider dropping to speed up collection; reintroduce when needed.
115-127: Optional: support more OTLP AnyValue kinds.If you later need kvlist_value or bytes_value, extend decode_value accordingly.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
tests/unittest/others/test_tracing.py(1 hunks)
🧰 Additional context used
📓 Path-based instructions (3)
**/*.{h,hpp,hh,hxx,cpp,cxx,cc,cu,cuh,py}
📄 CodeRabbit inference engine (CODING_GUIDELINES.md)
Use only spaces, no tabs; indent with 4 spaces.
Files:
tests/unittest/others/test_tracing.py
**/*.py
📄 CodeRabbit inference engine (CODING_GUIDELINES.md)
**/*.py: Python code must target Python 3.8+.
Indent Python code with 4 spaces; do not use tabs.
Maintain module namespace when importing; prefer 'from package.subpackage import foo' then 'foo.SomeClass()' instead of importing the class directly.
Python filenames should be snake_case (e.g., some_file.py).
Python classes use PascalCase names.
Functions and methods use snake_case names.
Local variables use snake_case; prefix 'k' for variables that start with a number (e.g., k_99th_percentile).
Global variables use upper SNAKE_CASE prefixed with 'G' (e.g., G_MY_GLOBAL).
Constants use upper SNAKE_CASE (e.g., MY_CONSTANT).
Avoid shadowing variables from an outer scope.
Initialize all externally visible members of a class in the constructor.
Prefer docstrings for interfaces that may be used outside a file; comments for in-function or file-local interfaces.
Use Google-style docstrings for classes and functions (Sphinx-parsable).
Document attributes and variables inline so they render under the class/function docstring.
Avoid reflection when a simpler, explicit approach suffices (e.g., avoid dict(**locals()) patterns).
In try/except, catch the most specific exceptions possible.
For duck-typing try/except, keep the try body minimal and use else for the main logic.
Files:
tests/unittest/others/test_tracing.py
**/*.{cpp,cxx,cc,h,hpp,hh,hxx,cu,cuh,py}
📄 CodeRabbit inference engine (CODING_GUIDELINES.md)
Prepend the NVIDIA Apache-2.0 copyright header with current year to the top of all source files (e.g., .cpp, .h, .cu, .py).
Files:
tests/unittest/others/test_tracing.py
🧬 Code graph analysis (1)
tests/unittest/others/test_tracing.py (2)
tensorrt_llm/llmapi/tracing.py (1)
SpanAttributes(137-159)tests/unittest/llmapi/apps/openai_server.py (1)
get_client(110-114)
🪛 Ruff (0.14.1)
tests/unittest/others/test_tracing.py
37-37: Unused method argument: context
(ARG002)
76-76: Unused function argument: request
(ARG001)
131-131: Avoid specifying long messages outside the exception class
(TRY003)
184-185: Avoid specifying long messages outside the exception class
(TRY003)
189-191: Avoid specifying long messages outside the exception class
(TRY003)
⏰ 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: Pre-commit Check
🔇 Additional comments (1)
tests/unittest/others/test_tracing.py (1)
163-170: Parameter name is correct; no action needed.The code uses
max_completion_tokens, which is the correct parameter name for OpenAI's chat completions API (not a silent drop). The review concern conflates two different interfaces:
- OpenAI-compatible API (client.chat.completions.create): uses
max_completion_tokens- Internal TensorRT-LLM APIs (SamplingParams): use
max_tokensThe OpenAI protocol layer (tensorrt_llm/serve/openai_protocol.py) correctly maps
max_completion_tokensas the primary field withmax_tokensas an optional alias for backward compatibility. The test is correctly using the OpenAI standard.
svc-trtllm-gh-bot
added
the
Community want to contribute
|
/bot run --disable-fail-fast |
|
PR_Github #22818 [ run ] triggered by Bot. Commit: |
|
PR_Github #22818 [ run ] completed with state |
Shunkangz
force-pushed
the
add-tracing-ut
branch
from
096e667 to
bce291a
Compare
|
/bot run --stage-list "H100_PCIe-PyTorch-Perf-1, H100_PCIe-TensorRT-Perf-1" |
|
PR_Github #22878 [ run ] triggered by Bot. Commit: |
|
PR_Github #22878 [ run ] completed with state |
Shunkangz
force-pushed
the
add-tracing-ut
branch
from
bce291a to
386cee1
Compare
|
/bot run --stage-list "H100_PCIe-PyTorch-Perf-1, H100_PCIe-TensorRT-Perf-1" |
|
PR_Github #22966 [ run ] triggered by Bot. Commit: |
|
PR_Github #22966 [ run ] completed with state |
|
/bot run --disable-fail-fast |
|
PR_Github #23624 [ run ] triggered by Bot. Commit: |
|
PR_Github #23624 [ run ] completed with state |
|
/bot run --disable-fail-fast |
|
PR_Github #23717 [ run ] triggered by Bot. Commit: |
|
PR_Github #23717 [ run ] completed with state |
Signed-off-by: zhanghaotong <[email protected]>
Signed-off-by: zhanghaotong <[email protected]>
Signed-off-by: zhanghaotong <[email protected]>
Signed-off-by: zhanghaotong <[email protected]>
Signed-off-by: zhanghaotong <[email protected]>
Shunkangz
force-pushed
the
add-tracing-ut
branch
from
386cee1 to
6cabca4
Compare
|
/bot run --disable-fail-fast |
|
PR_Github #23725 [ run ] triggered by Bot. Commit: |
|
PR_Github #23725 [ run ] completed with state |
4 participants
Summary by CodeRabbit
Description
Add unit test for otlp tracing: PR#5897
PR Checklist
Please review the following before submitting your PR:
PR description clearly explains what and why. If using CodeRabbit's summary, please make sure it makes sense.
PR Follows TRT-LLM CODING GUIDELINES to the best of your knowledge.
Test cases are provided for new code paths (see test instructions)
Any new dependencies have been scanned for license and vulnerabilities
CODEOWNERS updated if ownership changes
Documentation updated as needed
The reviewers assigned automatically/manually are appropriate for the PR.
Please check this after reviewing the above items as appropriate for this PR.
GitHub Bot Help
/bot [-h] ['run', 'kill', 'skip', 'reuse-pipeline'] ...Provide a user friendly way for developers to interact with a Jenkins server.
Run
/bot [-h|--help]to print this help message.See details below for each supported subcommand.
run [--reuse-test (optional)pipeline-id --disable-fail-fast --skip-test --stage-list "A10-PyTorch-1, xxx" --gpu-type "A30, H100_PCIe" --test-backend "pytorch, cpp" --add-multi-gpu-test --only-multi-gpu-test --disable-multi-gpu-test --post-merge --extra-stage "H100_PCIe-TensorRT-Post-Merge-1, xxx" --detailed-log --debug(experimental)]Launch build/test pipelines. All previously running jobs will be killed.
--reuse-test (optional)pipeline-id(OPTIONAL) : Allow the new pipeline to reuse build artifacts and skip successful test stages from a specified pipeline or the last pipeline if no pipeline-id is indicated. If the Git commit ID has changed, this option will be always ignored. The DEFAULT behavior of the bot is to reuse build artifacts and successful test results from the last pipeline.--disable-reuse-test(OPTIONAL) : Explicitly prevent the pipeline from reusing build artifacts and skipping successful test stages from a previous pipeline. Ensure that all builds and tests are run regardless of previous successes.--disable-fail-fast(OPTIONAL) : Disable fail fast on build/tests/infra failures.--skip-test(OPTIONAL) : Skip all test stages, but still run build stages, package stages and sanity check stages. Note: Does NOT update GitHub check status.--stage-list "A10-PyTorch-1, xxx"(OPTIONAL) : Only run the specified test stages. Examples: "A10-PyTorch-1, xxx". Note: Does NOT update GitHub check status.--gpu-type "A30, H100_PCIe"(OPTIONAL) : Only run the test stages on the specified GPU types. Examples: "A30, H100_PCIe". Note: Does NOT update GitHub check status.--test-backend "pytorch, cpp"(OPTIONAL) : Skip test stages which don't match the specified backends. Only support [pytorch, cpp, tensorrt, triton]. Examples: "pytorch, cpp" (does not run test stages with tensorrt or triton backend). Note: Does NOT update GitHub pipeline status.--only-multi-gpu-test(OPTIONAL) : Only run the multi-GPU tests. Note: Does NOT update GitHub check status.--disable-multi-gpu-test(OPTIONAL) : Disable the multi-GPU tests. Note: Does NOT update GitHub check status.--add-multi-gpu-test(OPTIONAL) : Force run the multi-GPU tests in addition to running L0 pre-merge pipeline.--post-merge(OPTIONAL) : Run the L0 post-merge pipeline instead of the ordinary L0 pre-merge pipeline.--extra-stage "H100_PCIe-TensorRT-Post-Merge-1, xxx"(OPTIONAL) : Run the ordinary L0 pre-merge pipeline and specified test stages. Examples: --extra-stage "H100_PCIe-TensorRT-Post-Merge-1, xxx".--detailed-log(OPTIONAL) : Enable flushing out all logs to the Jenkins console. This will significantly increase the log volume and may slow down the job.--debug(OPTIONAL) : Experimental feature. Enable access to the CI container for debugging purpose. Note: Specify exactly one stage in thestage-listparameter to access the appropriate container environment. Note: Does NOT update GitHub check status.For guidance on mapping tests to stage names, see
docs/source/reference/ci-overview.mdand the
scripts/test_to_stage_mapping.pyhelper.kill
killKill all running builds associated with pull request.
skip
skip --comment COMMENTSkip testing for latest commit on pull request.
--comment "Reason for skipping build/test"is required. IMPORTANT NOTE: This is dangerous since lack of user care and validation can cause top of tree to break.reuse-pipeline
reuse-pipelineReuse a previous pipeline to validate current commit. This action will also kill all currently running builds associated with the pull request. IMPORTANT NOTE: This is dangerous since lack of user care and validation can cause top of tree to break.