logrus

grpc_logrus

-- import "github.com/mwitkow/go-grpc-middleware/logging/logrus"

grpc_logrus is a gRPC logging middleware backed by Logrus loggers

It accepts a user-configured logrus.Entry that will be used for logging completed gRPC calls. The same logrus.Entry will be used for logging completed gRPC calls, and be populated into the context.Context passed into gRPC handler code.

You can use Extract to log into a request-scoped logrus.Entry instance in your handler code. AddFields adds new fields to the request-scoped logrus.Entry. They will be propagated for all call depending on the context, including the interceptor's own "finished RPC" log message.

Logrus can also be made as a backend for gRPC library internals. For that use ReplaceGrpcLogger.

Please see examples and tests for examples of use.

Usage

var (
	// SystemField is used in every log statement made through grpc_logrus. Can be overwritten before any initialization code.
	SystemField = "system"
)

func AddFields

func AddFields(ctx context.Context, fields logrus.Fields)

AddFields adds logrus.Fields to all usages of the logger, both upstream (to handler) and downstream (to interceptor).

This call is not concurrency safe. It should only be used in the request goroutine: in other interceptors or directly in the handler.

func DefaultCodeToLevel

func DefaultCodeToLevel(code codes.Code) logrus.Level

DefaultCodeToLevel is the default implementation of gRPC return codes and interceptor log level.

func Extract

func Extract(ctx context.Context) *logrus.Entry

Extract takes the call-scoped logrus.Entry from grpc_logrus middleware.

If the grpc_logrus middleware wasn't used, a no-op logrus.Entry is returned. This makes it safe to use regardless.

func ReplaceGrpcLogger

func ReplaceGrpcLogger(logger *logrus.Entry)

ReplaceGrpcLogger sets the given logrus.Logger as a gRPC-level logger. This should be called before any other initialization, preferably from init() functions.

func StreamServerInterceptor

func StreamServerInterceptor(entry *logrus.Entry, opts ...Option) grpc.StreamServerInterceptor

StreamServerInterceptor returns a new streaming server interceptor that adds logrus.Entry to the context.

func UnaryServerInterceptor

func UnaryServerInterceptor(entry *logrus.Entry, opts ...Option) grpc.UnaryServerInterceptor

UnaryServerInterceptor returns a new unary server interceptors that adds logrus.Entry to the context.

type CodeToLevel

type CodeToLevel func(code codes.Code) logrus.Level

CodeToLevel function defines the mapping between gRPC return codes and interceptor log level.

type Option

type Option func(*options)

func WithFieldExtractor

func WithFieldExtractor(f grpc_logging.RequestLogFieldExtractorFunc) Option

WithFieldExtractor customizes the function for extracting log fields from protobuf messages.

func WithLevels

func WithLevels(f CodeToLevel) Option

WithLevels customizes the function for mapping gRPC return codes and interceptor log level statements.

func WithCodes

func WithCodes(f grpc_logging.ErrorToCode) Option

WithCodes customizes the function for mapping errors to error codes.