healthserver

Documentation

Index

• func NewServer(cfgs ...ServiceConfig) grpc_health_v1.HealthServer
• type Service
• type ServiceConfig

Functions

func NewServer

func NewServer(cfgs ...ServiceConfig) grpc_health_v1.HealthServer

Types

type Service

type Service interface {
	Ping(ctx context.Context) (err error)
}

Service defines a service that has the potential to be a part of the healthchecker, anything that respects this interface can be included as part of the healthchecker

type ServiceConfig

type ServiceConfig struct {
	Name    string  `json:"name"`
	Service Service `json:"service"`
}

ServiceConfig defines a health checkable service it's important to only list services here that you care about services such as a redis instance (given you have a circuit breaker) shouldn't be listed here.