healthcheck

README

Healthcheck Module

The healthcheck module provides useful routes for:

1. check if the application is up (/status/ping endpoint)
2. Check the application status (/status/healthcheck endpoint)

Usage

The healthcheck module requires the systemendpoint module and its second server.

If you use the default configuration you should then see an ok when calling http://localhost:13210/status/ping

Healthcheck

The healthcheck endpoint allows to check different "things" from the view of your application. There are some available checks that you can activate by config:

core.healthcheck.checkSession: true
core.healthcheck.checkAuth: true

Implement own Checks:

Just Implement the healthcheck.Status interface and register it via Dingo mapbinding:

injector.BindMap(new(healthcheck.Status), "session").To(healthcheck.RedisSession{})

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) CueConfig() string
  • func (m *Module) Depends() []dingo.Module
  • func (*Module) FlamingoLegacyConfigAlias() map[string]string
  • 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) CueConfig

func (m *Module) CueConfig() string

CueConfig schema and configuration

func (*Module) Depends

func (m *Module) Depends() []dingo.Module

Depends on other modules

func (*Module) FlamingoLegacyConfigAlias

func (*Module) FlamingoLegacyConfigAlias() map[string]string

FlamingoLegacyConfigAlias mapping

func (*Module) Inject

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

Inject dependencies