http

README

http

This package provides utilities for HTTP servers.

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.ObservabilityMiddleware	A middleware providing wrappers for http handlers for logging, metrics, and tracing.

Quick Start

You can see an example of using the observability middleware here.

Documentation

Index

• func LoggerForRequest(r *http.Request) (*log.Logger, bool)
• type ClientObservabilityMiddleware
  • func NewClientObservabilityMiddleware(logger *log.Logger, mf *metrics.Factory, tracer opentracing.Tracer) *ClientObservabilityMiddleware
  • func (m *ClientObservabilityMiddleware) Wrap(ctx context.Context, req *http.Request, doer Doer) (*http.Response, error)
• 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 ServerObservabilityMiddleware
  • func NewServerObservabilityMiddleware(logger *log.Logger, mf *metrics.Factory, tracer opentracing.Tracer) *ServerObservabilityMiddleware
  • func (m *ServerObservabilityMiddleware) Wrap(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 ClientObservabilityMiddleware

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

ClientObservabilityMiddleware is an http client middleware for logging, metrics, and tracing

func NewClientObservabilityMiddleware

func NewClientObservabilityMiddleware(logger *log.Logger, mf *metrics.Factory, tracer opentracing.Tracer) *ClientObservabilityMiddleware

NewClientObservabilityMiddleware creates a new instance of http client middleware for observability

func (*ClientObservabilityMiddleware) Wrap

func (m *ClientObservabilityMiddleware) Wrap(ctx context.Context, req *http.Request, doer Doer) (*http.Response, error)

Wrap takes care of logging, metrics, and tracing for client-side http requests

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 ServerObservabilityMiddleware

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

ServerObservabilityMiddleware is an http server middleware for logging, metrics, and tracing

func NewServerObservabilityMiddleware

func NewServerObservabilityMiddleware(logger *log.Logger, mf *metrics.Factory, tracer opentracing.Tracer) *ServerObservabilityMiddleware

NewServerObservabilityMiddleware creates a new instance of http server middleware for observability

func (*ServerObservabilityMiddleware) Wrap

func (m *ServerObservabilityMiddleware) Wrap(next http.HandlerFunc) http.HandlerFunc

Wrap accepts an http handler and return a new http handler that takes care of logging, metrics, and tracing