diff options
| author | Matthew Hodgson <matthew@matrix.org> | 2016-05-04 12:19:04 +0100 |
|---|---|---|
| committer | Matthew Hodgson <matthew@matrix.org> | 2016-05-04 12:19:04 +0100 |
| commit | 8a04412fa1e837d733302038c64854ba0766efc0 (patch) | |
| tree | 0d0ea77043cce24b77927ee678fba01af873e181 | |
| parent | Merge pull request #757 from matrix-org/erikj/event_auth_typo (diff) | |
| download | synapse-8a04412fa1e837d733302038c64854ba0766efc0.tar.xz | |
starting point for doc on how log contexts are supposed to work
| -rw-r--r-- | docs/log_contexts.rst | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/log_contexts.rst b/docs/log_contexts.rst new file mode 100644 index 0000000000..0046e171be --- /dev/null +++ b/docs/log_contexts.rst @@ -0,0 +1,10 @@ +What do I do about "Unexpected logging context" debug log-lines everywhere? + +<Mjark> The logging context lives in thread local storage +<Mjark> Sometimes it gets out of sync with what it should actually be, usually because something scheduled something to run on the reactor without preserving the logging context. +<Matthew> what is the impact of it getting out of sync? and how and when should we preserve log context? +<Mjark> The impact is that some of the CPU and database metrics will be under-reported, and some log lines will be mis-attributed. +<Mjark> It should happen auto-magically in all the APIs that do IO or otherwise defer to the reactor. +<Erik> Mjark: the other place is if we branch, e.g. using defer.gatherResults + +Unanswered: how and when should we preserve log context? \ No newline at end of file |