httpserver

Documentation

Index

• Constants
• func NewHandler(opts *Options) http.Handler
• func NewServer(addr string, handler http.Handler) *http.Server
• func Start(ctx context.Context, opts *Options) (func(context.Context) error, error)
• type Options

Constants

const (
	DefaultReadHeaderTimeout = 5 * time.Second
	DefaultReadTimeout       = 10 * time.Second
	DefaultWriteTimeout      = 10 * time.Second
	DefaultIdleTimeout       = 60 * time.Second
	DefaultMaxHeaderBytes    = 1 << 20 // 1 MB
)

Server timeout defaults, shared with opshttp.

Functions

func NewHandler

func NewHandler(opts *Options) http.Handler

NewHandler builds an HTTP handler with routes + middleware main() owns *http.Server so it can do graceful shutdown

func NewServer

func NewServer(addr string, handler http.Handler) *http.Server

func Start

func Start(ctx context.Context, opts *Options) (func(context.Context) error, error)

Start public HTTP server Returns stop(ctx) for graceful shutdown

Types

type Options

type Options struct {
	Logger       log.Logger
	Port         int
	UseRecoverMW bool
	OnPanic      func()           // Optional callback for when panics are recovered, e.g. to trigger alerts or increment prometheus counters, etc.
	APIRoutes    func(chi.Router) // Provenance API routes
	SiteHandler  http.Handler     // Main site handler
	MetricsMW    func(http.Handler) http.Handler
	RateLimitMW  func(http.Handler) http.Handler
	Health       health.Probe
	Readiness    health.Probe
	ContentInfo  httpmw.ContentInfo     // For X-Content-Bundle-Version and X-Content-Hash headers
	ClientIPOpts httpmw.ClientIPOptions // Client IP extraction options (TrustedHops, etc.)
}