Repository navigation
Conversation
…ails - HMSReadinessHealthIndicator reports only UP/DOWN; the HMS URIs, warehouse location and error message are no longer included in the health response. Failure causes are logged. - Set management.endpoint.health.show-details to never and document management.server.port for serving actuator endpoints on a separate port. - Add TestHMSReadinessHealthIndicator. Co-Authored-By: Claude <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues are reported for the change to status-only health responses.
No open issues 🎉
What changed in this PR
This PR makes the standalone REST catalog’s health responses status-only by default, keeping configuration and error details out of Kubernetes probe responses while preserving readiness checks.
Changes:
- Removes HMS connection details and error text from health results; logs failure causes instead.
- Disables actuator health details by default and documents the optional separate management port.
- Adds tests for missing configuration, unreachable HMS, and reachable HMS, asserting status and empty details.
| File | Description |
|---|---|
| standalone-metastore/metastore-rest-catalog/src/test/java/org/apache/iceberg/rest/standalone/health/TestHMSReadinessHealthIndicator.java | Tests status-only results for three HMS connectivity scenarios. |
| standalone-metastore/metastore-rest-catalog/src/main/resources/application.yml | Hides health details and documents management-port configuration. |
| standalone-metastore/metastore-rest-catalog/src/main/java/org/apache/iceberg/rest/standalone/health/HMSReadinessHealthIndicator.java | Returns only health status and logs failure diagnostics. |
Review effort: Balanced
|
This branch has not been deployed
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
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.
What changes were proposed in this pull request?
HMSReadinessHealthIndicatorreports onlyUP/DOWN. The HMS Thrift URIs, the warehouselocation and the raw exception message are no longer included in the health response;
failure causes are logged instead (message at WARN, stack trace at DEBUG).
application.yml:management.endpoint.health.show-detailschanges fromalwaystonever, and a comment documentsmanagement.server.portfor serving the actuatorendpoints on a separate port.
Why are the changes needed?
The health endpoint is used by Kubernetes probes, which only need the status. Server
configuration and error details do not belong in that response.
Does this PR introduce any user-facing change?
Yes.
/actuator/health(and the liveness/readiness groups) of the standalone REST catalogserver return only the status, without a
details/componentsbreakdown. Probe behaviouris unchanged. Details can be re-enabled with
-Dmanagement.endpoint.health.show-details=always, but the HMS indicator no longerreports URIs, warehouse or error text.
How was this patch tested?
New
TestHMSReadinessHealthIndicator: DOWN when Thrift URIs are not configured, DOWN whenHMS is unreachable, UP against a running HMS; each case asserts no details are returned.
🤖 Generated with Claude Code