fyrchik/frostfs-api-go
1
0
Fork 0
forked from TrueCloudLab/frostfs-api-go
Code Issues Pull requests 12 Projects Releases Packages Wiki Activity

docs: add state proto documentation

Browse source
This commit is contained in:
Evgeniy Kulikov 2019-11-20 19:33:10 +03:00 committed by alexvanin
parent 6c0ee948e6
commit 6050ab755c
1 changed files with 7 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
state/service.proto
View file

@ -7,10 +7,14 @@ import "github.com/gogo/protobuf/gogoproto/gogo.proto";
option (gogoproto.stable_marshaler_all) = true; option (gogoproto.stable_marshaler_all) = true;
// The Status service definition. // Status service provides node's healthcheck and status info
service Status { service Status {
// Netmap request allows to receive current [bootstrap.SpreadMap](bootstrap.md#bootstrap.SpreadMap)
rpc Netmap(NetmapRequest) returns (bootstrap.SpreadMap); rpc Netmap(NetmapRequest) returns (bootstrap.SpreadMap);
// Metrics request allows to receive metrics in prometheus format
rpc Metrics(MetricsRequest) returns (MetricsResponse); rpc Metrics(MetricsRequest) returns (MetricsResponse);
// HealthCheck request allows to check health status of the node.
// If node unhealthy field Status would contains detailed info.
rpc HealthCheck(HealthRequest) returns (HealthResponse); rpc HealthCheck(HealthRequest) returns (HealthResponse);
} }
@ -32,6 +36,8 @@ message HealthRequest {}
// HealthResponse message with current state // HealthResponse message with current state
message HealthResponse { message HealthResponse {
// Healthy is true when node alive and healthy
bool Healthy = 1; bool Healthy = 1;
// Status contains detailed information about health status
string Status = 2; string Status = 2;
} }