httpserver

type ApplicationServer ¶

type ApplicationServer struct {
	Handlers []Handler
	BaseServer
}

ApplicationServer contains the configuration items for an HTTP Server

type BaseServer ¶

type BaseServer struct {
	Port int
	// contains filtered or unexported fields
}

func (b *BaseServer) GetPort() int

func (b *BaseServer) Run() (err error)

func (b *BaseServer) Shutdown(timeout time.Duration) (err error)

type Handler ¶

type Handler struct {
	// Path of the endpoint (e.g. "/health"). Must include the leading /
	Path string
	// Handler that implements the endpoint
	Handler http.Handler
	// Methods that the handler should support. If empty, http.MethodGet is the default
	Methods []string
}

Handler contains an endpoint to be registered in the Server's HTTP server, using NewWithHandlers.

type Metrics ¶

type Metrics struct {
	RequestCounter    *prometheus.CounterVec
	DurationHistogram *prometheus.HistogramVec
}

Metrics contains the metrics that need to be captured while serving HTTP requests. If these are not provided then Server will create default metrics and register them with Prometheus' default registry.

func (m *Metrics) Handle(next http.Handler) http.Handler

type Prometheus ¶

type Prometheus struct {
	Path string
	BaseServer
}

Prometheus contains the different Prometheus configuration options

type Server ¶

type Server struct {
	Name string
	ApplicationServer
	Prometheus
	Metrics
}

func (s *Server) Run() (err error)

func (s *Server) Shutdown(timeout time.Duration) (err error)