mirror of
https://github.com/fnproject/fn.git
synced 2022-10-28 21:29:17 +03:00
e637661ea2
* 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
66 lines
1.5 KiB
Go
66 lines
1.5 KiB
Go
package ctxlogrus
|
|
|
|
import (
|
|
"github.com/grpc-ecosystem/go-grpc-middleware/tags"
|
|
"github.com/sirupsen/logrus"
|
|
"golang.org/x/net/context"
|
|
)
|
|
|
|
type ctxLoggerMarker struct{}
|
|
|
|
type ctxLogger struct {
|
|
logger *logrus.Entry
|
|
fields logrus.Fields
|
|
}
|
|
|
|
var (
|
|
ctxLoggerKey = &ctxLoggerMarker{}
|
|
)
|
|
|
|
// AddFields adds logrus fields to the logger.
|
|
func AddFields(ctx context.Context, fields logrus.Fields) {
|
|
l, ok := ctx.Value(ctxLoggerKey).(*ctxLogger)
|
|
if !ok || l == nil {
|
|
return
|
|
}
|
|
for k, v := range fields {
|
|
l.fields[k] = v
|
|
}
|
|
}
|
|
|
|
// 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 Extract(ctx context.Context) *logrus.Entry {
|
|
l, ok := ctx.Value(ctxLoggerKey).(*ctxLogger)
|
|
if !ok || l == nil {
|
|
return logrus.NewEntry(nullLogger)
|
|
}
|
|
|
|
fields := logrus.Fields{}
|
|
|
|
// Add grpc_ctxtags tags metadata until now.
|
|
tags := grpc_ctxtags.Extract(ctx)
|
|
for k, v := range tags.Values() {
|
|
fields[k] = v
|
|
}
|
|
|
|
// Add logrus fields added until now.
|
|
for k, v := range l.fields {
|
|
fields[k] = v
|
|
}
|
|
|
|
return l.logger.WithFields(fields)
|
|
}
|
|
|
|
// ToContext adds the logrus.Entry to the context for extraction later.
|
|
// Returning the new context that has been created.
|
|
func ToContext(ctx context.Context, entry *logrus.Entry) context.Context {
|
|
l := &ctxLogger{
|
|
logger: entry,
|
|
fields: logrus.Fields{},
|
|
}
|
|
return context.WithValue(ctx, ctxLoggerKey, l)
|
|
}
|