History

Jhon Honce deaf969243 Refacter API server emphasis on logging * To aid in debugging log API request and response bodies at trace level. Events can be correlated using the X-Reference-Id. * Server now echos X-Reference-Id from client if set, otherwise generates an unique id. * Move logic for X-Reference-Id into middleware * Change uses of Header.Add() to Set() when setting Content-Type * Log API operations in Apache format using gorilla middleware * Port server code to use BaseContext and ConnContext Fixes #10053 Signed-off-by: Jhon Honce <jhonce@redhat.com>		2021-09-10 15:07:25 -07:00
..
.travis.yml	Refacter API server emphasis on logging	2021-09-10 15:07:25 -07:00
LICENSE	Refacter API server emphasis on logging	2021-09-10 15:07:25 -07:00
README.md	Refacter API server emphasis on logging	2021-09-10 15:07:25 -07:00
canonical.go	Refacter API server emphasis on logging	2021-09-10 15:07:25 -07:00
compress.go	Refacter API server emphasis on logging	2021-09-10 15:07:25 -07:00
doc.go	Refacter API server emphasis on logging	2021-09-10 15:07:25 -07:00
handlers.go	Refacter API server emphasis on logging	2021-09-10 15:07:25 -07:00
proxy_headers.go	Refacter API server emphasis on logging	2021-09-10 15:07:25 -07:00

README.md

gorilla/handlers

Package handlers is a collection of handlers (aka "HTTP middleware") for use with Go's net/http package (or any framework supporting http.Handler), including:

LoggingHandler for logging HTTP requests in the Apache Common Log Format.
CombinedLoggingHandler for logging HTTP requests in the Apache Combined Log Format commonly used by both Apache and nginx.
CompressHandler for gzipping responses.
ContentTypeHandler for validating requests against a list of accepted content types.
MethodHandler for matching HTTP methods against handlers in a map[string]http.Handler
ProxyHeaders for populating r.RemoteAddr and r.URL.Scheme based on the X-Forwarded-For, X-Real-IP, X-Forwarded-Proto and RFC7239 Forwarded headers when running a Go server behind a HTTP reverse proxy.
CanonicalHost for re-directing to the preferred host when handling multiple domains (i.e. multiple CNAME aliases).

Other handlers are documented on the Gorilla website.

Example

A simple example using handlers.LoggingHandler and handlers.CompressHandler:

import (
    "net/http"
    "github.com/gorilla/handlers"
)

func main() {
    r := http.NewServeMux()

    // Only log requests to our admin dashboard to stdout
    r.Handle("/admin", handlers.LoggingHandler(os.Stdout, http.HandlerFunc(ShowAdminDashboard)))
    r.HandleFunc("/", ShowIndex)

    // Wrap our server with our gzip handler to gzip compress all responses.
    http.ListenAndServe(":8000", handlers.CompressHandler(r))
}

License

BSD licensed. See the included LICENSE file for details.