health

Documentation

Index

• Constants
• Variables
• func RegisterHealthServiceServer(s grpc.ServiceRegistrar, srv HealthServiceServer)
• type HealthServiceClient
  • func NewHealthServiceClient(cc grpc.ClientConnInterface) HealthServiceClient
• type HealthServiceServer
• type HealthStatus
  • func (*HealthStatus) Descriptor() ([]byte, []int)
  • func (x *HealthStatus) GetState() HealthStatus_HealthState
  • func (*HealthStatus) ProtoMessage()
  • func (x *HealthStatus) ProtoReflect() protoreflect.Message
  • func (x *HealthStatus) Reset()
  • func (x *HealthStatus) String() string
• type HealthStatus_HealthState
  • func (HealthStatus_HealthState) Descriptor() protoreflect.EnumDescriptor
  • func (x HealthStatus_HealthState) Enum() *HealthStatus_HealthState
  • func (HealthStatus_HealthState) EnumDescriptor() ([]byte, []int)
  • func (x HealthStatus_HealthState) Number() protoreflect.EnumNumber
  • func (x HealthStatus_HealthState) String() string
  • func (HealthStatus_HealthState) Type() protoreflect.EnumType
• type UnimplementedHealthServiceServer
  • func (UnimplementedHealthServiceServer) GetHealthStatus(context.Context, *emptypb.Empty) (*HealthStatus, error)
• type UnsafeHealthServiceServer

Constants

const (
	HealthService_GetHealthStatus_FullMethodName = "/health.HealthService/GetHealthStatus"
)

Variables

var (
	HealthStatus_HealthState_name = map[int32]string{
		0: "HEALTHY",
		1: "OVERLOADED",
		2: "DYING",
	}
	HealthStatus_HealthState_value = map[string]int32{
		"HEALTHY":    0,
		"OVERLOADED": 1,
		"DYING":      2,
	}
)

Enum value maps for HealthStatus_HealthState.

var File_voltha_protos_health_proto protoreflect.FileDescriptor

var HealthService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "health.HealthService",
	HandlerType: (*HealthServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetHealthStatus",
			Handler:    _HealthService_GetHealthStatus_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "voltha_protos/health.proto",
}

HealthService_ServiceDesc is the grpc.ServiceDesc for HealthService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterHealthServiceServer

func RegisterHealthServiceServer(s grpc.ServiceRegistrar, srv HealthServiceServer)

Types

type HealthServiceClient

type HealthServiceClient interface {
	// Return current health status of a Voltha instance
	GetHealthStatus(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*HealthStatus, error)
}

HealthServiceClient is the client API for HealthService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

Health related services

func NewHealthServiceClient

func NewHealthServiceClient(cc grpc.ClientConnInterface) HealthServiceClient

type HealthServiceServer

type HealthServiceServer interface {
	// Return current health status of a Voltha instance
	GetHealthStatus(context.Context, *emptypb.Empty) (*HealthStatus, error)
	// contains filtered or unexported methods
}

HealthServiceServer is the server API for HealthService service. All implementations must embed UnimplementedHealthServiceServer for forward compatibility.

Health related services

type HealthStatus

type HealthStatus struct {

	// Current state of health of this Voltha instance
	State HealthStatus_HealthState `protobuf:"varint,1,opt,name=state,proto3,enum=health.HealthStatus_HealthState" json:"state,omitempty"`
	// contains filtered or unexported fields
}

Encode health status of a Voltha instance

func (*HealthStatus) Descriptor

func (*HealthStatus) Descriptor() ([]byte, []int)

Deprecated: Use HealthStatus.ProtoReflect.Descriptor instead.

func (*HealthStatus) GetState

func (x *HealthStatus) GetState() HealthStatus_HealthState

func (*HealthStatus) ProtoMessage

func (*HealthStatus) ProtoMessage()

func (*HealthStatus) ProtoReflect

func (x *HealthStatus) ProtoReflect() protoreflect.Message

func (*HealthStatus) Reset

func (x *HealthStatus) Reset()

func (*HealthStatus) String

func (x *HealthStatus) String() string

type HealthStatus_HealthState

type HealthStatus_HealthState int32

Health states

const (
	HealthStatus_HEALTHY    HealthStatus_HealthState = 0 // The instance is healthy
	HealthStatus_OVERLOADED HealthStatus_HealthState = 1 // The instance is overloaded, decrease query rate
	HealthStatus_DYING      HealthStatus_HealthState = 2 // The instance is in a critical condition, do not use it
)

func (HealthStatus_HealthState) Descriptor

func (HealthStatus_HealthState) Descriptor() protoreflect.EnumDescriptor

func (HealthStatus_HealthState) Enum

func (x HealthStatus_HealthState) Enum() *HealthStatus_HealthState

func (HealthStatus_HealthState) EnumDescriptor

func (HealthStatus_HealthState) EnumDescriptor() ([]byte, []int)

Deprecated: Use HealthStatus_HealthState.Descriptor instead.

func (HealthStatus_HealthState) Number

func (x HealthStatus_HealthState) Number() protoreflect.EnumNumber

func (HealthStatus_HealthState) String

func (x HealthStatus_HealthState) String() string

func (HealthStatus_HealthState) Type

func (HealthStatus_HealthState) Type() protoreflect.EnumType

type UnimplementedHealthServiceServer

type UnimplementedHealthServiceServer struct{}

UnimplementedHealthServiceServer must be embedded to have forward compatible implementations.

NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.

func (UnimplementedHealthServiceServer) GetHealthStatus

func (UnimplementedHealthServiceServer) GetHealthStatus(context.Context, *emptypb.Empty) (*HealthStatus, error)

type UnsafeHealthServiceServer

type UnsafeHealthServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeHealthServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to HealthServiceServer will result in compilation errors.