status

Documentation

Index

• Constants
• Variables
• func NewHealthCheckHandler(checkSource HealthCheckSource, sharedSecret refreshable.String) http.Handler
• type HealthCheckSource
  • func NewCombinedHealthCheckSource(healthCheckSources ...HealthCheckSource) HealthCheckSource
• type Source

Constants

const (
	LivenessEndpoint  = statusRoot + "/liveness"
	ReadinessEndpoint = statusRoot + "/readiness"
	HealthEndpoint    = statusRoot + "/health"
)

Variables

var HealthStateStatusCodes = map[health.HealthState]int{
	health.HealthStateHealthy:   http.StatusOK,
	health.HealthStateUnknown:   500,
	health.HealthStateDeferring: 518,
	health.HealthStateSuspended: 519,
	health.HealthStateRepairing: 520,
	health.HealthStateWarning:   521,
	health.HealthStateError:     522,
	health.HealthStateTerminal:  523,
}

Functions

func NewHealthCheckHandler

func NewHealthCheckHandler(checkSource HealthCheckSource, sharedSecret refreshable.String) http.Handler

Types

type HealthCheckSource

type HealthCheckSource interface {
	HealthStatus(ctx context.Context) health.HealthStatus
}

HealthCheckSource provides the SLS health status that should be sent as a response. Refer to the SLS specification for more information.

func NewCombinedHealthCheckSource

func NewCombinedHealthCheckSource(healthCheckSources ...HealthCheckSource) HealthCheckSource

type Source

type Source interface {
	Status() (respStatus int, metadata interface{})
}

Source provides status that should be sent as a response.