http

README

http

This package provides utilities for HTTP servers and clients.

Item	Description
http.Error	An error type capturing context and information about a failed http request.
http.ResponseWriter	An implementation of standard http.ResponseWriter for recording status code.
http.ClientMiddleware	A client-side middleware providing wrappers for logging, metrics, tracing, etc.
http.ServerMiddleware	A server-side middleware providing wrappers for http handlers for logging, metrics, tracing, etc.

Quick Start

You can see an example of using the middleware here.

Documentation

Index

• func LoggerForRequest(r *http.Request) (*log.Logger, bool)
• type ClientMiddleware
  • func NewClientMiddleware(logger *log.Logger, mf *metrics.Factory, tracer opentracing.Tracer) *ClientMiddleware
  • func (m *ClientMiddleware) Logging(next Doer) Doer
  • func (m *ClientMiddleware) Metrics(next Doer) Doer
  • func (m *ClientMiddleware) RequestID(next Doer) Doer
  • func (m *ClientMiddleware) Tracing(next Doer) Doer
• type Doer
• type Error
  • func NewError(res *http.Response) *Error
  • func (e *Error) Error() string
• type ResponseWriter
  • func NewResponseWriter(rw http.ResponseWriter) *ResponseWriter
  • func (r *ResponseWriter) WriteHeader(statusCode int)
• type ServerMiddleware
  • func NewServerMiddleware(logger *log.Logger, mf *metrics.Factory, tracer opentracing.Tracer) *ServerMiddleware
  • func (m *ServerMiddleware) Logging(next http.HandlerFunc) http.HandlerFunc
  • func (m *ServerMiddleware) Metrics(next http.HandlerFunc) http.HandlerFunc
  • func (m *ServerMiddleware) RequestID(next http.HandlerFunc) http.HandlerFunc
  • func (m *ServerMiddleware) Tracing(next http.HandlerFunc) http.HandlerFunc

Functions

func LoggerForRequest

func LoggerForRequest(r *http.Request) (*log.Logger, bool)

LoggerForRequest returns a logger set by http middleware on each request context

Types

type ClientMiddleware

type ClientMiddleware struct {
	// contains filtered or unexported fields
}

ClientMiddleware is an http client middleware for logging, metrics, tracing, etc.

func NewClientMiddleware

func NewClientMiddleware(logger *log.Logger, mf *metrics.Factory, tracer opentracing.Tracer) *ClientMiddleware

NewClientMiddleware creates a new instance of http client middleware

func (*ClientMiddleware) Logging

func (m *ClientMiddleware) Logging(next Doer) Doer

Logging takes care of logging for outgoing http requests Request id will be read from reqeust context if present

func (*ClientMiddleware) Metrics

func (m *ClientMiddleware) Metrics(next Doer) Doer

Metrics takes care of metrics for outgoing http requests

func (*ClientMiddleware) RequestID

func (m *ClientMiddleware) RequestID(next Doer) Doer

RequestID ensures outgoing requests have unique ids This middleware ensures the request headers and context have a unique id A new request id will be generated if needed

func (*ClientMiddleware) Tracing

func (m *ClientMiddleware) Tracing(next Doer) Doer

Tracing takes care of tracing for outgoing http requests Trace information will be read from reqeust context if present

type Doer

type Doer func(*http.Request) (*http.Response, error)

Doer is the interface for standard http.Client Do method

type Error

type Error struct {
	Request    *http.Request
	StatusCode int
	Message    string
}

Error is an http error

func NewError

func NewError(res *http.Response) *Error

NewError creates a new instance of Error

func (*Error) Error

func (e *Error) Error() string

type ResponseWriter

type ResponseWriter struct {
	http.ResponseWriter
	StatusCode  int
	StatusClass string
}

ResponseWriter extends the functionality of standard http.ResponseWriter

func NewResponseWriter

func NewResponseWriter(rw http.ResponseWriter) *ResponseWriter

NewResponseWriter creates a new response writer

func (*ResponseWriter) WriteHeader

func (r *ResponseWriter) WriteHeader(statusCode int)

WriteHeader overrides the default implementation of http.WriteHeader

type ServerMiddleware

type ServerMiddleware struct {
	// contains filtered or unexported fields
}

ServerMiddleware is an http server middleware for logging, metrics, tracing, etc.

func NewServerMiddleware

func NewServerMiddleware(logger *log.Logger, mf *metrics.Factory, tracer opentracing.Tracer) *ServerMiddleware

NewServerMiddleware creates a new instance of http server middleware

func (*ServerMiddleware) Logging

func (m *ServerMiddleware) Logging(next http.HandlerFunc) http.HandlerFunc

Logging takes care of logging for incoming http requests Request id will be read from reqeust headers if present

func (*ServerMiddleware) Metrics

func (m *ServerMiddleware) Metrics(next http.HandlerFunc) http.HandlerFunc

Metrics takes care of metrics for incoming http requests

func (*ServerMiddleware) RequestID

func (m *ServerMiddleware) RequestID(next http.HandlerFunc) http.HandlerFunc

RequestID ensures incoming requests have unique ids This middleware ensures the request headers and context have a unique id A new request id will be generated if needed

func (*ServerMiddleware) Tracing

func (m *ServerMiddleware) Tracing(next http.HandlerFunc) http.HandlerFunc

Tracing takes care of tracing for incoming http requests Trace information will be read from reqeust headers if present