probes

Documentation

Overview

Package probes contains the implementation of startup, liveness and readiness probes

Index

• type Checker
  • func NewLivenessChecker(cli client.Client, instance *postgres.Instance) Checker
  • func NewReadinessChecker(cli client.Client, instance *postgres.Instance) Checker
  • func NewStartupChecker(cli client.Client, instance *postgres.Instance) Checker
• type ReplicaLaggingError
  • func (e *ReplicaLaggingError) Error() string

Types

type Checker

type Checker interface {
	IsHealthy(ctx context.Context, w http.ResponseWriter)
}

Checker executes the probe and writes the response to the request

func NewLivenessChecker

func NewLivenessChecker(
	cli client.Client,
	instance *postgres.Instance,
) Checker

NewLivenessChecker creates a new instance of the liveness probe checker

func NewReadinessChecker

func NewReadinessChecker(
	cli client.Client,
	instance *postgres.Instance,
) Checker

NewReadinessChecker creates a new instance of the readiness probe checker

func NewStartupChecker

func NewStartupChecker(
	cli client.Client,
	instance *postgres.Instance,
) Checker

NewStartupChecker creates a new instance of the startup probe checker

type ReplicaLaggingError

type ReplicaLaggingError struct {
	// DetectedLag is the lag that was detected
	DetectedLag uint64

	// ConfiguredLag is the lag as configured in the probe
	ConfiguredLag uint64

	// LatestEndTime is the time of last write-ahead log location reported to
	// origin WAL sender
	LatestEndTime string
}

ReplicaLaggingError is raised when a replica is lagging more than the configured cap

func (*ReplicaLaggingError) Error

func (e *ReplicaLaggingError) Error() string