logr

Documentation

Overview

Package logr provides a small adapter required to use logr in logging gRPC middlewares. Please see examples for examples of use.

Example (InitializationWithCustomLevels)

// Logger is used, allowing pre-definition of certain fields by the user.
logger := klog.NewKlogr()
// Shared options for the logger, with a custom gRPC code to log level function.
opts := []logging.Option{
	logging.WithLevels(customFunc),
}
// Create a server, make sure we put the tags context before everything else.
_ = grpc.NewServer(
	middleware.WithUnaryServerChain(
		logging.UnaryServerInterceptor(grpclogr.InterceptorLogger(logger), opts...),
	),
	middleware.WithStreamServerChain(
		logging.StreamServerInterceptor(grpclogr.InterceptorLogger(logger), opts...),
	),
)

Example (InitializationWithDurationFieldOverride)

// Logger is used, allowing pre-definition of certain fields by the user.
logger := klog.NewKlogr()
// Shared options for the logger, with a custom duration to log field function.
opts := []logging.Option{
	logging.WithDurationField(customDurationToFields),
}
// Create a server, make sure we put the tags context before everything else.
_ = grpc.NewServer(
	middleware.WithUnaryServerChain(
		logging.UnaryServerInterceptor(grpclogr.InterceptorLogger(logger), opts...),
	),
	middleware.WithStreamServerChain(
		logging.StreamServerInterceptor(grpclogr.InterceptorLogger(logger), opts...),
	),
)

Index

• type Logger
  • func InterceptorLogger(logger logr.Logger) *Logger
  • func (l *Logger) Log(lvl logging.Level, msg string)
  • func (l *Logger) With(fields ...string) logging.Logger

Examples

• Package (InitializationWithCustomLevels)
• Package (InitializationWithDurationFieldOverride)

Types

type Logger

type Logger struct {
	logr.Logger
}

Logger is a logr logging adapter compatible with logging middlewares.

func InterceptorLogger

func InterceptorLogger(logger logr.Logger) *Logger

InterceptorLogger converts zap logger to Logger adapter.

func (*Logger) Log

func (l *Logger) Log(lvl logging.Level, msg string)

Log implements logging.Logger interface.

func (*Logger) With

func (l *Logger) With(fields ...string) logging.Logger

With implements logging.Logger interface.