The highest tagged major version is v2.

status

package

v1.30.0 Latest Latest Go to latest Published: Oct 29, 2020 License: Apache-2.0 Imports: 11 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/palantir/witchcraft-go-server

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func HealthStatusCode(metadata health.HealthStatus) int
func NewHealthCheckHandler(checkSource HealthCheckSource, sharedSecret refreshable.String, ...) http.Handler
type HealthCheckSource
- func NewCombinedHealthCheckSource(healthCheckSources ...HealthCheckSource) HealthCheckSource
type HealthStatusChangeHandler
- func NewDiagnosticLoggingChangeHandler() HealthStatusChangeHandler
type Source

Constants ¶

View Source

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

Variables ¶

View Source

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

Functions ¶

func HealthStatusCode ¶ added in v1.26.0

func HealthStatusCode(metadata health.HealthStatus) int

func NewHealthCheckHandler ¶

func NewHealthCheckHandler(checkSource HealthCheckSource, sharedSecret refreshable.String, healthStatusChangeHandlers []HealthStatusChangeHandler) 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 HealthStatusChangeHandler ¶ added in v1.26.0

type HealthStatusChangeHandler interface {
	HandleHealthStatusChange(ctx context.Context, prevStatus, currStatus health.HealthStatus)
}

func NewDiagnosticLoggingChangeHandler ¶ added in v1.26.0

func NewDiagnosticLoggingChangeHandler() HealthStatusChangeHandler

NewDiagnosticLoggingChangeHandler will emit a diagnostic log whenever the latest health status' state is more severe than HealthStateRepairing.

type Source ¶

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

Source provides status that should be sent as a response.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
health
heartbeat
periodic
refreshable
store
tree
window
reporter
routes

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL