Skip to content

Commit

Permalink
support grpc health check protocol
Browse files Browse the repository at this point in the history
  • Loading branch information
jiangyuting committed Jan 4, 2024
1 parent 9fd7e21 commit b5c97b2
Show file tree
Hide file tree
Showing 5 changed files with 125 additions and 0 deletions.
1 change: 1 addition & 0 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -455,6 +455,7 @@ set(PROTO_FILES idl_options.proto
brpc/get_favicon.proto
brpc/span.proto
brpc/builtin_service.proto
brpc/grpc_health_check.proto
brpc/get_js.proto
brpc/errno.proto
brpc/nshead_meta.proto
Expand Down
41 changes: 41 additions & 0 deletions src/brpc/builtin/grpc_health_check_service.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
// 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.

#include "brpc/builtin/common.h"
#include "brpc/builtin/grpc_health_check_service.h"
#include "brpc/controller.h" // Controller
#include "brpc/closure_guard.h" // ClosureGuard
#include "brpc/server.h" // Server

namespace brpc {
void GrpcHealthCheckService::Check(::google::protobuf::RpcController* cntl_base,
const grpc::health::v1::HealthCheckRequest* request,
grpc::health::v1::HealthCheckResponse* response,
::google::protobuf::Closure* done) {
ClosureGuard done_guard(done);
Controller *cntl = static_cast<Controller*>(cntl_base);
const Server* server = cntl->server();
if (server->options().health_reporter) {
server->options().health_reporter->GenerateReport(
cntl, done_guard.release());
} else {
response->set_status(grpc::health::v1::HealthCheckResponse_ServingStatus_SERVING);
}
}

} // namespace brpc

37 changes: 37 additions & 0 deletions src/brpc/builtin/grpc_health_check_service.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
// 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.


#ifndef BRPC_GRPC_HEALTH_CHECK_SERVICE_H
#define BRPC_GRPC_HEALTH_CHECK_SERVICE_H

#include "brpc/grpc_health_check.pb.h"

namespace brpc {

class GrpcHealthCheckService : public grpc::health::v1::Health {
public:
void Check(::google::protobuf::RpcController* cntl_base,
const grpc::health::v1::HealthCheckRequest* request,
grpc::health::v1::HealthCheckResponse* response,
::google::protobuf::Closure* done);

};

} // namespace brpc

#endif //BRPC_GRPC_HEALTH_CHECK_SERVICE_H
41 changes: 41 additions & 0 deletions src/brpc/grpc_health_check.proto
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
// 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.

syntax = "proto2";
package grpc.health.v1;
option cc_generic_services = true;

message HealthCheckRequest {
optional string service = 1;
}

message HealthCheckResponse {
enum ServingStatus {
UNKNOWN = 0;
SERVING = 1;
NOT_SERVING = 2;
SERVICE_UNKNOWN = 3; // Used only by the Watch method.
}
optional ServingStatus status = 1;
}

service Health {
rpc Check(HealthCheckRequest) returns (HealthCheckResponse);

rpc Watch(HealthCheckRequest) returns (stream HealthCheckResponse);
}

5 changes: 5 additions & 0 deletions src/brpc/server.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
#include "brpc/builtin/bad_method_service.h" // BadMethodService
#include "brpc/builtin/get_favicon_service.h"
#include "brpc/builtin/get_js_service.h"
#include "brpc/builtin/grpc_health_check_service.h" // GrpcHealthCheckService
#include "brpc/builtin/version_service.h"
#include "brpc/builtin/health_service.h"
#include "brpc/builtin/list_service.h"
Expand Down Expand Up @@ -564,6 +565,10 @@ int Server::AddBuiltinServices() {
LOG(ERROR) << "Fail to add GetJsService";
return -1;
}
if (AddBuiltinService(new (std::nothrow) GrpcHealthCheckService)) {
LOG(ERROR) << "Fail to add GrpcHealthCheckService";
return -1;
}
return 0;
}

Expand Down

0 comments on commit b5c97b2

Please sign in to comment.