postgreshealth

Documentation

Overview

Example

ctx := context.Background()
logger := zap.NewNop()

// Your database
db := &sql.DB{}

dbMonitor := NewPostgresMonitorsWithMetrics("", db, logger)
monitor := &health.Monitor{}
monitor.AddProber(ctx, dbMonitor)
go monitor.RunChecks(ctx, 1*time.Second)

// Attach endpoints
mux := http.NewServeMux()
monitor.AttachHttp(mux)

Index

• type PingCheck
• type PostgresMonitor
  • func NewPostgresMonitor(name string, db *sql.DB, l *zap.Logger) *PostgresMonitor
  • func NewPostgresMonitorWithMetrics(db *sql.DB, l *zap.Logger) *PostgresMonitor
  • func NewPostgresMonitorsWithMetrics(name string, db *sql.DB, l *zap.Logger) *PostgresMonitor
  • func (m *PostgresMonitor) Liveness(ctx context.Context) (probetype, redinesstype, name string, contents interface{}, err error)
  • func (m *PostgresMonitor) Probe(ctx context.Context) (err error)
  • func (m *PostgresMonitor) Readiness(ctx context.Context) (probetype, redinesstype, name string, contents interface{}, err error)
• type SizeCheck

Examples

• Package

Types

type PingCheck

type PingCheck struct {
	On       time.Time     `json:"on"`
	Duration time.Duration `json:"duration"`
	Status   string        `json:"status"`
	Error    string        `json:"error"`
}

type PostgresMonitor

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

func NewPostgresMonitor

func NewPostgresMonitor(name string, db *sql.DB, l *zap.Logger) *PostgresMonitor

func NewPostgresMonitorWithMetrics

func NewPostgresMonitorWithMetrics(db *sql.DB, l *zap.Logger) *PostgresMonitor

func NewPostgresMonitorsWithMetrics

func NewPostgresMonitorsWithMetrics(name string, db *sql.DB, l *zap.Logger) *PostgresMonitor

func (*PostgresMonitor) Liveness

func (m *PostgresMonitor) Liveness(ctx context.Context) (probetype, redinesstype, name string, contents interface{}, err error)

func (*PostgresMonitor) Probe

func (m *PostgresMonitor) Probe(ctx context.Context) (err error)

func (*PostgresMonitor) Readiness

func (m *PostgresMonitor) Readiness(ctx context.Context) (probetype, redinesstype, name string, contents interface{}, err error)

type SizeCheck

type SizeCheck struct {
	On     time.Time `json:"on"`
	Size   uint64    `json:"size"`
	Status string    `json:"status"`
	Error  string    `json:"error"`
}