health

package

v1.0.0 Latest Latest Go to latest Published: Oct 13, 2022 License: BSD-3-Clause Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/SSSOC-CAN/laniakea

Links

Open Source Insights

Documentation ¶

Constants ¶

View Source

const (
	ErrHealthServiceAlreadyRegistered = bg.Error("health service already registered")
	ErrUnregisteredHealthService      = bg.Error("unregistered health service")
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type HealthService ¶

type HealthService struct {
	lanirpc.UnimplementedHealthServer
	// contains filtered or unexported fields
}

func NewHealthService ¶

func NewHealthService() *HealthService

NewHealthService instantiates a new HealthService

func (*HealthService) Check ¶

func (h *HealthService) Check(ctx context.Context, req *lanirpc.HealthRequest) (*lanirpc.HealthResponse, error)

Check is the gRPC command to perform the health check on given API and plugin services

func (*HealthService) RegisterHealthService ¶

func (h *HealthService) RegisterHealthService(name string, s RegisteredHealthService) error

RegisterHealthService registers a given service that we want to perform health checks on

func (*HealthService) RegisterWithGrpcServer ¶

func (h *HealthService) RegisterWithGrpcServer(grpcServer *grpc.Server) error

RegisterWithGrpcServer registers the health service with the gRPC server

func (*HealthService) RegisterWithRestProxy ¶

func (h *HealthService) RegisterWithRestProxy(ctx context.Context, mux *proxy.ServeMux, restDialOpts []grpc.DialOption, restProxyDest string) error

RegisterWithRestProxy registers the health service with the REST proxy server

type RegisteredHealthService ¶

type RegisteredHealthService interface {
	Ping(context.Context) error
}

The RegisteredHealthService interface is used by the HealthService to ping any registered services

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL