logging: Add doc about which fields can't be filtered

Matthew Holt committed Jan 1, 2020 at 13:56 UTC a6df4cdbbca673bf3a2ff1bc2369a887c6953b93

1 file changed +5

modules/logging/filterencoder.go

@@ -44,6 +44,11 @@ type FilterEncoder struct {

44 // layer of nesting with `>`. In other words, for an

45 // object like `{"a":{"b":0}}`, the inner field can

46 // be referenced as `a>b`.

47 + //

48 + // The following fields are fundamental to the log and

49 + // cannot be filtered because they are added by the

50 + // underlying logging library as special cases: ts,

51 + // level, logger, and msg.

52 FieldsRaw map[string]json.RawMessage `json:"fields,omitempty" caddy:"namespace=caddy.logging.encoders.filter inline_key=filter"`

54 wrapped zapcore.Encoder