Eric Eastwood 5a9ca1e3d9 Introduce Clock.call_when_running(...) to include logcontext by default (#18944) ... Introduce `Clock.call_when_running(...)` to wrap startup code in a logcontext, ensuring we can identify which server generated the logs. Background: > Ideally, nothing from the Synapse homeserver would be logged against the `sentinel` > logcontext as we want to know which server the logs came from. In practice, this is not > always the case yet especially outside of request handling. > > Global things outside of Synapse (e.g. Twisted reactor code) should run in the > `sentinel` logcontext. It's only when it calls into application code that a logcontext > gets activated. This means the reactor should be started in the `sentinel` logcontext, > and any time an awaitable yields control back to the reactor, it should reset the > logcontext to be the `sentinel` logcontext. This is important to avoid leaking the > current logcontext to the reactor (which would then get picked up and associated with > the next thing the reactor does). > > *-- `docs/log_contexts.md` Also adds a lint to prefer `Clock.call_when_running(...)` over `reactor.callWhenRunning(...)` Part of https://github.com/element-hq/synapse/issues/18905		2025-09-22 10:27:59 -05:00
..
api	Introduce Clock.call_when_running(...) to include logcontext by default (#18944)	2025-09-22 10:27:59 -05:00
app	Introduce Clock.call_when_running(...) to include logcontext by default (#18944)	2025-09-22 10:27:59 -05:00
appservice	Introduce Clock.call_when_running(...) to include logcontext by default (#18944)	2025-09-22 10:27:59 -05:00
config	Introduce Clock.call_when_running(...) to include logcontext by default (#18944)	2025-09-22 10:27:59 -05:00
crypto	Introduce Clock.call_when_running(...) to include logcontext by default (#18944)	2025-09-22 10:27:59 -05:00
events	Introduce Clock.call_when_running(...) to include logcontext by default (#18944)	2025-09-22 10:27:59 -05:00
federation	Introduce Clock.call_when_running(...) to include logcontext by default (#18944)	2025-09-22 10:27:59 -05:00
handlers	Introduce Clock.call_when_running(...) to include logcontext by default (#18944)	2025-09-22 10:27:59 -05:00
http	Introduce Clock.call_when_running(...) to include logcontext by default (#18944)	2025-09-22 10:27:59 -05:00
logging	Introduce Clock.call_when_running(...) to include logcontext by default (#18944)	2025-09-22 10:27:59 -05:00
media	Introduce Clock.call_when_running(...) to include logcontext by default (#18944)	2025-09-22 10:27:59 -05:00
metrics	Introduce Clock.call_when_running(...) to include logcontext by default (#18944)	2025-09-22 10:27:59 -05:00
module_api	Introduce Clock.call_when_running(...) to include logcontext by default (#18944)	2025-09-22 10:27:59 -05:00
push	Introduce Clock.call_when_running(...) to include logcontext by default (#18944)	2025-09-22 10:27:59 -05:00
replication	Introduce Clock.call_when_running(...) to include logcontext by default (#18944)	2025-09-22 10:27:59 -05:00
rest	Introduce Clock.call_when_running(...) to include logcontext by default (#18944)	2025-09-22 10:27:59 -05:00
scripts	Update license headers	2023-11-21 15:29:58 -05:00
server_notices	Introduce Clock.call_when_running(...) to include logcontext by default (#18944)	2025-09-22 10:27:59 -05:00
state	Introduce Clock.call_when_running(...) to include logcontext by default (#18944)	2025-09-22 10:27:59 -05:00
storage	Introduce Clock.call_when_running(...) to include logcontext by default (#18944)	2025-09-22 10:27:59 -05:00
test_utils	Introduce Clock.call_when_running(...) to include logcontext by default (#18944)	2025-09-22 10:27:59 -05:00
types	Support for room version 12	2025-08-11 16:43:45 +01:00
util	Introduce Clock.call_when_running(...) to include logcontext by default (#18944)	2025-09-22 10:27:59 -05:00
__init__.py	Correctly mention previous copyright (#16820)	2024-01-23 11:26:48 +00:00
server.py	Introduce Clock.call_when_running(...) to include logcontext by default (#18944)	2025-09-22 10:27:59 -05:00
test_distributor.py	Refactor background process metrics to be homeserver-scoped (#18670)	2025-07-23 13:28:17 -05:00
test_event_auth.py	Format files with Ruff (#17643)	2024-09-02 12:39:04 +01:00
test_mau.py	Introduce Clock.call_when_running(...) to include logcontext by default (#18944)	2025-09-22 10:27:59 -05:00
test_phone_home.py	Introduce Clock.call_when_running(...) to include logcontext by default (#18944)	2025-09-22 10:27:59 -05:00
test_rust.py	Add missing type hints to tests. (#15027)	2023-02-08 19:52:37 +00:00
test_server.py	Introduce Clock.call_when_running(...) to include logcontext by default (#18944)	2025-09-22 10:27:59 -05:00
test_state.py	Introduce Clock.call_when_running(...) to include logcontext by default (#18944)	2025-09-22 10:27:59 -05:00
test_terms_auth.py	Introduce Clock.call_when_running(...) to include logcontext by default (#18944)	2025-09-22 10:27:59 -05:00
test_test_utils.py	Correctly mention previous copyright (#16820)	2024-01-23 11:26:48 +00:00
test_types.py	Format files with Ruff (#17643)	2024-09-02 12:39:04 +01:00
test_visibility.py	Introduce Clock.call_when_running(...) to include logcontext by default (#18944)	2025-09-22 10:27:59 -05:00
unittest.py	Introduce Clock.call_when_running(...) to include logcontext by default (#18944)	2025-09-22 10:27:59 -05:00
utils.py	Refactor Histogram metrics to be homeserver-scoped (#18724)	2025-07-29 15:35:38 -05:00