middleware

README

Go Middleware

Links

• Documentation

• GitHub Repo

• Issues

Basic Usage

// Create a logger middleware using the default request logger and recovery
stack := middleware.Stack(
  middleware.Logger(middleware.DefaultRequestLogger),
  middleware.Recovery(log.Default().Writer()),
)

// Wrap the fooHandler in the logger middleware.
http.Handle("/foo", stack(fooHandler))

Documentation

Overview

Package middleware provides http.Handler functions for common server middleware tasks.

Basic Usage

  // Create a logger middleware using the default request logger and recovery
  stack := middleware.Stack(
		middleware.Logger(middleware.DefaultRequestLogger),
		middleware.Recovery(log.Default().Writer()),
  )

  // Wrap the fooHandler in the logger middleware.
  http.Handle("/foo", stack(fooHandler))

Index

• func RemoteIP(r *http.Request) []string
• type MiddlewareFunc
  • func Logger(logger RequestLogger) MiddlewareFunc
  • func Recovery(w io.Writer) MiddlewareFunc
  • func RecoveryWithLogger(logger SLogger) MiddlewareFunc
  • func ResponseRuntime(header string) MiddlewareFunc
  • func Stack(in ...MiddlewareFunc) MiddlewareFunc
• type RequestLogger
  • func NewStructuredRequestLogger(l SLogger) RequestLogger
• type ResponseWriter
  • func NewResponseWriter() *ResponseWriter
  • func (r *ResponseWriter) Apply(w http.ResponseWriter)
  • func (r *ResponseWriter) Header() http.Header
  • func (r *ResponseWriter) Write(b []byte) (int, error)
  • func (r *ResponseWriter) WriteHeader(code int)
• type SLogger

Functions

func RemoteIP

func RemoteIP(r *http.Request) []string

RemoteIP will return the IP address of the request. It searches the request headers X-Forwarded-For then X-Original-Forwarded-For. If neither headers contain IP addresses the request RemoteAddr will be used. If the RemoteAddr can't be parsed, a fallback will be returned "127.0.0.1".

Types

type MiddlewareFunc

type MiddlewareFunc func(http.Handler) http.Handler

MiddlewareFunc defines a standard middleware pattern. It takes a http.Handler as an argument and returns a new http.Handler. The returned handler will be responsible for processing the request and calling the supplied handler to continue the chain.

func Logger

func Logger(logger RequestLogger) MiddlewareFunc

Logger performs the next handler then calls RequestLogger.Log with the response status code, runtime of the sub-handler, and a clone of the original http.Request.

func Recovery

func Recovery(w io.Writer) MiddlewareFunc

Recovery provides a panic handler and logs panic details to the passed io.Writer. Log message will be JSON printed to a single line with keys "panic" and "stackTrace". The stackTrace key is a Base64 encoded stack trace.

func RecoveryWithLogger

func RecoveryWithLogger(logger SLogger) MiddlewareFunc

func ResponseRuntime

func ResponseRuntime(header string) MiddlewareFunc

ResponseRuntime will include a request duration header response value.

func Stack

func Stack(in ...MiddlewareFunc) MiddlewareFunc

Stack returns the middleware functions setup as a single MiddlewareFunc. The middlewares will be called in the order they were added.

type RequestLogger

type RequestLogger interface {
	// Log received the HTTP status code, duration of the sub-handler, and a copy of the http.Request
	Log(int, time.Duration, *http.Request)
}

RequestLogger is used to generate a log message for a request.

var DefaultRequestLogger RequestLogger = new(dRequestLogger)

DefaultRequestLogger provides a simple log message written to log.Default()

func NewStructuredRequestLogger

func NewStructuredRequestLogger(l SLogger) RequestLogger

type ResponseWriter

type ResponseWriter struct {
	StatusCode int
	Headers    http.Header
	BodyBuffer *bytes.Buffer
	// contains filtered or unexported fields
}

func NewResponseWriter

func NewResponseWriter() *ResponseWriter

func (*ResponseWriter) Apply

func (r *ResponseWriter) Apply(w http.ResponseWriter)

func (*ResponseWriter) Header

func (r *ResponseWriter) Header() http.Header

func (*ResponseWriter) Write

func (r *ResponseWriter) Write(b []byte) (int, error)

func (*ResponseWriter) WriteHeader

func (r *ResponseWriter) WriteHeader(code int)

type SLogger

type SLogger interface {
	DebugContext(context.Context, string, ...any)
	InfoContext(context.Context, string, ...any)
	ErrorContext(context.Context, string, ...any)
}