httpserver

Documentation

Index

• Constants
• type Config
• type Reporter
  • func NewReporter(cfg Config) *Reporter
  • func (r *Reporter) Recover(next http.Handler) http.Handler
  • func (r *Reporter) Run(_ context.Context) error
  • func (r *Reporter) SetLiveness(_ context.Context, b bool)
  • func (r *Reporter) SetReadiness(_ context.Context, b bool)
  • func (r *Reporter) Stop(ctx context.Context) error
  • func (r *Reporter) UpdateHealthChecks(_ context.Context, m map[string]*healthpb.Check)

Constants

const (
	LivenessAffirmativeResponseCode  = http.StatusOK
	LivenessNegativeResponseCode     = http.StatusServiceUnavailable
	ReadinessAffirmativeResponseCode = http.StatusOK
	ReadinessNegativeResponseCode    = http.StatusServiceUnavailable
)

Types

type Config

type Config struct {
	Addr           string `envconfig:"HEALTH_HTTP_REPORTER_ADDR" default:"0.0.0.0"`
	Port           int    `envconfig:"HEALTH_HTTP_REPORTER_PORT" default:"8181"`
	LivenessRoute  string `envconfig:"HEALTH_HTTP_REPORTER_LIVENESS_ROUTE" default:"/live"`
	ReadinessRoute string `envconfig:"HEALTH_HTTP_REPORTER_READINESS_ROUTE" default:"/ready"`
	Logger         health.Logger
}

type Reporter

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

func NewReporter

func NewReporter(cfg Config) *Reporter

NewReporter returns an instance of Reporter with routing and caching already set up.

func (*Reporter) Recover

func (r *Reporter) Recover(next http.Handler) http.Handler

func (*Reporter) Run

func (r *Reporter) Run(_ context.Context) error

func (*Reporter) SetLiveness

func (r *Reporter) SetLiveness(_ context.Context, b bool)

func (*Reporter) SetReadiness

func (r *Reporter) SetReadiness(_ context.Context, b bool)

func (*Reporter) Stop

func (r *Reporter) Stop(ctx context.Context) error

func (*Reporter) UpdateHealthChecks

func (r *Reporter) UpdateHealthChecks(_ context.Context, m map[string]*healthpb.Check)