Scott Baker | e7144bc | 2019-10-01 14:16:47 -0700 | [diff] [blame^] | 1 | syntax = "proto3"; |
| 2 | |
| 3 | option go_package = "github.com/opencord/voltha-protos/go/voltha"; |
| 4 | |
| 5 | package voltha; |
| 6 | |
| 7 | import "google/api/annotations.proto"; |
| 8 | import "google/protobuf/empty.proto"; |
| 9 | import "voltha_protos/meta.proto"; |
| 10 | |
| 11 | // Encode health status of a Voltha instance |
| 12 | message 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 |
| 26 | service 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 | |