health

Documentation

Index

• Constants
• type HealthCheck
  • func NewHealthCheck() *HealthCheck
  • func (b *HealthCheck) Do(ctx context.Context) HealthCheckResult
  • func (b *HealthCheck) WithIndicator(name string, ind HealthIndicator) *HealthCheck
• type HealthCheckResult
• type HealthIndicator

Constants

const (
	StatusUp   = "UP"
	StatusDown = "DOWN"

	ServiceDatastore = "datastore"
	ServiceBroker    = "broker"
	ServiceRuntime   = "runtime"
)

Types

type HealthCheck

type HealthCheck struct {
	// contains filtered or unexported fields
}

func NewHealthCheck

func NewHealthCheck() *HealthCheck

func (*HealthCheck) Do

func (b *HealthCheck) Do(ctx context.Context) HealthCheckResult

func (*HealthCheck) WithIndicator

func (b *HealthCheck) WithIndicator(name string, ind HealthIndicator) *HealthCheck

type HealthCheckResult

type HealthCheckResult struct {
	Status  string `json:"status"`
	Version string `json:"version"`
}

type HealthIndicator

type HealthIndicator func(ctx context.Context) error