requestlog

Documentation

Overview

Copyright 2023 Northern.tech AS

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Index

• func GetRequestLogger(r *rest.Request) *log.Logger
• func SetRequestLogger(r *rest.Request, l *log.Logger) *rest.Request
• type RequestLogMiddleware
  • func (mw *RequestLogMiddleware) MiddlewareFunc(h rest.HandlerFunc) rest.HandlerFunc

Functions

func GetRequestLogger

func GetRequestLogger(r *rest.Request) *log.Logger

GetRequestLogger will return a logger associated with the request.

func SetRequestLogger

func SetRequestLogger(r *rest.Request, l *log.Logger) *rest.Request

SetRequestLogger assigns logger l to request r by putting it in request context.

Types

type RequestLogMiddleware

type RequestLogMiddleware struct {
	BaseLogger *logrus.Logger
	LogContext log.Ctx
}

RequestLogMiddleware creates a per-request logger and sticks it into http.Request context. The logger will be ready to use in the handler (less boilerplate). Other middlewares (notably requestid) may add context to the log. Per-request loggers will by default be derived from the global log.Log, unless BaseLogger is specified. In that case, it will serve as the root logger. Additional context can be attached by setting LogContext field.

func (*RequestLogMiddleware) MiddlewareFunc

func (mw *RequestLogMiddleware) MiddlewareFunc(h rest.HandlerFunc) rest.HandlerFunc

MiddlewareFunc makes RequestLogMiddleware implement the Middleware interface.