blob: fcb343e410a7f5957275c72d3c8f0acd47617a7d [file] [log] [blame]
Zack Williams52209662019-02-07 10:15:31 -07001syntax = "proto3";
2
Scott Baker383964b2019-11-01 14:26:07 -07003option go_package = "github.com/opencord/voltha-protos/v2/go/voltha";
Zack Williams52209662019-02-07 10:15:31 -07004
5package voltha;
6
7import "google/api/annotations.proto";
8import "google/protobuf/empty.proto";
9import "voltha_protos/meta.proto";
10
11// Encode health status of a Voltha instance
12message HealthStatus {
13
14 // Health states
15 enum HealthState {
16 HEALTHY = 0; // The instance is healthy
17 OVERLOADED = 1; // The instance is overloaded, decrease query rate
18 DYING = 2; // The instance is in a critical condition, do not use it
19 }
20
21 // Current state of health of this Voltha instance
22 HealthState state = 1 [(access) = READ_ONLY];
23}
24
25// Health related services
26service HealthService {
27
28 // Return current health status of a Voltha instance
29 rpc GetHealthStatus(google.protobuf.Empty) returns (HealthStatus) {
30 option (google.api.http) = {
31 get: "/health"
32 };
33 }
34
35}
36