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

Wrap register_device coroutine in an ensureDeferred (#7684)

2020-06-16 10:13:59 +01:00

test_account_data_manager.py

Introduce Clock.call_when_running(...) to include logcontext by default (#18944)

2025-09-22 10:27:59 -05:00

test_api.py

Introduce Clock.call_when_running(...) to include logcontext by default (#18944)

2025-09-22 10:27:59 -05:00

test_event_unsigned_addition.py

Introduce Clock.call_when_running(...) to include logcontext by default (#18944)

2025-09-22 10:27:59 -05:00

test_spamchecker.py

Introduce Clock.call_when_running(...) to include logcontext by default (#18944)

2025-09-22 10:27:59 -05:00