diff options
| author | Patrick Cloke <clokep@users.noreply.github.com> | 2021-06-16 14:18:02 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-06-16 19:18:02 +0100 |
| commit | 18edc9ab06d8ed07c1cac918057226fad18030ce (patch) | |
| tree | 8808e6d9e3c3472d0466882523ecc1fc2a11cb50 /synapse | |
| parent | Always require users to re-authenticate for dangerous operations. (#10184) (diff) | |
| download | synapse-18edc9ab06d8ed07c1cac918057226fad18030ce.tar.xz | |
Improve comments in the structured logging code. (#10188)
Diffstat (limited to 'synapse')
| -rw-r--r-- | synapse/logging/_terse_json.py | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/synapse/logging/_terse_json.py b/synapse/logging/_terse_json.py index 8002a250a2..6e82f7c7f1 100644 --- a/synapse/logging/_terse_json.py +++ b/synapse/logging/_terse_json.py @@ -20,8 +20,9 @@ import logging _encoder = json.JSONEncoder(ensure_ascii=False, separators=(",", ":")) -# The properties of a standard LogRecord. -_LOG_RECORD_ATTRIBUTES = { +# The properties of a standard LogRecord that should be ignored when generating +# JSON logs. +_IGNORED_LOG_RECORD_ATTRIBUTES = { "args", "asctime", "created", @@ -59,9 +60,9 @@ class JsonFormatter(logging.Formatter): return self._format(record, event) def _format(self, record: logging.LogRecord, event: dict) -> str: - # Add any extra attributes to the event. + # Add attributes specified via the extra keyword to the logged event. for key, value in record.__dict__.items(): - if key not in _LOG_RECORD_ATTRIBUTES: + if key not in _IGNORED_LOG_RECORD_ATTRIBUTES: event[key] = value return _encoder.encode(event) |