ctxlogrus

ctx_logrus

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

• Overview
• Imported Packages
• Index

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

• github.com/grpc-ecosystem/go-grpc-middleware/tags
• github.com/sirupsen/logrus
• golang.org/x/net/context

Index

• func AddFields(ctx context.Context, fields logrus.Fields)
• func Extract(ctx context.Context) *logrus.Entry
• func ToContext(ctx context.Context, entry *logrus.Entry) context.Context

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