diff options
author | Richard van der Hoff <github@rvanderhoff.org.uk> | 2017-03-20 12:05:21 +0000 |
---|---|---|
committer | GitHub <noreply@github.com> | 2017-03-20 12:05:21 +0000 |
commit | bd08ee7a4625b29f3d2f6b188bd02f26422acad1 (patch) | |
tree | 85e0227bbacecbe2acde53015974c9e4b913ab8f /synapse | |
parent | Merge pull request #2027 from matrix-org/rav/logcontext_leaks (diff) | |
parent | log_contexts.rst: fix formatting of Note block (diff) | |
download | synapse-bd08ee7a4625b29f3d2f6b188bd02f26422acad1.tar.xz |
Merge pull request #2026 from matrix-org/rav/logcontext_docs
Logcontext docs
Diffstat (limited to 'synapse')
-rw-r--r-- | synapse/util/logcontext.py | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/synapse/util/logcontext.py b/synapse/util/logcontext.py index 7cbe390b15..ff67b1d794 100644 --- a/synapse/util/logcontext.py +++ b/synapse/util/logcontext.py @@ -12,6 +12,16 @@ # See the License for the specific language governing permissions and # limitations under the License. +""" Thread-local-alike tracking of log contexts within synapse + +This module provides objects and utilities for tracking contexts through +synapse code, so that log lines can include a request identifier, and so that +CPU and database activity can be accounted for against the request that caused +them. + +See doc/log_contexts.rst for details on how this works. +""" + from twisted.internet import defer import threading |