HTTP middleware for Go that logs web requests to an io.Writer with support for additional fields and formats (Fork of https://github.com/unrolled/logger)
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
James Mills 2e50da4645
Update CHANGELOG for 0.0.3
1 month ago
.chglog Hard Fork 1 month ago
.github/workflows Fix run on 2 years ago
tests Add support for logging the request host header (virtual hosts) 1 month ago
tools Fix release tool (3rd time's the charm) 1 month ago
.drone.yml Hard Fork 1 month ago
.gitignore Hard Fork 1 month ago
CHANGELOG.md Update CHANGELOG for 0.0.3 1 month ago
LICENSE Hard Fork 1 month ago
LICENSE.old Hard Fork 1 month ago
Makefile Hard Fork 1 month ago
README.md Hard Fork 1 month ago
doc.go Hard Fork 1 month ago
go.mod Hard Fork 1 month ago
logger.go Add support for logging the request host header (virtual hosts) 1 month ago
options.go Add support for logging the request host header (virtual hosts) 1 month ago

README.md

logger

Build Status Go Report Card Go Reference License: MIT

logger is an HTTP middleware for Go that logs web requests to an io.Writer (the default being os.Stdout). It's a standard net/http Handler, and can be used with many frameworks or directly with Go's net/http package.

Usage

// main.go
package main

import (
    "log"
    "net/http"

    "go.mills.io/logger"
)

var myHandler = http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
    w.Write([]byte("hello world"))
})

func main() {
    loggerWithConfigMiddleware := logger.New(logger.Options{
        Prefix: "MySampleWebApp",
        RemoteAddressHeaders: []string{"X-Forwarded-For"},
        OutputFlags: log.LstdFlags,
    })

    // loggerWithDefaults := logger.New()

    app := loggerMiddleware.Handler(myHandler)
    http.ListenAndServe("0.0.0.0:3000", app)
}

A simple GET request to "/info/" will output:

[MySampleWebApp] 2014/11/21 14:11:21 (12.34.56.78) "GET /info/ HTTP/1.1" 200 11 12.54µs

Here's a breakdown of what the values mean: [SuppliedPrefix] Date Time (RemoteIP) "Method RequestURI Protocol" StatusCode Size Time. Note that the Date Time is controlled by the output flags. See http://golang.org/pkg/log/#pkg-constants.

Be sure to use the Logger middleware as the very first handler in the chain. This will ensure that your subsequent handlers (like Recovery) will always be logged.

Available Options

Logger comes with a variety of configuration options (Note: these are not the default option values. See the defaults below.):

// ...
l := logger.New(logger.Options{
    Prefix: "myApp", // Prefix is the outputted keyword in front of the log message. Logger automatically wraps the prefix in square brackets (ie. [myApp] ) unless the `DisableAutoBrackets` is set to true. A blank value will not have brackets added. Default is blank (with no brackets).
    DisableAutoBrackets: false, // DisableAutoBrackets if set to true, will remove the prefix and square brackets. Default is false.
    RemoteAddressHeaders: []string{"X-Forwarded-For"}, // RemoteAddressHeaders is a list of header keys that Logger will look at to determine the proper remote address. Useful when using a proxy like Nginx: `[]string{"X-Forwarded-For"}`. Default is an empty slice, and thus will use `reqeust.RemoteAddr`.
    Out: os.Stdout, // Out is the destination to which the logged data will be written too. Default is `os.Stdout`.
    OutputFlags: log.Ldate | log.Ltime, // OutputFlags defines the logging properties. See http://golang.org/pkg/log/#pkg-constants. To disable all flags, set this to `-1`. Defaults to log.LstdFlags (2009/01/23 01:23:23).
    IgnoredRequestURIs: []string{"/favicon.ico"}, // IgnoredRequestURIs is a list of path values we do not want logged out. Exact match only!
})
// ...

Default Options

These are the preset options for Logger:

l := logger.New()

// Is the same as the default configuration options:

l := logger.New(logger.Options{
    Prefix: "",
    DisableAutoBrackets: false,
    RemoteAddressHeaders: []string{},
    Out: os.Stdout,
    OutputFlags log.LstdFlags,
    IgnoredRequestURIs: []string{},
})

Capturing the proper remote address

If your app is behind a load balancer or proxy, the default Request.RemoteAddr will likely be wrong. To ensure you're logging the correct IP address, you can set the RemoteAddressHeaders option to a list of header names you'd like to use. Logger will iterate over the slice and use the first header value it finds. If it finds none, it will default to the Request.RemoteAddr.

package main

import (
    "log"
    "net/http"

    "github.com/unrolled/logger"
)

var myHandler = http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
    w.Write([]byte("hello world"))
})

func main() {
    loggerWithConfigMiddleware := logger.New(logger.Options{
        RemoteAddressHeaders: []string{"X-Real-IP", "X-Forwarded-For"},
    })

    app := loggerMiddleware.Handler(myHandler)
    http.ListenAndServe("0.0.0.0:3000", app)
}

License

logger is licensed under ther terms of the MIT License (originally based off of @unrolled's logger also licensed under an MIT License).