Skip to content

Commit

Permalink
Add healthcheck to gRPC server
Browse files Browse the repository at this point in the history
  • Loading branch information
mostafa committed Oct 24, 2023
1 parent 0cb307a commit b4074a1
Show file tree
Hide file tree
Showing 4 changed files with 57 additions and 1 deletion.
2 changes: 2 additions & 0 deletions api/api.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,9 @@ type Options struct {
GRPCNetwork string
GRPCAddress string
HTTPAddress string
Servers map[string]*network.Server
}

type API struct {
v1.GatewayDAdminAPIServiceServer

Expand Down
4 changes: 3 additions & 1 deletion api/grpc_server.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,12 @@ import (

v1 "github.com/gatewayd-io/gatewayd/api/v1"
"google.golang.org/grpc"
"google.golang.org/grpc/health/grpc_health_v1"
"google.golang.org/grpc/reflection"
)

// StartGRPCAPI starts the gRPC API.
func StartGRPCAPI(api *API) {
func StartGRPCAPI(api *API, healthchecker *HealthChecker) {
listener, err := net.Listen(api.Options.GRPCNetwork, api.Options.GRPCAddress)
if err != nil {
api.Options.Logger.Err(err).Msg("failed to start gRPC API")
Expand All @@ -18,6 +19,7 @@ func StartGRPCAPI(api *API) {
grpcServer := grpc.NewServer()
reflection.Register(grpcServer)
v1.RegisterGatewayDAdminAPIServiceServer(grpcServer, api)
grpc_health_v1.RegisterHealthServer(grpcServer, healthchecker)
if err := grpcServer.Serve(listener); err != nil {
api.Options.Logger.Err(err).Msg("failed to start gRPC API")
}
Expand Down
38 changes: 38 additions & 0 deletions api/healthcheck.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
package api

import (
"context"

"github.com/gatewayd-io/gatewayd/network"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/health/grpc_health_v1"
"google.golang.org/grpc/status"
)

type HealthChecker struct {
grpc_health_v1.UnimplementedHealthServer

Servers map[string]*network.Server
}

func (h *HealthChecker) Check(
ctx context.Context, req *grpc_health_v1.HealthCheckRequest,
) (*grpc_health_v1.HealthCheckResponse, error) {
// Check if all servers are running
if liveness(h.Servers) {
return &grpc_health_v1.HealthCheckResponse{
Status: grpc_health_v1.HealthCheckResponse_SERVING,
}, nil
}

return &grpc_health_v1.HealthCheckResponse{
Status: grpc_health_v1.HealthCheckResponse_NOT_SERVING,
}, nil
}

func (h *HealthChecker) Watch(
req *grpc_health_v1.HealthCheckRequest,
server grpc_health_v1.Health_WatchServer,
) error {
return status.Error(codes.Unimplemented, "not implemented")
}
14 changes: 14 additions & 0 deletions api/utils.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
package api

import (
"github.com/gatewayd-io/gatewayd/network"
)

func liveness(servers map[string]*network.Server) bool {
for _, v := range servers {
if !v.IsRunning() {
return false
}
}
return true
}

0 comments on commit b4074a1

Please sign in to comment.