server

Documentation

Overview

Package server provides a preconfigured HTTP server with diagnostic hooks.

Index

• Variables
• type Options
• type Server
  • func New(opts *Options) *Server
  • func (srv *Server) ListenAndServe(addr string, h http.Handler) error

Variables

var Set = wire.NewSet(New, Options{})

Set is a Wire provider set that produces a *Server given the fields of Options. This set might add new inputs over time, but they can always be the zero value.

Types

type Options

type Options struct {
	RequestLogger requestlog.Logger
	HealthChecks  []health.Checker

	TraceExporter         trace.Exporter
	DefaultSamplingPolicy trace.Sampler
}

Options is the set of optional parameters.

type Server

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

Server is a preconfigured HTTP server with diagnostic hooks. The zero value is a server with the default options.

func New

func New(opts *Options) *Server

New creates a new server. New(nil) is the same as new(Server).

func (*Server) ListenAndServe

func (srv *Server) ListenAndServe(addr string, h http.Handler) error

ListenAndServe is a wrapper to use wherever http.ListenAndServe is used. It wraps the passed-in http.Handler with a handler that handles tracing and request logging. If the handler is nil, then http.DefaultServeMux will be used. A configured Requestlogger will log all requests except HealthChecks.