handlers

Documentation

Index

• type Handler
  • func New() *Handler
  • func (h *Handler) Base(handle func(bit.Control)) func(bit.Control)
  • func (h *Handler) Health(c bit.Control)
  • func (h *Handler) Info(c bit.Control)
  • func (h *Handler) NotFound(c bit.Control)
  • func (h *Handler) Ready(c bit.Control)
  • func (h *Handler) Root(c bit.Control)
• type Requests
• type Runtime
• type State
• type Status

Types

type Handler

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

Handler defines common part for all handlers

func New

func New() *Handler

New returns new instance of the Handler

func (*Handler) Base

func (h *Handler) Base(handle func(bit.Control)) func(bit.Control)

Base handler implements middleware logic

func (*Handler) Health

func (h *Handler) Health(c bit.Control)

Health returns "OK" if service is alive

func (*Handler) Info

func (h *Handler) Info(c bit.Control)

Info returns detailed info about the service

func (*Handler) NotFound

func (h *Handler) NotFound(c bit.Control)

NotFound responds for undefined methods

func (*Handler) Ready

func (h *Handler) Ready(c bit.Control)

Ready returns "OK" if service is ready to serve traffic

func (*Handler) Root

func (h *Handler) Root(c bit.Control)

Root handler shows version

type Requests

type Requests struct {
	C2xx int `json:"2xx"`
	C4xx int `json:"4xx"`
	C5xx int `json:"5xx"`
}

Requests contains response codes statistics

type Runtime

type Runtime struct {
	CPU        int    `json:"cpu"`
	Memory     string `json:"memory"`
	Goroutines int    `json:"goroutines"`
}

Runtime defines runtime part of service information

type State

type State struct {
	Maintenance bool   `json:"maintenance"`
	Uptime      string `json:"uptime"`
}

State contains current state of the service

type Status

type Status struct {
	Host     string   `json:"host"`
	Version  string   `json:"version"`
	Commit   string   `json:"commit"`
	Repo     string   `json:"repo"`
	Compiler string   `json:"compiler"`
	Runtime  Runtime  `json:"runtime"`
	State    State    `json:"state"`
	Requests Requests `json:"requests"`
}

Status contains detailed information about service