healthcheck

Documentation

Overview

Package healthcheck provides a healthcheck endpoint under the default route /status/healthcheck Usage: Register your own Status via Dingo: injector.BindMap(new(healthcheck.Status), "yourServiceName").To(yourServiceNameApi.Status{})

Index

• type Module
  • func (m *Module) Configure(injector *dingo.Injector)
  • func (m *Module) DefaultConfig() config.Map
  • func (m *Module) Inject(controller *controllers.Healthcheck, config ...)

Types

type Module

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

Module entry point for the flamingo healthcheck module

func (*Module) Configure

func (m *Module) Configure(injector *dingo.Injector)

Configure dependency injection

func (*Module) DefaultConfig

func (m *Module) DefaultConfig() config.Map

DefaultConfig for healthcheck module

func (*Module) Inject

func (m *Module) Inject(
	controller *controllers.Healthcheck,
	config *struct {
		CheckSession    bool   `inject:"config:healthcheck.checkSession"`
		CheckAuthServer bool   `inject:"config:healthcheck.checkAuth"`
		CheckPath       string `inject:"config:healthcheck.checkPath"`
		PingPath        string `inject:"config:healthcheck.pingPath"`
		SessionBackend  string `inject:"config:session.backend"`
	},
)

Inject dependencies