web

Documentation

Index

• func HealthzRoute(r *mux.Router, handler *healthHandler)
• func MetricsRoute(r *mux.Router, handler *metricsHandler)
• func NewHealthHandler(healthCheckTarget HealthCheckable) *healthHandler
• func NewMetricsHandler(ms MetricsServiceInterface) *metricsHandler
• func NewRouter() *mux.Router
• type HealthCheckable
• type MetricsServiceInterface

Functions

func HealthzRoute

func HealthzRoute(r *mux.Router, handler *healthHandler)

func MetricsRoute

func MetricsRoute(r *mux.Router, handler *metricsHandler)

func NewHealthHandler

func NewHealthHandler(healthCheckTarget HealthCheckable) *healthHandler

NewHealthHandler creates a handler for the Health endpoints healthCheckTarget must contain an implementation that will be utilized to signal that the service is ready to accept requests.

func NewMetricsHandler

func NewMetricsHandler(ms MetricsServiceInterface) *metricsHandler

func NewRouter

func NewRouter() *mux.Router

NewRouter returns the router created by the internal newRouter function Don't expose it directly in case we need to pass extra config that doesn't apply to the router.

Types

type HealthCheckable

type HealthCheckable interface {
	IsHealthy() error
}

type MetricsServiceInterface

type MetricsServiceInterface interface {
	Create(m mobile.Metric) (mobile.Metric, error)
}