http

Documentation

Index

• func ListenAndServe(ctx context.Context, addr string, srv *http.Server) error
• func MethodAndPathCleanID(r *http.Request) string
• func New(cfg *Config) (*http.Server, error)
• func PathWithCleanID(r *http.Request) string
• type Config
• type Option
  • func WithCORS(allowedOrigins, allowedMethods, allowedHeaders []string, allowCredentials bool) Option
  • func WithCORSWideOpen() Option
  • func WithGRPC(srv *grpc.Server) Option
  • func WithLogging(app string) Option
  • func WithMetrics(app string, opNameFunc func(r *http.Request) string) Option
  • func WithRecovery(writer io.Writer, printStack bool) Option
  • func WithTracing(server, app string, tags map[string]string, ...) Option

Functions

func ListenAndServe

func ListenAndServe(ctx context.Context, addr string, srv *http.Server) error

ListenAndServe serves an http server over TCP

func MethodAndPathCleanID

func MethodAndPathCleanID(r *http.Request) string

MethodAndPathCleanID replace string values that look like ids (uuids and int) with "*"

func New

func New(cfg *Config) (*http.Server, error)

New creates a new http server

Example:

srv, _ := server.New(&server.Config{
 Addr: ":8080",
 Handler: http.DefaultServeMux,
 Options: []server.Option{
   server.WithLogging("my-server"),
   server.WithMetrics("my-server"),
   server.WithRecovery(),
   server.WithTracing("opentracing-server:6831", "my-server"),
 }
})

srv.ListenAndServe(context.Background())

func PathWithCleanID

func PathWithCleanID(r *http.Request) string

PathWithCleanID replace string values that look like ids (uuids and int) with "*"

Types

type Config

type Config struct {
	Addr    string
	Handler http.Handler
	Options []Option
}

Config contains the http servers config options

type Option

type Option interface {
	WrapHandler(handler http.Handler) http.Handler
}

Option is the interface for all server options defined in this package

func WithCORS

func WithCORS(allowedOrigins, allowedMethods, allowedHeaders []string, allowCredentials bool) Option

WithCORS configures CORS on the webserver

func WithCORSWideOpen

func WithCORSWideOpen() Option

WithCORSWideOpen allows requests from all origins with all methods and all headers/cookies/credentials allowed.

func WithGRPC

func WithGRPC(srv *grpc.Server) Option

WithGRPC configures the webserver to serve grpc-web requests as specified in https://github.com/improbable-eng/grpc-web

func WithLogging

func WithLogging(app string) Option

WithLogging configures a logrus middleware for that server

func WithMetrics

func WithMetrics(app string, opNameFunc func(r *http.Request) string) Option

WithMetrics configures metrics collection

func WithRecovery

func WithRecovery(writer io.Writer, printStack bool) Option

WithRecovery configures panic recovery for that server

func WithTracing

func WithTracing(server, app string, tags map[string]string, opNameFunc func(r *http.Request) string) Option

WithTracing configures tracing for that server; if configuration fails, WithTracing will panic