health

package

v1.0.8 Latest Latest Go to latest Published: May 10, 2024 License: MIT Imports: 10 Imported by: 2

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/omalloc/contrib

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func AsChecker[T Checker]() interface{}
func AsHealth(f any) any
type Checker
type CheckerFunc
- func (f CheckerFunc) Check(ctx context.Context) error
type HealthReply
type HealthRequest
type HealthService
- func NewHealthService(logger log.Logger, checkers []Checker) *HealthService
- func (s *HealthService) Health(_ context.Context, _ *HealthRequest) (*HealthReply, error)
type Server
- func NewServer(health []Checker, logger log.Logger, s *http.Server) *Server
- func (h *Server) Start(ctx context.Context) error
- func (h *Server) Stop(ctx context.Context) error
type Status

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	Status_name = map[int32]string{
		0: "UNKNOWN",
		1: "UP",
		2: "DOWN",
	}
	Status_value = map[string]int32{
		"UNKNOWN": 0,
		"UP":      1,
		"DOWN":    2,
	}
)

Enum value maps for Status.

View Source

var File_health_proto protoreflect.FileDescriptor

Functions ¶

func AsChecker ¶

func AsChecker[T Checker]() interface{}

AsChecker is a health-checker transformer.

func AsHealth ¶

func AsHealth(f any) any

AsHealth is a health-server transformer.

Types ¶

type Checker ¶

type Checker interface {
	Check(ctx context.Context) error
}

type CheckerFunc ¶

type CheckerFunc func() error

func (CheckerFunc) Check ¶

func (f CheckerFunc) Check(ctx context.Context) error

type HealthReply ¶

type HealthReply struct {
	Status     Status            `protobuf:"varint,1,opt,name=status,proto3,enum=api.health.Status" json:"status,omitempty"`
	Components map[string]Status `` /* 185-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*HealthReply) Descriptor deprecated

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

Deprecated: Use HealthReply.ProtoReflect.Descriptor instead.

func (*HealthReply) GetComponents ¶

func (x *HealthReply) GetComponents() map[string]Status

func (*HealthReply) GetStatus ¶

func (x *HealthReply) GetStatus() Status

func (*HealthReply) ProtoMessage ¶

func (*HealthReply) ProtoMessage()

func (*HealthReply) ProtoReflect ¶

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

func (*HealthReply) Reset ¶

func (x *HealthReply) Reset()

func (*HealthReply) String ¶

func (x *HealthReply) String() string

type HealthRequest ¶

type HealthRequest struct {
	// contains filtered or unexported fields
}

func (*HealthRequest) Descriptor deprecated

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

Deprecated: Use HealthRequest.ProtoReflect.Descriptor instead.

func (*HealthRequest) ProtoMessage ¶

func (*HealthRequest) ProtoMessage()

func (*HealthRequest) ProtoReflect ¶

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

func (*HealthRequest) Reset ¶

func (x *HealthRequest) Reset()

func (*HealthRequest) String ¶

func (x *HealthRequest) String() string

type HealthService ¶

type HealthService struct {
	// contains filtered or unexported fields
}

HealthService is a health service.

func NewHealthService ¶

func NewHealthService(logger log.Logger, checkers []Checker) *HealthService

func (*HealthService) Health ¶

func (s *HealthService) Health(_ context.Context, _ *HealthRequest) (*HealthReply, error)

type Server ¶

type Server struct {
	// contains filtered or unexported fields
}

func NewServer ¶

func NewServer(health []Checker, logger log.Logger, s *http.Server) *Server

func (*Server) Start ¶

func (h *Server) Start(ctx context.Context) error

func (*Server) Stop ¶

func (h *Server) Stop(ctx context.Context) error

type Status ¶

type Status int32

const (
	Status_UNKNOWN Status = 0
	Status_UP      Status = 1
	Status_DOWN    Status = 2
)

func (Status) Descriptor ¶

func (Status) Descriptor() protoreflect.EnumDescriptor

func (Status) Enum ¶

func (x Status) Enum() *Status

func (Status) EnumDescriptor deprecated

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

Deprecated: Use Status.Descriptor instead.

func (Status) Number ¶

func (x Status) Number() protoreflect.EnumNumber

func (Status) String ¶

func (x Status) String() string

func (Status) Type ¶

func (Status) Type() protoreflect.EnumType

Source Files ¶

View all Source files

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