1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203
|
// Copyright (c) The go-grpc-middleware Authors.
// Licensed under the Apache License 2.0.
package logging
import (
"context"
"github.com/grpc-ecosystem/go-grpc-middleware/v2/interceptors"
)
var (
// SystemTag is tag representing an event inside gRPC call.
SystemTag = []string{"protocol", "grpc"}
// ComponentFieldKey is a tag representing the client/server that is calling.
ComponentFieldKey = "grpc.component"
KindServerFieldValue = "server"
KindClientFieldValue = "client"
ServiceFieldKey = "grpc.service"
MethodFieldKey = "grpc.method"
MethodTypeFieldKey = "grpc.method_type"
)
type fieldsCtxMarker struct{}
var (
// fieldsCtxMarkerKey is the Context value marker that is used by logging middleware to read and write logging fields into context.
fieldsCtxMarkerKey = &fieldsCtxMarker{}
)
func newCommonFields(kind string, c interceptors.CallMeta) Fields {
return Fields{
SystemTag[0], SystemTag[1],
ComponentFieldKey, kind,
ServiceFieldKey, c.Service,
MethodFieldKey, c.Method,
MethodTypeFieldKey, string(c.Typ),
}
}
// disableCommonLoggingFields returns copy of newCommonFields with disabled fields removed from the following
// default list. The following are the default logging fields:
// - SystemTag[0]
// - ComponentFieldKey
// - ServiceFieldKey
// - MethodFieldKey
// - MethodTypeFieldKey
func disableCommonLoggingFields(kind string, c interceptors.CallMeta, disableFields []string) Fields {
commonFields := newCommonFields(kind, c)
for _, key := range disableFields {
commonFields.Delete(key)
}
return commonFields
}
// Fields loosely represents key value pairs that adds context to log lines. The key has to be type of string, whereas
// value can be an arbitrary object.
type Fields []any
// Iterator returns iterator that allows iterating over pair of elements representing field.
// If number of elements is uneven, last element won't be included will be assumed as key with empty string value.
// If key is not string, At will panic.
func (f Fields) Iterator() *iter {
// We start from -2 as we iterate over two items per iteration and first iteration will advance iterator to 0.
return &iter{i: -2, f: f}
}
type iter struct {
f Fields
i int
}
func (i *iter) Next() bool {
if i.i >= len(i.f) {
return false
}
i.i += 2
return i.i < len(i.f)
}
func (i *iter) At() (k string, v any) {
if i.i < 0 || i.i >= len(i.f) {
return "", ""
}
if i.i+1 == len(i.f) {
// Non even number of elements, add empty string.
return i.f[i.i].(string), ""
}
return i.f[i.i].(string), i.f[i.i+1]
}
func (f *Fields) Delete(key string) {
i := f.Iterator()
for i.Next() {
k, _ := i.At()
if k != key {
continue
}
*f = append((*f)[:i.i], (*f)[i.i+2:]...)
return
}
}
// WithUnique returns copy of fields which is the union of all unique keys.
// Any duplicates in the added or current fields will be deduplicated where first occurrence takes precedence.
func (f Fields) WithUnique(add Fields) Fields {
if len(add) == 0 {
n := make(Fields, len(f))
copy(n, f)
return n
}
existing := map[any]struct{}{}
i := f.Iterator()
for i.Next() {
k, _ := i.At()
existing[k] = struct{}{}
}
n := make(Fields, len(f), len(f)+len(add))
copy(n, f)
a := add.Iterator()
for a.Next() {
k, v := a.At()
if _, ok := existing[k]; ok {
continue
}
n = append(n, k, v)
}
return n
}
// AppendUnique appends (can reuse array!) fields which does not occur in existing fields slice.
func (f Fields) AppendUnique(add Fields) Fields {
if len(add) == 0 {
return f
}
a := add.Iterator()
NextAddField:
for a.Next() {
k, v := a.At()
i := f.Iterator()
for i.Next() {
fk, _ := i.At()
if fk == k {
continue NextAddField
}
}
f = append(f, k, v)
}
return f
}
// ExtractFields returns logging fields from the context.
// Fields can be added from the context using InjectFields. For example logging interceptor adds some (base) fields
// into context when used.
// If there are no fields in the context, it returns an empty Fields value.
// Extracted fields are useful to construct your own logger that has fields from gRPC interceptors.
func ExtractFields(ctx context.Context) Fields {
t, ok := ctx.Value(fieldsCtxMarkerKey).(Fields)
if !ok {
return nil
}
n := make(Fields, len(t))
copy(n, t)
return n
}
// InjectFields allows adding fields to any existing Fields that will be used by the logging interceptor or can be
// extracted further in ExtractFields.
// For explicitness, in case of duplicates, the newest field occurrence wins. This allows nested components to update
// popular fields like grpc.component (e.g. server invoking gRPC client).
//
// Don't overuse mutation of fields to avoid surprises.
func InjectFields(ctx context.Context, f Fields) context.Context {
return context.WithValue(ctx, fieldsCtxMarkerKey, f.WithUnique(ExtractFields(ctx)))
}
// InjectLogField is like InjectFields, just for one field.
func InjectLogField(ctx context.Context, key string, val any) context.Context {
return InjectFields(ctx, Fields{key, val})
}
// Logger requires Log method, similar to experimental slog, allowing logging interceptor to be interoperable. Official
// adapters for popular loggers are in `provider/` directory (separate modules). It's totally ok to copy simple function
// implementation over.
// TODO(bwplotka): Once slog is official, we could use slog method directly. Currently level is copied over, so we don't
// depend on experimental module.
// interface used for all our interceptors.
type Logger interface {
Log(ctx context.Context, level Level, msg string, fields ...any)
}
// LoggerFunc is a function that also implements Logger interface.
type LoggerFunc func(ctx context.Context, level Level, msg string, fields ...any)
func (f LoggerFunc) Log(ctx context.Context, level Level, msg string, fields ...any) {
f(ctx, level, msg, fields...)
}
|