README
¶
ctxlog
Create wide log events in Go programs.
When requests first hit your system, use the New constructor to create a request logger and inject it into a context in one motion. During request processing, use the From constructor to extract the logger from the context and add keyvals. At the end of request processing, use Keyvals to get all of the added data and report it somewhere.
import (
"github.com/go-kit/kit/log"
"github.com/peterbourgon/ctxlog"
)
func handleRequest(ctx context.Context, ..., logger log.Logger) {
subctx, ctxlogger := ctxlog.New(ctx)
process(subctx)
logger.Log(ctxlogger.Keyvals()...)
}
Package ctxlog comes with a default HTTP middleware that does this setup and teardown work for you, and adds a few useful default keyvals.
var h http.Handler
{
h = myHandler
h = ctxlog.NewHTTPMiddleware(h, logger)
}
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type HTTPMiddleware ¶
type HTTPMiddleware struct {
// contains filtered or unexported fields
}
HTTPMiddleware uses the Logger to implement basic structured request logging.
func NewHTTPMiddleware ¶
func NewHTTPMiddleware(next http.Handler, logger log.Logger) *HTTPMiddleware
NewHTTPMiddleware wraps an http.Handler and a log.Logger, and performs structured request logging.
func (*HTTPMiddleware) ServeHTTP ¶
func (mw *HTTPMiddleware) ServeHTTP(w http.ResponseWriter, r *http.Request)
ServeHTTP implements http.Handler.
type Logger ¶
type Logger struct {
// contains filtered or unexported fields
}
Logger satisfies log.Logger and is designed to be constructed into a context via New. Components can retrieve it from the context via From, and use the Log method to append keyvals. The entrypoint (e.g. an http.Handler) should Flush at the end of its lifecycle (e.g. the end of the request).
func New ¶
New is a helper function to create a new Logger, log the initial set of keyvals, inject it into a context, and return everything, all in one motion.
Source Files