healthcheck

Documentation

Index

• Constants
• Variables
• func CheckState(rs ReplSetStatus, startupDelaySeconds int64, oplogSize int64) error
• func HealthCheckMongodLiveness(client *mgo.Client, startupDelaySeconds int64) (*mongo.MemberState, error)
• func HealthCheckMongosLiveness(client *mgo.Client) error
• func MongosReadinessCheck(client *mongo.Client) error
• type InitialSyncStatus
• type OplogRs
• type ReplSetStatus
• type ServerStatus
• type State
  • func HealthCheck(client *mgo.Client, okMemberStates []mongo.MemberState) (State, *mongo.MemberState, error)
  • func ReadinessCheck(client *mongo.Client) (State, error)
  • func (s State) ExitCode() int

Constants

const (
	Version = "0.5.0"
)

Variables

var ErrNoReplsetConfigStr string = "(NotYetInitialized) no replset config has been received"

var OkMemberStates = []mongo.MemberState{
	mongo.MemberStatePrimary,
	mongo.MemberStateSecondary,
	mongo.MemberStateRecovering,
	mongo.MemberStateArbiter,
	mongo.MemberStateStartup2,
	mongo.MemberStateRollback,
}

OkMemberStates is a slice of acceptable replication member states

Functions

func CheckState

func CheckState(rs ReplSetStatus, startupDelaySeconds int64, oplogSize int64) error

func HealthCheckMongodLiveness

func HealthCheckMongodLiveness(client *mgo.Client, startupDelaySeconds int64) (*mongo.MemberState, error)

func HealthCheckMongosLiveness

func HealthCheckMongosLiveness(client *mgo.Client) error

func MongosReadinessCheck

func MongosReadinessCheck(client *mongo.Client) error

Types

type InitialSyncStatus

type InitialSyncStatus interface{}

type OplogRs

type OplogRs struct {
	StorageSize int64 `bson:"storageSize" json:"storageSize"`

	Ok     int    `bson:"ok" json:"ok"`
	Errmsg string `bson:"errmsg,omitempty" json:"errmsg,omitempty"`
}

type ReplSetStatus

type ReplSetStatus struct {
	mongo.Status      `bson:",inline"`
	InitialSyncStatus InitialSyncStatus `bson:"initialSyncStatus" json:"initialSyncStatus"`
}

type ServerStatus

type ServerStatus struct {
	Ok     int    `bson:"ok" json:"ok"`
	Errmsg string `bson:"errmsg,omitempty" json:"errmsg,omitempty"`
}

type State

type State int

const (
	StateOk State = iota
	StateFailed
)

func HealthCheck

func HealthCheck(client *mgo.Client, okMemberStates []mongo.MemberState) (State, *mongo.MemberState, error)

HealthCheck checks the replication member state of the local MongoDB member

func ReadinessCheck

func ReadinessCheck(client *mongo.Client) (State, error)

ReadinessCheck runs a ping on a pmgo.SessionManager to check server readiness

func (State) ExitCode

func (s State) ExitCode() int

ExitCode returns an integer reflecting the State, to be used as an exit code