probe

Documentation

Index

• func CreateAndRunGRPCHealthProbe(ctx context.Context, healthService string, options ...Option)
• type GrpcHealthProbe
  • func NewGRPCHealthProbe(options ...Option) (*GrpcHealthProbe, error)
  • func (ghp *GrpcHealthProbe) Run(ctx context.Context) error
  • func (ghp *GrpcHealthProbe) String() string
• type Option
  • func WithAddress(addr string) Option
  • func WithCommand(cmd string) Option
  • func WithConnectTimeout(connTimeout string) Option
  • func WithRPCTimeout(rpcTimeout string) Option
  • func WithService(service string) Option
  • func WithSpiffe() Option

Functions

func CreateAndRunGRPCHealthProbe

func CreateAndRunGRPCHealthProbe(ctx context.Context, healthService string, options ...Option)

CreateAndRunGRPCHealthProbe - Creates gRPC Health Probe and starts running it background while registering the probing results to Health Server. TODO: configurable period, timeout

Types

type GrpcHealthProbe

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

func NewGRPCHealthProbe

func NewGRPCHealthProbe(options ...Option) (*GrpcHealthProbe, error)

NewGRPCHealthProbe - Creates gRPC health checking probe

func (*GrpcHealthProbe) Run

func (ghp *GrpcHealthProbe) Run(ctx context.Context) error

Run - Runs gRPC health checking probe Returns nil if status is HealthCheckResponse_SERVING, and err otherwise

func (*GrpcHealthProbe) String

func (ghp *GrpcHealthProbe) String() string

String -

type Option

type Option func(o *probeOptions)

Option is an option pattern for GrpcHealthProbe

func WithAddress

func WithAddress(addr string) Option

WithAddress sets address for grpc health probe

func WithCommand

func WithCommand(cmd string) Option

WithCommand sets grpc health probe command name

func WithConnectTimeout

func WithConnectTimeout(connTimeout string) Option

WithConnectTimeout connect timeout for grpc health probe

func WithRPCTimeout

func WithRPCTimeout(rpcTimeout string) Option

WithRPCTimeout RPC timeout for grpc health probe

func WithService

func WithService(service string) Option

WithService sets service for grpc health probe

func WithSpiffe

func WithSpiffe() Option

WithSpiffe sets spiffe option for grpc health probe