Documentation
¶
Index ¶
- 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
- type Connections
- type Severity
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Check ¶
type Check struct {
Run func(ctx context.Context) error
Name string
Description string
Severity Severity
}
Check represents a check to be performed to validate Gitaly cluster health. Checks are used to diagnose issues with Praefect cluster setup through the Praefect CLI `check` subcommand and also performed through the invoking of the readiness RPC.
func NewGitalyNodeConnectivityCheck ¶
NewGitalyNodeConnectivityCheck returns a check that ensures Praefect can talk to all nodes of all virtual storages
func NewPostgresReadWriteCheck ¶
NewPostgresReadWriteCheck returns a check that ensures Praefect can read and write to the database
func NewPraefectMigrationCheck ¶
NewPraefectMigrationCheck returns a Check that checks if all praefect migrations have run
type CheckFunc ¶
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.
func NewClockSyncCheck ¶
func NewClockSyncCheck(clockDriftCheck func(ntpHost string, driftThreshold time.Duration) (bool, error)) CheckFunc
NewClockSyncCheck returns a function that returns a check that verifies if system clock is in sync.
func ReadinessChecks ¶
func ReadinessChecks() []CheckFunc
ReadinessChecks returns the checks invoked by the Praefect readiness RPC.
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" )
Source Files
Directories