-
Notifications
You must be signed in to change notification settings - Fork 979
feat: add HTTP health check API for Kubernetes integration #3047
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
solisamicus
wants to merge
1
commit into
apache:develop
Choose a base branch
from
solisamicus:feature/http-health-check-api
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to You under the Apache License, Version 2.0 | ||
| * (the "License"); you may not use this file except in compliance with | ||
| * the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package health | ||
|
|
||
| import ( | ||
| "dubbo.apache.org/dubbo-go/v3/common" | ||
| "dubbo.apache.org/dubbo-go/v3/metrics" | ||
| "dubbo.apache.org/dubbo-go/v3/server" | ||
| ) | ||
|
|
||
| func init() { | ||
| metrics.AddCollector("health", func(registry metrics.MetricRegistry, url *common.URL) { | ||
| healthServer := server.NewHealthCheckServer(url) | ||
| healthServer.Start() | ||
| }) | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,170 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to You under the Apache License, Version 2.0 | ||
| * (the "License"); you may not use this file except in compliance with | ||
| * the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package server | ||
|
|
||
| import ( | ||
| "context" | ||
| "sync/atomic" | ||
| "time" | ||
| ) | ||
|
|
||
| // DubboHealthChecker checks if dubbo services are properly exported | ||
| type DubboHealthChecker struct { | ||
| serverInstance *Server | ||
| } | ||
|
|
||
| // NewDubboHealthChecker creates a health checker for dubbo services | ||
| func NewDubboHealthChecker(server *Server) *DubboHealthChecker { | ||
| return &DubboHealthChecker{serverInstance: server} | ||
| } | ||
|
|
||
| func (d *DubboHealthChecker) CheckLiveness(ctx context.Context) bool { | ||
| // Liveness: server instance exists (process is alive) | ||
| return d.serverInstance != nil | ||
| } | ||
|
|
||
| func (d *DubboHealthChecker) CheckReadiness(ctx context.Context) bool { | ||
| // Readiness: services are exported and ready to handle requests | ||
| if d.serverInstance == nil { | ||
| return false | ||
| } | ||
|
|
||
| // Check if any services are registered | ||
| hasServices := false | ||
| d.serverInstance.svcOptsMap.Range(func(key, value interface{}) bool { | ||
| hasServices = true | ||
| return false // Stop iteration after finding first service | ||
| }) | ||
|
|
||
| return hasServices | ||
| } | ||
|
|
||
| func (d *DubboHealthChecker) CheckReadinessDetailed(ctx context.Context) *HealthCheckResult { | ||
| result := &HealthCheckResult{ | ||
| Healthy: true, | ||
| Details: make(map[string]string), | ||
| } | ||
|
|
||
| if d.serverInstance == nil { | ||
| result.Healthy = false | ||
| result.Message = "Server instance not initialized" | ||
| result.Details["server"] = "not_initialized" | ||
| return result | ||
| } | ||
|
|
||
| // Count exported services | ||
| serviceCount := 0 | ||
| d.serverInstance.svcOptsMap.Range(func(key, value interface{}) bool { | ||
| serviceCount++ | ||
| return true | ||
| }) | ||
|
|
||
| if serviceCount == 0 { | ||
| result.Healthy = false | ||
| result.Message = "No services exported" | ||
| result.Details["services"] = "none_exported" | ||
| } else { | ||
| result.Details["services"] = "exported" | ||
| result.Details["service_count"] = string(rune(serviceCount)) | ||
| } | ||
|
|
||
| return result | ||
| } | ||
|
|
||
| func (d *DubboHealthChecker) Name() string { | ||
| return "DubboHealthChecker" | ||
| } | ||
|
|
||
| // GracefulShutdownHealthChecker tracks graceful shutdown state | ||
| type GracefulShutdownHealthChecker struct { | ||
| shuttingDown int32 | ||
| } | ||
|
|
||
| // NewGracefulShutdownHealthChecker creates a health checker that tracks shutdown state | ||
| func NewGracefulShutdownHealthChecker() *GracefulShutdownHealthChecker { | ||
| return &GracefulShutdownHealthChecker{} | ||
| } | ||
|
|
||
| func (g *GracefulShutdownHealthChecker) CheckLiveness(ctx context.Context) bool { | ||
| return atomic.LoadInt32(&g.shuttingDown) == 0 | ||
| } | ||
|
|
||
| func (g *GracefulShutdownHealthChecker) CheckReadiness(ctx context.Context) bool { | ||
| return atomic.LoadInt32(&g.shuttingDown) == 0 | ||
| } | ||
|
|
||
| func (g *GracefulShutdownHealthChecker) Name() string { | ||
| return "GracefulShutdownHealthChecker" | ||
| } | ||
|
|
||
| // MarkShuttingDown marks the service as shutting down | ||
| func (g *GracefulShutdownHealthChecker) MarkShuttingDown() { | ||
| atomic.StoreInt32(&g.shuttingDown, 1) | ||
| } | ||
|
|
||
| // TimeoutHealthChecker wraps another checker with configurable timeout | ||
| type TimeoutHealthChecker struct { | ||
| checker HealthChecker | ||
| timeout time.Duration | ||
| } | ||
|
|
||
| // NewTimeoutHealthChecker creates a timeout-protected health checker | ||
| func NewTimeoutHealthChecker(checker HealthChecker, timeout time.Duration) *TimeoutHealthChecker { | ||
| return &TimeoutHealthChecker{ | ||
| checker: checker, | ||
| timeout: timeout, | ||
| } | ||
| } | ||
|
|
||
| func (t *TimeoutHealthChecker) CheckLiveness(ctx context.Context) bool { | ||
| ctx, cancel := context.WithTimeout(ctx, t.timeout) | ||
| defer cancel() | ||
|
|
||
| done := make(chan bool, 1) | ||
| go func() { | ||
| done <- t.checker.CheckLiveness(ctx) | ||
| }() | ||
|
|
||
| select { | ||
| case result := <-done: | ||
| return result | ||
| case <-ctx.Done(): | ||
| return false // Timeout considered unhealthy | ||
| } | ||
| } | ||
|
|
||
| func (t *TimeoutHealthChecker) CheckReadiness(ctx context.Context) bool { | ||
| ctx, cancel := context.WithTimeout(ctx, t.timeout) | ||
| defer cancel() | ||
|
|
||
| done := make(chan bool, 1) | ||
| go func() { | ||
| done <- t.checker.CheckReadiness(ctx) | ||
| }() | ||
|
|
||
| select { | ||
| case result := <-done: | ||
| return result | ||
| case <-ctx.Done(): | ||
| return false // Timeout considered unhealthy | ||
| } | ||
| } | ||
|
|
||
| func (t *TimeoutHealthChecker) Name() string { | ||
| return "TimeoutHealthChecker(" + t.checker.Name() + ")" | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Converting integer to string via rune cast is incorrect and will produce unexpected results. Use strconv.Itoa(serviceCount) instead.