mirror of
https://github.com/element-hq/synapse.git
synced 2025-11-30 00:00:40 -05:00
5a9ca1e3d9
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
129 lines
4.1 KiB
Python
129 lines
4.1 KiB
Python
#
|
|
# This file is licensed under the Affero General Public License (AGPL) version 3.
|
|
#
|
|
# Copyright 2019 The Matrix.org Foundation C.I.C.
|
|
# Copyright (C) 2023 New Vector, Ltd
|
|
#
|
|
# This program is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU Affero General Public License as
|
|
# published by the Free Software Foundation, either version 3 of the
|
|
# License, or (at your option) any later version.
|
|
#
|
|
# See the GNU Affero General Public License for more details:
|
|
# <https://www.gnu.org/licenses/agpl-3.0.html>.
|
|
#
|
|
# Originally licensed under the Apache License, Version 2.0:
|
|
# <http://www.apache.org/licenses/LICENSE-2.0>.
|
|
#
|
|
# [This file includes modifications made by New Vector Limited]
|
|
#
|
|
#
|
|
import sys
|
|
from argparse import REMAINDER, Namespace
|
|
from contextlib import redirect_stderr
|
|
from io import StringIO
|
|
from typing import Any, Callable, Coroutine, List, TypeVar
|
|
|
|
import pyperf
|
|
|
|
from twisted.internet.defer import Deferred, ensureDeferred
|
|
from twisted.logger import globalLogBeginner, textFileLogObserver
|
|
from twisted.python.failure import Failure
|
|
|
|
from synapse.types import ISynapseReactor
|
|
from synmark import make_reactor
|
|
from synmark.suites import SUITES
|
|
|
|
from tests.utils import setupdb
|
|
|
|
T = TypeVar("T")
|
|
|
|
|
|
def make_test(
|
|
main: Callable[[ISynapseReactor, int], Coroutine[Any, Any, float]],
|
|
) -> Callable[[int], float]:
|
|
"""
|
|
Take a benchmark function and wrap it in a reactor start and stop.
|
|
"""
|
|
|
|
def _main(loops: int) -> float:
|
|
reactor = make_reactor()
|
|
|
|
file_out = StringIO()
|
|
with redirect_stderr(file_out):
|
|
d: "Deferred[float]" = Deferred()
|
|
d.addCallback(lambda _: ensureDeferred(main(reactor, loops)))
|
|
|
|
def on_done(res: T) -> T:
|
|
if isinstance(res, Failure):
|
|
res.printTraceback()
|
|
print(file_out.getvalue())
|
|
reactor.stop()
|
|
return res
|
|
|
|
d.addBoth(on_done)
|
|
# type-ignore: This is outside of Synapse (just a utility benchmark script)
|
|
# so we don't need to worry about which server the logs are coming from
|
|
# (`Clock.call_when_running` manages the logcontext for us).
|
|
reactor.callWhenRunning(lambda: d.callback(True)) # type: ignore[prefer-synapse-clock-call-when-running]
|
|
reactor.run()
|
|
|
|
# mypy thinks this is an object for some reason.
|
|
return d.result # type: ignore[return-value]
|
|
|
|
return _main
|
|
|
|
|
|
if __name__ == "__main__":
|
|
|
|
def add_cmdline_args(cmd: List[str], args: Namespace) -> None:
|
|
if args.log:
|
|
cmd.extend(["--log"])
|
|
cmd.extend(args.tests)
|
|
|
|
runner = pyperf.Runner(
|
|
processes=3, min_time=1.5, show_name=True, add_cmdline_args=add_cmdline_args
|
|
)
|
|
runner.argparser.add_argument("--log", action="store_true")
|
|
runner.argparser.add_argument("tests", nargs=REMAINDER)
|
|
runner.parse_args()
|
|
|
|
orig_loops = runner.args.loops
|
|
runner.args.inherit_environ = ["SYNAPSE_POSTGRES"]
|
|
|
|
if runner.args.worker:
|
|
if runner.args.log:
|
|
# sys.__stdout__ can technically be None, just exit if it's the case
|
|
if not sys.__stdout__:
|
|
exit(1)
|
|
|
|
globalLogBeginner.beginLoggingTo(
|
|
[textFileLogObserver(sys.__stdout__)], redirectStandardIO=False
|
|
)
|
|
setupdb()
|
|
|
|
if runner.args.tests:
|
|
existing_suites = {s.__name__.split(".")[-1] for s, _ in SUITES}
|
|
for test in runner.args.tests:
|
|
if test not in existing_suites:
|
|
print(f"Test suite {test} does not exist.")
|
|
exit(-1)
|
|
|
|
suites = list(
|
|
filter(lambda t: t[0].__name__.split(".")[-1] in runner.args.tests, SUITES)
|
|
)
|
|
else:
|
|
suites = SUITES
|
|
|
|
for suite, loops in suites:
|
|
if loops:
|
|
runner.args.loops = loops
|
|
loops_desc = str(loops)
|
|
else:
|
|
runner.args.loops = orig_loops
|
|
loops_desc = "auto"
|
|
runner.bench_time_func(
|
|
suite.__name__ + "_" + loops_desc,
|
|
make_test(suite.main),
|
|
)
|