healthcheck

Documentation

Index

• Constants
• type OrmProbe
  • func NewOrmProbe(db *gorm.DB) *OrmProbe
  • func (p *OrmProbe) Check(ctx context.Context) *healthcheck.CheckerProbeResult
  • func (p *OrmProbe) Name() string
  • func (p *OrmProbe) SetName(name string) *OrmProbe

Constants

const DefaultProbeName = "orm"

DefaultProbeName is the name of the ORM probe.

Types

type OrmProbe

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

OrmProbe is a probe compatible with the healthcheck module.

func NewOrmProbe

func NewOrmProbe(db *gorm.DB) *OrmProbe

NewOrmProbe returns a new OrmProbe.

func (*OrmProbe) Check

func (p *OrmProbe) Check(ctx context.Context) *healthcheck.CheckerProbeResult

Check returns a successful healthcheck.CheckerProbeResult if the database connection can be pinged.

func (*OrmProbe) Name

func (p *OrmProbe) Name() string

NewOrmProbe returns the name of the OrmProbe.

func (*OrmProbe) SetName

func (p *OrmProbe) SetName(name string) *OrmProbe

SetName sets the name of the OrmProbe.