probe

Documentation

Index

• func CreateAndRunGRPCHealthProbe(ctx context.Context, healthService string, options ...Option)
• type HealthProbe
  • func NewHealthProbe(ctx context.Context, options ...Option) (*HealthProbe, error)
  • func (hp *HealthProbe) Request(ctx context.Context) error
  • func (hp *HealthProbe) String() string
• type Option
  • func WithAddress(addr string) Option
  • func WithConnectTimeout(connTimeout time.Duration) Option
  • func WithRPCTimeout(rpcTimeout time.Duration) Option
  • func WithService(service string) Option
  • func WithSpiffe() Option
  • func WithUserAgent(userAgent string) Option

Functions

func CreateAndRunGRPCHealthProbe

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

CreateAndRunGRPCHealthProbe - Creates and runs a gRPC health probe client and registers the status response of the service to a local gRPC health server retrived from the context. In the local health server the service is refered to by healthService string.

Types

type HealthProbe

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

func NewHealthProbe

func NewHealthProbe(ctx context.Context, options ...Option) (*HealthProbe, error)

NewHealthProbe - Create a new grpc health probe which is an alternate to grpc-health-probe binary but does NOT require a new process to get spawned. Thus, when using with the spiffe option the spire agents are not required to attest new processes all the time when the probe is invoked.

func (*HealthProbe) Request

func (hp *HealthProbe) Request(ctx context.Context) error

Request - Sends query to check health of gRPC services exposing their status through gRPC Health Checking Protocol.

Returns no error if queried service is SERVING.

func (*HealthProbe) String

func (hp *HealthProbe) String() string

String -

type Option

type Option func(o *probeOptions)

func WithAddress

func WithAddress(addr string) Option

WithAddress sets address for probe

func WithConnectTimeout

func WithConnectTimeout(connTimeout time.Duration) Option

WithConnectTimeout sests connect timeout probe

func WithRPCTimeout

func WithRPCTimeout(rpcTimeout time.Duration) Option

WithRPCTimeout sets RPC timeout for probe

func WithService

func WithService(service string) Option

WithService sets service for probe

func WithSpiffe

func WithSpiffe() Option

WithSpiffe sets spiffe option for probe

func WithUserAgent

func WithUserAgent(userAgent string) Option

WithUserAgent sests user agent