httputil

func BodyTooLarge ¶ added in v1.3.100

func BodyTooLarge(err error) bool

BodyTooLarge reports whether err came from a body read that passed the LimitBody cap.

func BoolFromQuery ¶

func BoolFromQuery(r *http.Request, key string, defaultVal bool) (bool, error)

BoolFromQuery obtains a boolean from a query entry.

func CompressMin ¶

func CompressMin(minBytes, level int) func(http.Handler) http.Handler

CompressMin gzips responses larger than minBytes for clients that accept gzip, when the content type is text, JSON, JavaScript, XML or SVG. Smaller responses, other types, flushes before the threshold, and hijacked connections pass through untouched. level is a compress/gzip level.

func ErrorFromResp ¶

func ErrorFromResp(resp *http.Response) error

ErrorFromResp creates an HTTPError from a given server response.

func GetLogger ¶

func GetLogger(r *http.Request) logrus.FieldLogger

GetLogger returns the logger carried by the HTTP request context, or the package logger when the context has none.

The miss is the common case, not an edge case: SetLoggerMiddleware only puts a logger in the context when a request ID is present. This used to return logging.NewMasterLogger(), which built a whole logrus.Logger, TextFormatter and hook map per call, and whose entries then bypassed the process hooks and configured level because it was its own master. The package logger is created once and routes through the master logger, so hooks and level apply.

func GetReqID ¶ added in v1.3.101

func GetReqID(ctx context.Context) string

GetReqID returns the request ID that RequestID stored in ctx, or "".

func KeyByRemoteAddr ¶ added in v1.3.101

func KeyByRemoteAddr(r *http.Request) string

KeyByRemoteAddr keys a rate limit by the peer IP, an IPv6 peer by its /64.

func LimitBody ¶ added in v1.3.100

func LimitBody(n int64) func(http.Handler) http.Handler

LimitBody caps request bodies at n bytes. A declared Content-Length over n is answered 413 at once, and any other body fails its read past n.

func LogEntrySetField ¶

func LogEntrySetField(r *http.Request, key string, value interface{})

LogEntrySetField adds new key-value pair to current (request scoped) log entry. This pair will be printed along with all other pairs when the request is served. This requires log middleware from this package to be installed in the chain

func NewLogMiddleware ¶

func NewLogMiddleware(logger logrus.FieldLogger) func(http.Handler) http.Handler

NewLogMiddleware creates a new instance of logging middleware. This will allow adding log fields in the handler and any further middleware. At the end of request, this log entry will be printed at Info level via passed logger

func ReadJSON ¶

func ReadJSON(r *http.Request, v interface{}) error

ReadJSON reads the request body to a json object.

func RealIP ¶ added in v1.3.101

func RealIP(next http.Handler) http.Handler

RealIP sets r.RemoteAddr from True-Client-IP, X-Real-IP or the first X-Forwarded-For address, when one holds a valid IP.

func Recoverer ¶ added in v1.3.101

func Recoverer(next http.Handler) http.Handler

Recoverer turns a handler panic into a 500 and logs it with the stack, so one bad request does not take the server down. http.ErrAbortHandler passes through.

func RequestID ¶ added in v1.3.101

func RequestID(next http.Handler) http.Handler

RequestID gives each request an ID, the X-Request-Id header when the client sent one. GetReqID reads it back.

func SetLoggerMiddleware ¶

func SetLoggerMiddleware(log logrus.FieldLogger) func(next http.Handler) http.Handler

SetLoggerMiddleware sets logger to context of HTTP requests.

func TrackRoutePattern ¶ added in v1.3.101

func TrackRoutePattern(r *http.Request) (*http.Request, *string)

TrackRoutePattern returns a request whose Router route, once served, is readable from the returned pointer, such as "/api/services/{addr}".

func WithReqID ¶ added in v1.3.101

func WithReqID(ctx context.Context, id string) context.Context

WithReqID returns ctx carrying a request ID, for tests.

func WriteJSON ¶

func WriteJSON(w http.ResponseWriter, r *http.Request, code int, v interface{})

WriteJSON writes a json object on a http.ResponseWriter with the given code. A value that cannot be encoded answers 500. Write errors are only logged.