batazor/go-auth

View on GitHub
utils/logger.go

Summary

Maintainability
A
0 mins
Test Coverage
package utils

import (
    "fmt"
    "net/http"
    "time"

    "github.com/go-chi/chi/middleware"
    "github.com/sirupsen/logrus"
)

var log = logrus.New()

func init() {
    // Logging =================================================================
    // Setup the logger backend using Sirupsen/logrus and configure
    // it to use a custom JSONFormatter. See the logrus docs for how to
    // configure the backend at github.com/Sirupsen/logrus
    log.Formatter = new(logrus.JSONFormatter)
}

// Error handler
func Error(w http.ResponseWriter, err error) {
    w.WriteHeader(http.StatusBadRequest)

    err_str := `{
        "error": ` + err.Error() + `
    }`

    w.Write([]byte(err_str))
    return
}

// StructuredLogger is a simple, but powerful implementation of a custom structured
// logger backed on logrus. I encourage users to copy it, adapt it and make it their
// own. Also take a look at https://github.com/pressly/lg for a dedicated pkg based
// on this work, designed for context-based http routers.

func NewStructuredLogger(logger *logrus.Logger) func(next http.Handler) http.Handler {
    return middleware.RequestLogger(&StructuredLogger{logger})
}

func (l *StructuredLogger) NewLogEntry(r *http.Request) middleware.LogEntry {
    entry := &StructuredLoggerEntry{Logger: logrus.NewEntry(l.Logger)}
    logFields := logrus.Fields{}

    if reqID := middleware.GetReqID(r.Context()); reqID != "" {
        logFields["req_id"] = reqID
    }

    scheme := "http"
    if r.TLS != nil {
        scheme = "https"
    }
    logFields["http_scheme"] = scheme
    logFields["http_proto"] = r.Proto
    logFields["http_method"] = r.Method

    logFields["remote_addr"] = r.RemoteAddr
    logFields["user_agent"] = r.UserAgent()

    logFields["uri"] = fmt.Sprintf("%s://%s%s", scheme, r.Host, r.RequestURI)

    entry.Logger = entry.Logger.WithFields(logFields)

    entry.Logger.Infoln("request started")

    return entry
}

func (l *StructuredLoggerEntry) Write(status, bytes int, elapsed time.Duration) {
    l.Logger = l.Logger.WithFields(logrus.Fields{
        "resp_status": status, "resp_bytes_length": bytes,
        "resp_elasped_ms": float64(elapsed.Nanoseconds()) / 1000000.0,
    })

    l.Logger.Infoln("request complete")
}

func (l *StructuredLoggerEntry) Panic(v interface{}, stack []byte) {
    l.Logger = l.Logger.WithFields(logrus.Fields{
        "stack": string(stack),
        "panic": fmt.Sprintf("%+v", v),
    })
}

// Helper methods used by the application to get the request-scoped
// logger entry and set additional fields between handlers.
//
// This is a useful pattern to use to set state on the entry as it
// passes through the handler chain, which at any point can be logged
// with a call to .Print(), .Info(), etc.

func GetLogEntry(r *http.Request) logrus.FieldLogger {
    entry := middleware.GetLogEntry(r).(*StructuredLoggerEntry)
    return entry.Logger
}

func LogEntrySetField(r *http.Request, key string, value interface{}) {
    if entry, ok := r.Context().Value(middleware.LogEntryCtxKey).(*StructuredLoggerEntry); ok {
        entry.Logger = entry.Logger.WithField(key, value)
    }
}

func LogEntrySetFields(r *http.Request, fields map[string]interface{}) {
    if entry, ok := r.Context().Value(middleware.LogEntryCtxKey).(*StructuredLoggerEntry); ok {
        entry.Logger = entry.Logger.WithFields(fields)
    }
}