summaryrefslogtreecommitdiff
path: root/modules/logging
diff options
context:
space:
mode:
authorMatthew Holt <mholt@users.noreply.github.com>2020-01-01 13:56:27 -0700
committerMatthew Holt <mholt@users.noreply.github.com>2020-01-03 15:28:05 -0700
commita6df4cdbbca673bf3a2ff1bc2369a887c6953b93 (patch)
tree0a8bc2ee7de8e3558b4494b2e0242af23da01840 /modules/logging
parentdff78d82ce21d97cad53171b72b88550e02c2c7f (diff)
logging: Add doc about which fields can't be filtered
Diffstat (limited to 'modules/logging')
-rw-r--r--modules/logging/filterencoder.go5
1 files changed, 5 insertions, 0 deletions
diff --git a/modules/logging/filterencoder.go b/modules/logging/filterencoder.go
index 36823fa..7a8108c 100644
--- a/modules/logging/filterencoder.go
+++ b/modules/logging/filterencoder.go
@@ -44,6 +44,11 @@ type FilterEncoder struct {
// layer of nesting with `>`. In other words, for an
// object like `{"a":{"b":0}}`, the inner field can
// be referenced as `a>b`.
+ //
+ // The following fields are fundamental to the log and
+ // cannot be filtered because they are added by the
+ // underlying logging library as special cases: ts,
+ // level, logger, and msg.
FieldsRaw map[string]json.RawMessage `json:"fields,omitempty" caddy:"namespace=caddy.logging.encoders.filter inline_key=filter"`
wrapped zapcore.Encoder