Files
fn-serverless/vendor/github.com/grpc-ecosystem/go-grpc-middleware/logging/logrus/ctxlogrus
Andrea Rosa e637661ea2 Adding a way to inject a request ID (#1046)
* Adding a way to inject a request ID

It is very useful to associate a request ID to each incoming request,
this change allows to provide a function to do that via Server Option.
The change comes with a default function which will generate a new
request ID. The request ID is put in the request context along with a
common logger which always logs the request-id

We add gRPC interceptors to the server so it can get the request ID out
of the gRPC metadata and put it in the common logger stored in the
context so as all the log lines using the common logger from the context
will have the request ID logged
2018-06-14 10:40:55 +01:00
..

ctx_logrus

import "github.com/grpc-ecosystem/go-grpc-middleware/tags/logrus"

Overview

ctx_logrus is a ctxlogger that is backed by logrus

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

You can use ctx_logrus.Extract to log into a request-scoped logrus.Logger instance in your handler code.

As ctx_logrus.Extract will iterate all tags on from grpc_ctxtags it is therefore expensive so it is advised that you extract once at the start of the function from the context and reuse it for the remainder of the function (see examples).

Please see examples and tests for examples of use.

Imported Packages

Index

Package files

context.go doc.go noop.go

func AddFields

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

AddFields adds logrus fields to the logger.

func Extract

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

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

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

func ToContext

func ToContext(ctx context.Context, entry *logrus.Entry) context.Context

ToContext adds the logrus.Entry to the context for extraction later. Returning the new context that has been created.


Generated by godoc2ghmd