db

Documentation

Index

• Constants
• type Checker
  • func NewChecker(name string, pinger CtxPinger, opts ...Option) *Checker
  • func (c *Checker) Check(ctx context.Context) *healthpb.Check
• type CtxPinger
• type Option
  • func WithTimeout(timeout time.Duration) Option

Constants

const (
	DefaultPingTimeout = 3 * time.Second
)

Types

type Checker

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

Checker implements health.Checker.

func NewChecker

func NewChecker(name string, pinger CtxPinger, opts ...Option) *Checker

NewChecker returns a Checker using the provided name and CtxPinger.

func (*Checker) Check

func (c *Checker) Check(ctx context.Context) *healthpb.Check

type CtxPinger

type CtxPinger interface {
	PingContext(context.Context) error
}

CtxPinger defines the interface for the database functionality used to perform the health check.

type Option

type Option func(*Checker)

Option is a functional decorator for creating a new Checker.

func WithTimeout

func WithTimeout(timeout time.Duration) Option

WithTimeout sets the timeout on the PingContext check.