[HealthChecks] Add HealthChecks endpoint, register telemetry publisher #11341
+151
−18
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR implements health check endpoints for the Azure Functions host, adding telemetry publishing capabilities and proper health check registration. The changes enable monitoring of host lifecycle and readiness states through standardized health check endpoints.
- Adds health check endpoints at
/runtime/health,/runtime/health/live, and/runtime/health/ready - Registers telemetry health check publishers for liveness and readiness monitoring
- Updates metrics configuration to use consistent meter naming and versioning
Reviewed Changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| WebJobsApplicationBuilderExtension.cs | Adds health check middleware and endpoint configuration with routing for different health check types |
| HealthCheckExtensions.cs | Registers telemetry publishers for liveness and readiness health checks |
| HostMetrics.cs | Adds static version property for consistent meter versioning across health check metrics |
| HealthCheckMetrics.cs | Updates meter creation to use consistent naming and versioning from HostMetrics |
| HealthCheckExtensionsTests.cs | Refactors tests to verify telemetry publisher registration and extracts common verification logic |
| HostController.cs | Removes unused import |
| FunctionsController.cs | Minor comment punctuation fix and removes unused import |
mathewc
reviewed
Sep 19, 2025
mathewc
reviewed
Sep 19, 2025
src/WebJobs.Script.WebHost/WebJobsApplicationBuilderExtension.cs
Outdated
Show resolved
Hide resolved
mathewc
reviewed
Sep 19, 2025
mathewc
reviewed
Sep 19, 2025
| @@ -50,10 +50,12 @@ public void AddScriptHostHealthCheck_ThrowsOnNullBuilder() | |||
| } | |||
|
|
|||
| [Fact] | |||
| public void AddWebJobsScriptHealthChecks_RegistersBothHealthChecks() | |||
There was a problem hiding this comment.
Do you have any tests that verify the new http routes E2E, e.g. similar to the host API tests we have in SamplesEndToEndTests_CSharp
There was a problem hiding this comment.
Added some tests there.
RohitRanjanMS
approved these changes
Sep 19, 2025
src/WebJobs.Script.WebHost/WebJobsApplicationBuilderExtension.cs
Outdated
Show resolved
Hide resolved
liliankasem
reviewed
Sep 19, 2025
src/WebJobs.Script.WebHost/host.json
Outdated
| @@ -0,0 +1,8 @@ | |||
| { | |||
| "version": "2.0", | |||
liliankasem
reviewed
Sep 19, 2025
|
|
||
| PolicyAuthorizationResult authorization = await _policy.AuthorizeAsync( | ||
| policy, authentication, context, null).ConfigureAwait(false); | ||
| if (!authorization.Succeeded) |
There was a problem hiding this comment.
super nit: new lines (same for lines 30-31)
Suggested change
| if (!authorization.Succeeded) | |
| if (!authorization.Succeeded) |
liliankasem
approved these changes
Sep 19, 2025
jviau
force-pushed
the
jviau/health-checks-5
branch
from
0740972 to
4b45648
Compare
mathewc
reviewed
Sep 20, 2025
src/WebJobs.Script.WebHost/Diagnostics/HealthChecks/HealthCheckAuthMiddleware.cs
Show resolved
Hide resolved
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue describing the changes in this PR
resolves #11171, #11168, #11169, #11010
Pull request checklist
IMPORTANT: Currently, changes must be backported to the
in-procbranch to be included in Core Tools and non-Flex deployments.in-procbranch is not requiredrelease_notes.mdAdditional information
Adds the health check endpoint and registers TelemetryHealthCheckPublisher.
3 endpoints are registered in total:
/runtime/health-> runs all health checks/runtime/health/live-> runs all health checks with tagazure.functions.liveness-- this will check if theWebHostis alive or not./runtime/health/ready-> runs all health checks with tagazure.functions.readiness-- this will check if theScriptHostis alive or not.These checks will expand over time.