synapse/synapse/logging
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
..
__init__.py Correctly mention previous copyright (#16820) 2024-01-23 11:26:48 +00:00
_remote.py Fix other unit tests with latest twisted (#17907) 2024-11-07 10:11:13 +00:00
_terse_json.py Format files with Ruff (#17643) 2024-09-02 12:39:04 +01:00
context.py Better explain which context the task is run in when using run_in_background(...) or run_as_background_process(...) (#18906) 2025-09-12 09:29:35 -05:00
filter.py Cleanup Python 3.8 leftovers (#17967) 2025-02-10 16:53:24 +00:00
formatter.py Update license headers 2023-11-21 15:29:58 -05:00
handlers.py Introduce Clock.call_when_running(...) to include logcontext by default (#18944) 2025-09-22 10:27:59 -05:00
loggers.py Add debug log when HMAC incorrect (#18474) 2025-07-22 11:09:45 -05:00
opentracing.py Introduce Clock.call_when_running(...) to include logcontext by default (#18944) 2025-09-22 10:27:59 -05:00