logging

Documentation

Overview

Package logging provides a shared logger and log utilities to be used in all internal packages.

Index

• Variables
• func IdentityAwareMiddleware() gin.HandlerFunc
• func Logger(c *gin.Context) *zap.Logger
• func Middleware() gin.HandlerFunc
• func SetLevel(l string) error
• func SetServerLogger()
• func StandardErrorLog() *log.Logger
• func SugarLogger(c *gin.Context) *zap.SugaredLogger
• func WrappedLogger(c *gin.Context) *zap.Logger
• func WrappedSugarLogger(c *gin.Context) *zap.SugaredLogger

Variables

var (
	L                    = newLogger(level, os.Stderr)
	S *zap.SugaredLogger = L.Sugar()
)

Functions

func IdentityAwareMiddleware

func IdentityAwareMiddleware() gin.HandlerFunc

UserAwareLoggerMiddleware saves a request-specific logger to the context

func Logger

func Logger(c *gin.Context) *zap.Logger

Logger gets the request-specific logger from the context If a request-specific logger cannot be found, use the default logger

func Middleware

func Middleware() gin.HandlerFunc

Middleware logs incoming requests using configured logger

func SetLevel

func SetLevel(l string) error

SetLevel of the global loggers L and S.

func SetServerLogger

func SetServerLogger()

SetServerLogger changes L and S to a logger that is appropriate for long running processes like the api server and connectors. The logger uses json format and includes the function name and line number in the log message.

SetServerLogger should not be called concurrently. It should be called before any goroutines that may use the logger are started.

func StandardErrorLog

func StandardErrorLog() *log.Logger

func SugarLogger

func SugarLogger(c *gin.Context) *zap.SugaredLogger

Sugared variant of Logger

func WrappedLogger

func WrappedLogger(c *gin.Context) *zap.Logger

WrappedLogger skips the most recent caller Useful for functions that logs for callers

func WrappedSugarLogger

func WrappedSugarLogger(c *gin.Context) *zap.SugaredLogger

Sugared variant of WrappedLogger