accesslog

Documentation

Overview

Copyright 2024 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

• Constants
• func Middleware() gin.HandlerFunc
• type AccessLogFormat
• type AccessLogMiddleware
  • func (mw *AccessLogMiddleware) LogFunc(ctx context.Context, startTime time.Time, w rest.ResponseWriter, ...)
  • func (mw *AccessLogMiddleware) MiddlewareFunc(h rest.HandlerFunc) rest.HandlerFunc
• type AccessLogger
  • func (a AccessLogger) LogFunc(ctx context.Context, c *gin.Context, startTime time.Time)
  • func (a AccessLogger) Middleware(c *gin.Context)
• type LogContext
  • func GetContext(ctx context.Context) LogContext

Constants

const (
	StatusClientClosedConnection = 499

	// nolint:lll
	DefaultLogFormat = "%t %S\033[0m \033[36;1m%Dμs\033[0m \"%r\" \033[1;30m%u \"%{User-Agent}i\"\033[0m"
	SimpleLogFormat  = "%s %Dμs %r %u %{User-Agent}i"
)

const (
	DefaultMaxErrors = 5
)

const MaxTraceback = 32

Functions

func Middleware

func Middleware() gin.HandlerFunc

Middleware provides accesslog middleware for the gin-gonic framework. This middleware will recover any panic from occurring in the API handler and log it to error level with panic and trace showing the panic message and traceback respectively. If an error status is returned in the response, the middleware tries to pop the topmost error from the gin.Context (c.Error) and puts it in the "error" context to the final log entry.

Types

type AccessLogFormat

type AccessLogFormat string

type AccessLogMiddleware

type AccessLogMiddleware struct {
	// Format is not used but kept for historical use.
	// FIXME(QA-673): Remove unused attributes and properties from package.
	Format AccessLogFormat // nolint:unused

	ClientIPHook func(req *http.Request) net.IP
	DisableLog   func(statusCode int, r *rest.Request) bool
	// contains filtered or unexported fields
}

AccesLogMiddleware uses logger from requestlog and adds a fixed set of fields to every accesslog records.

func (*AccessLogMiddleware) LogFunc

func (mw *AccessLogMiddleware) LogFunc(
	ctx context.Context, startTime time.Time,
	w rest.ResponseWriter, r *rest.Request)

func (*AccessLogMiddleware) MiddlewareFunc

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

MiddlewareFunc makes AccessLogMiddleware implement the Middleware interface.

type AccessLogger

type AccessLogger struct {
	DisableLog   func(c *gin.Context) bool
	ClientIPHook func(r *http.Request) net.IP
}

func (AccessLogger) LogFunc

func (a AccessLogger) LogFunc(
	ctx context.Context,
	c *gin.Context,
	startTime time.Time,
)

func (AccessLogger) Middleware

func (a AccessLogger) Middleware(c *gin.Context)

type LogContext

type LogContext interface {
	PushError(err error) bool
	SetField(key string, value interface{})
}

func GetContext

func GetContext(ctx context.Context) LogContext