go_http_utils

README

Profiler URL

See https://pkg.go.dev/net/http/pprof

/debug/pprof/

Readiness

/_info

Documentation

Index

• func FormatError(w http.ResponseWriter, status int, err error)
• func Listen(ctx context.Context, httpListener Listener, handler Mux) error
• func ServeHealthcheck(ctx context.Context, log *zap.Logger)
• func ServeRuntimeMetrics(ctx context.Context, m Metrics)
• type Listener
• type Metrics
• type Mux

Functions

func FormatError

func FormatError(w http.ResponseWriter, status int, err error)

func Listen

func Listen(ctx context.Context, httpListener Listener, handler Mux) error

Listen runs http server with graceful shutdown.

func ServeHealthcheck

func ServeHealthcheck(ctx context.Context, log *zap.Logger)

ServeHealthcheck serves pprof and readiness endpoints.

func ServeRuntimeMetrics

func ServeRuntimeMetrics(ctx context.Context, m Metrics)

ServeRuntimeMetrics sends golang runtime metrics.

Types

type Listener

type Listener interface {
	Listen(context.Context, int, http.Handler) error
}

type Metrics

type Metrics interface {
	Gauge(string, interface{})
	Duration(string, time.Duration)
}

type Mux

type Mux interface {
	http.Handler
	Handle(string, http.Handler)
}