admin

Documentation

Overview

Package admin provides an HTTP server for exposing internal information of the current service. Includes: - Application metrics - Prom metrics: go, process - Service health check - Runtime configuration

Index

• type Admin
  • func NewAdmin(port int, gracePeriod time.Duration, logger *zap.Logger) *Admin
  • func (a *Admin) Handle(pattern string, handler http.Handler)
  • func (a *Admin) HandleFunc(pattern string, handler func(http.ResponseWriter, *http.Request))
  • func (a *Admin) Run(ctx context.Context) error

Types

type Admin

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

Admin is a http server for exposing private information, e.g. - application metrics - prom metrics: go, process - service health check - runtime configuration

func NewAdmin

func NewAdmin(port int, gracePeriod time.Duration, logger *zap.Logger) *Admin

func (*Admin) Handle

func (a *Admin) Handle(pattern string, handler http.Handler)

func (*Admin) HandleFunc

func (a *Admin) HandleFunc(pattern string, handler func(http.ResponseWriter, *http.Request))

func (*Admin) Run

func (a *Admin) Run(ctx context.Context) error