httpwares

package module
Version: v0.0.0-...-edc8019 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 9, 2020 License: Apache-2.0 Imports: 4 Imported by: 16

README

🍲 Go HTTP Wares

Travis Build Go Report Card GoDoc SourceGraph codecov Apache 2.0 License

Client and Server HTTP middleware libraries leveraging Go's Context-based net/http library.

Why?

Just to clarify, these libraries are not yet another Go HTTP router, nor is it an REST client library. They are meant to interop with anything that net/http supports, without requiring much re-jigging of code.

The reason to include both server-side (middlewares) and client-side (tripperwares) is because Go HTTP servers often make HTTP requests themselves when handling an inbound request. As such, in order to make services debuggable in production, it is crucial to have the same sort of monitoring, logging and tracing available for both inbound and outbound requests. Moreover, some values (tracing, auth tokens) need to be passed from input to the output.

These libraries are meant as excellent companions for interceptors of github.com/grpc-ecosystem/go-grpc-middleware making it easy to build combined gRPC/HTTP Golang servers.

Wares

Middlewares (server-side)

Middlewares adhere to func (http.Handler) http.Handler signature. I.e. it is a handler that accept a handler.

This means that the composition purely net/http-based. This means that you can use it with echo, martini, or a home-grown router/framework of choice, worst-case you'll slide it between the http.Server and the http.Handler function of the framework.

The same composition is adopted in chi and goji, which means that you can use any middleware that's compatible with them, e.g.:

As such, this repository focuses on debugability of handlers. The crucial package here is http_ctxtags which propagates a set of key-value pairs through different middlewares in the http.Request.Context for both writing and reading. This means you get a canonical set of metadata for logging, monitoring and tracing of your inbound requests. Additionally, it allows assigning a name to a group of handlers (e.g. auth), and names to individual handlers (e.g. token_exchange).

The middlewares provided in this repo are:

  • Monitoring
  • Tracing
    • tracing/debug - /debug/request page for server-side HTTP request handling, allowing you to inspect failed requests, inbound headers etc.
    • tracing/opentracing - server-side request Opentracing middleware that is tags-aware and supports client-side propagation
  • Logging
    • logging/logrus - a Logrus-based logger for HTTP requests:
      • injects a request-scoped logrus.Entry into the http.Request.Context for further logging
      • optionally supports logging of inbound request content and response contents in raw or JSON format
Tripperware (client-side)

Tripperwares adhere to func (http.RoundTripper) http.RoundTripper signature, hence the name. As such they are used as a Transport for http.Client, and can wrap other transports.

This means that the composition is purely net/http-based. Since there are few (if any) libraries for this, the repository will have multiple useful libraries for making external calls.

The crucial package here is again http_ctxtags(tags/README.md) as it introduces a concept of a service name. This is either user-specified or automatically detected from the URL (for external calls), and is used as a key indicator in all other debugability handlers.

The tripperwares provided in this repo are:

  • Monitoring
  • Tracing
    • tracing/debug - /debug/request page for client-side HTTP request debugging, allowing you to inspect failed requests, outbound headers, payload sizes etc etc.
    • tracing/opentracing - client-side request Opentracing middleware that is tags-aware and supports propagation of traces from server-side middleware
  • Logging
    • logging/logrus - a Logrus-based logger for HTTP calls requests:
      • optionally supports logging of inbound request content and response contents in raw or JSON format
  • Retry
    • retry - a simple retry-middleware that retries on connectivity and bad response errors.
Generic building blocks

All the libraries included here are meant to be minimum-dependency based. As such the root of the package, http_wares contains helper libraries that allow for chaining and wrapping http.ResponseWriter objects. See documentation for more.

Status

This code is experimental and still considered a work in progress. It is meant to be the underpinnings of the Go HTTP stack at Improbable.

Additional tooling will be added, and contributions are welcome.

License

go-httpwares is released under the Apache 2.0 license. See the LICENSE file for details.

Documentation

Overview

`httpwares` is a collection of middlewares (server-side) and tripperwares (client-side) for vanilla Golang HTTP libs

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func WrapClient

func WrapClient(client *http.Client, wares ...Tripperware) *http.Client

WrapClient takes an http.Client and wraps its transport in the chain of tripperwares.

Types

type Middleware

type Middleware func(http.Handler) http.Handler

Middleware is signature of all http server-side middleware.

type RoundTripperFunc

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

RoundTripperFunc wraps a func to make it into a http.RoundTripper. Similar to http.HandleFunc.

func (RoundTripperFunc) RoundTrip

func (f RoundTripperFunc) RoundTrip(req *http.Request) (*http.Response, error)

type Tripperware

type Tripperware func(http.RoundTripper) http.RoundTripper

Tripperware is a signature for all http client-side middleware.

type WrappedResponseWriter

type WrappedResponseWriter interface {
	http.ResponseWriter
	// Status returns the HTTP status of the request, or 0 if one has not
	// yet been sent.
	StatusCode() int
	// MessageLength returns the size of the HTTP Response Message (after headers), as returned to the client.
	MessageLength() int

	// ObserveWriteHeader adds to the list of callbacks to be triggered when WriteHeader is executed.
	ObserveWriteHeader(func(t WrappedResponseWriter, code int))

	// ObserveWrite adds to the list of callbacks to be triggered when a Write() is executed.
	ObserveWrite(func(t WrappedResponseWriter, buf []byte, n int, err error))
}

WrappedResponseWriter is a wrapper around http.ResponseWriter that is useful for building middlewares.

If you want to instantiate this, please use `WrapResponseWriter` function.

func WrapResponseWriter

func WrapResponseWriter(w http.ResponseWriter) WrappedResponseWriter

WrapResponseWriter wraps the http.ResponseWriter in a helper thats useful for building middlewares.

This call *reuses* the existing WrappedResponseWriter, i.e. if it is already wrapped, the existing wrapper will be returned.

Directories

Path Synopsis
logrus
`http_logrus` is a HTTP logging middleware for the Logrus logging stack.
`http_logrus` is a HTTP logging middleware for the Logrus logging stack.
logrus/ctxlogrus
ctxlogrus allows you to store or extract a logrus logger from the context.
ctxlogrus allows you to store or extract a logrus logger from the context.
`http_metrics` provides client and server side reporting of HTTP stats.
`http_metrics` provides client and server side reporting of HTTP stats.
`http_retry` is a HTTP client-side Tripperware that allows you to retry requests that are marked as idempotent and safe.
`http_retry` is a HTTP client-side Tripperware that allows you to retry requests that are marked as idempotent and safe.
`http_ctxtags` adds a Tag object to the request's context that identifies it for other wares.
`http_ctxtags` adds a Tag object to the request's context that identifies it for other wares.
chi
tracing
debug
`http_debug` adds /debug/request debugging information for HTTP requests.
`http_debug` adds /debug/request debugging information for HTTP requests.
opentracing
`http_opentracing` adds OpenTracing wares for HTTP libraries.
`http_opentracing` adds OpenTracing wares for HTTP libraries.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL