[TRTLLM-8274][feat] Check if executor is shutdown in /health entrypoint

[JunyiXu-nv]

Summary by CodeRabbit

New Features

• Added health check endpoint for monitoring LLM service status and availability
• Health endpoint returns HTTP 200 when service is healthy or HTTP 503 when unavailable, with descriptive status messages to help diagnose service issues

Description

Currently the /health entrypoint does nothing but return a 200 OK to the client. In this PR, we make it return 503 error when executor is shutdown, which could enable user detect the server status and reboot when the executor crashes.

Test Coverage

• unittest/llmapi/apps/_test_openai_metrics.py::test_health

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

• Update tava architecture diagram if there is a significant design change in PR.

• The reviewers assigned automatically/manually are appropriate for the PR.

• [x] 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 the stage-list parameter 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.md and the scripts/test_to_stage_mapping.py helper.

kill

kill

Kill all running builds associated with pull request.

skip

skip --comment COMMENT

Skip 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-pipeline

Reuse 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.

[coderabbitai[bot]]

📝 Walkthrough

Walkthrough

Added a health check mechanism to the LLM API and OpenAI server. A new check_health() method is introduced in BaseLLM to expose executor shutdown state, and OpenAIServer implements a corresponding health endpoint that returns 200 when healthy or 503 when the executor is shut down. Tests are updated with parameterized health checks.

Changes

Cohort / File(s)	Summary
Health Check Implementation in BaseLLM tensorrt_llm/llmapi/llm.py	Added public check_health() method that returns the inverse of executor shutdown state; returns False if no executor exists.
Health Check Integration in OpenAIServer tensorrt_llm/serve/openai_server.py	Added internal _check_health() method delegating to llm.check_health(). Health route now returns 200 on healthy status or 503 with a descriptive message on failure.
Test Updates for Health Check Validation tests/unittest/llmapi/apps/_test_openai_metrics.py	Refactored fixtures: separated llm fixture from client. Updated test_health with parameterization over (is_healthy, response_code) and conditional LLM shutdown. Adjusted OpenAIServer initialization to remove tokenizer and add explicit None values for tool_parser, server_role, and metadata_server_cfg.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

• The changes follow a consistent pattern: method addition in base class, delegation in server class, and test parameterization
• Logic is straightforward with no complex decision trees or edge cases
• Fixture refactoring is mechanical and localized to test setup
• Primary focus areas:
  • Verify check_health() correctly reflects executor state in BaseLLM
  • Confirm _check_health() delegation and HTTP response codes (200 vs. 503) in OpenAIServer
  • Validate test parameterization correctly exercises both healthy and unhealthy paths

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 7.69% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and specifically summarizes the main change: adding executor shutdown detection to the /health endpoint.
Description check	✅ Passed	The description includes all essential sections: clear explanation of the issue/solution, test coverage specification, and a completed PR checklist.

✨ Finishing touches

• [ ] 📝 Generate docstrings

🧪 Generate unit tests (beta)

• [ ] Create PR with unit tests
• [ ] Post copyable unit tests in a comment

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[JunyiXu-nv]

/bot run

[tensorrt-cicd]

PR_Github #24098 [ run ] triggered by Bot. Commit: f688512

[tensorrt-cicd]

PR_Github #24098 [ run ] completed with state SUCCESS. Commit: f688512 /LLM/main/L0_MergeRequest_PR pipeline #18162 completed with status: 'FAILURE'

[JunyiXu-nv]

/bot run

[tensorrt-cicd]

PR_Github #25822 [ run ] triggered by Bot. Commit: dec4112

[tensorrt-cicd]

PR_Github #25822 [ run ] completed with state FAILURE. Commit: dec4112 /LLM/main/L0_MergeRequest_PR pipeline #19584 completed with status: 'FAILURE'

[JunyiXu-nv]

/bot run

[tensorrt-cicd]

PR_Github #26011 [ run ] triggered by Bot. Commit: 722a814

[tensorrt-cicd]

PR_Github #26011 [ run ] completed with state SUCCESS. Commit: 722a814 /LLM/main/L0_MergeRequest_PR pipeline #19735 completed with status: 'FAILURE'

[JunyiXu-nv]

/bot run

[tensorrt-cicd]

PR_Github #26102 [ run ] triggered by Bot. Commit: c0baa76

[tensorrt-cicd]

PR_Github #26102 [ run ] completed with state ABORTED. Commit: c0baa76 LLM/main/L0_MergeRequest_PR #19818 (Blue Ocean) completed with status: ABORTED

[JunyiXu-nv]

/bot run

[tensorrt-cicd]

PR_Github #26359 [ run ] triggered by Bot. Commit: 27a2fee

[tensorrt-cicd]

PR_Github #26359 [ run ] completed with state SUCCESS. Commit: 27a2fee /LLM/main/L0_MergeRequest_PR pipeline #20019 completed with status: 'FAILURE'

[JunyiXu-nv]

/bot run

[tensorrt-cicd]

PR_Github #26531 [ run ] triggered by Bot. Commit: ea6eb3f

[tensorrt-cicd]

PR_Github #26531 [ run ] completed with state FAILURE. Commit: ea6eb3f /LLM/main/L0_MergeRequest_PR pipeline #20173 completed with status: 'FAILURE'

[JunyiXu-nv]

/bot run

[tensorrt-cicd]

PR_Github #26626 [ run ] triggered by Bot. Commit: 53b9ea4

[tensorrt-cicd]

PR_Github #26626 [ run ] completed with state SUCCESS. Commit: 53b9ea4 /LLM/main/L0_MergeRequest_PR pipeline #20252 completed with status: 'FAILURE'

[JunyiXu-nv]

/bot run

[tensorrt-cicd]

PR_Github #26691 [ run ] triggered by Bot. Commit: 53b9ea4

[tensorrt-cicd]

PR_Github #26691 [ run ] completed with state SUCCESS. Commit: 53b9ea4 /LLM/main/L0_MergeRequest_PR pipeline #20311 completed with status: 'SUCCESS' Pipeline passed with automatic retried tests. Check the rerun report for details.