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