From d2d146a3143e94c5f68caadc3dbeff4452f86853 Mon Sep 17 00:00:00 2001
From: Richard van der Hoff <richard@matrix.org>
Date: Fri, 17 Mar 2017 15:11:26 +0000
Subject: Logcontext docs

---
 synapse/util/logcontext.py | 10 ++++++++++
 1 file changed, 10 insertions(+)

(limited to 'synapse')

diff --git a/synapse/util/logcontext.py b/synapse/util/logcontext.py
index d73670f9f2..1135a683af 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
-- 
cgit 1.5.1