service

Documentation

Index

• func NewClockSyncCheck(...) func(_ config.Config, _ io.Writer, _ bool) *Check
• type Check
  • func NewGitalyNodeConnectivityCheck(conf config.Config, w io.Writer, quiet bool) *Check
  • func NewPostgresReadWriteCheck(conf config.Config, w io.Writer, quiet bool) *Check
  • func NewPraefectMigrationCheck(conf config.Config, w io.Writer, quiet bool) *Check
  • func NewUnavailableReposCheck(conf config.Config, w io.Writer, quiet bool) *Check
• type CheckFunc
  • func AllChecks() []CheckFunc
• type Connections
• type Severity

Functions

func NewClockSyncCheck

func NewClockSyncCheck(clockDriftCheck func(ntpHost string, driftThreshold time.Duration) (bool, error)) func(_ config.Config, _ io.Writer, _ bool) *Check

NewClockSyncCheck returns a function that returns a check that verifies if system clock is in sync.

Types

type Check

type Check struct {
	Run         func(ctx context.Context) error
	Name        string
	Description string
	Severity    Severity
}

Check is a struct representing a check on the health of a Gitaly cluster's setup. These are separate from the "healthcheck" concept which is more concerned with the health of the praefect service. These checks are meant to diagnose any issues with the praefect cluster setup itself and will be run on startup/restarts.

func NewGitalyNodeConnectivityCheck

func NewGitalyNodeConnectivityCheck(conf config.Config, w io.Writer, quiet bool) *Check

NewGitalyNodeConnectivityCheck returns a check that ensures Praefect can talk to all nodes of all virtual storages

func NewPostgresReadWriteCheck

func NewPostgresReadWriteCheck(conf config.Config, w io.Writer, quiet bool) *Check

NewPostgresReadWriteCheck returns a check that ensures Praefect can read and write to the database

func NewPraefectMigrationCheck

func NewPraefectMigrationCheck(conf config.Config, w io.Writer, quiet bool) *Check

NewPraefectMigrationCheck returns a Check that checks if all praefect migrations have run

func NewUnavailableReposCheck

func NewUnavailableReposCheck(conf config.Config, w io.Writer, quiet bool) *Check

NewUnavailableReposCheck returns a check that finds the number of repositories without a valid primary

type CheckFunc

type CheckFunc func(conf config.Config, w io.Writer, quiet bool) *Check

CheckFunc is a function type that takes a praefect config and returns a Check

func AllChecks

func AllChecks() []CheckFunc

AllChecks returns slice of all checks that can be executed for praefect.

type Connections

type Connections map[string]map[string]*grpc.ClientConn

Connections contains connections to Gitaly nodes keyed by virtual storage and storage

This duplicates the praefect.Connections type as it is not possible to import anything from `praefect` to `info` or `server` packages due to cyclic dependencies.

type Severity

type Severity string

Severity is a type that indicates the severity of a check

const (
	// Warning indicates a severity level of warning
	Warning Severity = "warning"
	// Fatal indicates a severity level of fatal
	// any checks that are Fatal will prevent Praefect from starting up
	Fatal = "fatal"
)