healthz

Documentation

Index

• func Handler(hc *Config) (http.Handler, error)
• type Config
  • func NewConfig(appConfig *utils.AppConfig) (*Config, error)
• type Error
• type Response

Functions

func Handler

func Handler(hc *Config) (http.Handler, error)

Handler provides a new healthz handler

Types

type Config

type Config struct {
	Hostname string
}

Config provides data for the healthz handler

func NewConfig

func NewConfig(appConfig *utils.AppConfig) (*Config, error)

NewConfig initializes a healthz.Config struct

type Error

type Error struct {
	Description string            `json:"description"`
	Error       string            `json:"error"`
	Metadata    map[string]string `json:"metadata"`
	Type        string            `json:"type"`
}

type Response

type Response struct {
	Hostname string            `json:"hostname"`
	Metadata map[string]string `json:"metadata"`
	Errors   []Error           `json:"errors"`
}