server

Documentation

Index

• func Trace(next router.HandlerFunc) router.HandlerFunc
• type Runner
• type Server
  • func New(adminServerAddress string, runners ...Runner) (*Server, error)
  • func (s *Server) Metrics(next router.HandlerFunc) router.HandlerFunc
  • func (s *Server) Run() chan error
  • func (s *Server) Shutdown(ctx context.Context) error

Functions

func Trace

func Trace(next router.HandlerFunc) router.HandlerFunc

Trace is a middleware for tracing using opentelemetry

Types

type Runner

type Runner interface {
	// Run and pass mandatory middlewares when running each server
	Run(middlewares ...router.MiddlewareFunc) error
	Shutdown(ctx context.Context) error
}

Runner server interface

type Server

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

Server configuration

func New

func New(adminServerAddress string, runners ...Runner) (*Server, error)

New server

func (*Server) Metrics

func (s *Server) Metrics(next router.HandlerFunc) router.HandlerFunc

Metrics is a middleware for metrics monitoring

func (*Server) Run

func (s *Server) Run() chan error

Run the server

func (*Server) Shutdown

func (s *Server) Shutdown(ctx context.Context) error

Shutdown the server TODO: check whether one of the runners return error when shutting down