README
¶
negroni-logrus
logrus middleware for negroni
Usage
Take a peek at the basic example or the custom
example, the latter of which includes setting a
custom log level on the logger with NewCustomMiddleware.
If you want to reuse an already initialized logrus.Logger, you should be using
NewMiddlewareFromLogger (see existinglogrus).
Documentation
¶
Index ¶
- func AddWriterToContext(ctx context.Context, rw http.ResponseWriter) context.Context
- func DefaultAfter(entry *logrus.Entry, res negroni.ResponseWriter, latency time.Duration, ...) *logrus.Entry
- func DefaultBefore(entry *logrus.Entry, req *http.Request, remoteAddr string) *logrus.Entry
- func Extract(ctx context.Context) *logrus.Entry
- func ExtractWriter(ctx context.Context) http.ResponseWriter
- func ToContext(ctx context.Context, entry *logrus.Entry) context.Context
- type AfterFunc
- type BeforeFunc
- type Middleware
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AddWriterToContext ¶
AddWriterToContext adds ResponseWriter to the context for extraction later. Returning the new context that has been created.
func DefaultAfter ¶
func DefaultAfter(entry *logrus.Entry, res negroni.ResponseWriter, latency time.Duration, name string) *logrus.Entry
DefaultAfter is the default func assigned to *Middleware.After
func DefaultBefore ¶
DefaultBefore is the default func assigned to *Middleware.Before
func Extract ¶
Extract takes the call-scoped logrus.Entry from ctx_logrus middleware.
If the ctx_logrus middleware wasn't used, a no-op `logrus.Entry` is returned. This makes it safe to use regardless.
func ExtractWriter ¶
func ExtractWriter(ctx context.Context) http.ResponseWriter
ExtractWriter extracts ResponseWriter
Types ¶
type AfterFunc ¶
AfterFunc is the func type used to modify or replace the *logrus.Entry after calling the next func in the middleware chain
type BeforeFunc ¶
BeforeFunc is the func type used to modify or replace the *logrus.Entry prior to calling the next func in the middleware chain
type Middleware ¶
type Middleware struct {
// Logger is the log.Logger instance used to log messages with the Logger middleware
Logger *logrus.Logger
// Name is the name of the application as recorded in latency metrics
Name string
Before func(*logrus.Entry, *http.Request, string) *logrus.Entry
After func(*logrus.Entry, negroni.ResponseWriter, time.Duration, string) *logrus.Entry
// contains filtered or unexported fields
}
Middleware is a middleware handler that logs the request as it goes in and the response as it goes out.
func NewCustomMiddleware ¶
NewCustomMiddleware builds a *Middleware with the given level and formatter
func NewMiddlewareFromLogger ¶
func NewMiddlewareFromLogger(logger *logrus.Logger, name string) *Middleware
NewMiddlewareFromLogger returns a new *Middleware which writes to a given logrus logger.
func (*Middleware) ExcludeURL ¶
func (m *Middleware) ExcludeURL(u string) error
ExcludeURL adds a new URL u to be ignored during logging. The URL u is parsed, hence the returned error
func (*Middleware) ExcludedURLs ¶
func (m *Middleware) ExcludedURLs() []string
ExcludedURLs returns the list of excluded URLs for this middleware
func (*Middleware) ServeHTTP ¶
func (m *Middleware) ServeHTTP(rw http.ResponseWriter, r *http.Request, next http.HandlerFunc)
func (*Middleware) SetLogStarting ¶
func (m *Middleware) SetLogStarting(v bool)
SetLogStarting accepts a bool to control the logging of "started handling request" prior to passing to the next middleware
Source Files
Directories