diff options
| author | Richard van der Hoff <1389908+richvdh@users.noreply.github.com> | 2021-06-07 17:57:49 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-06-07 17:57:49 +0100 |
| commit | b2557cbf42d39fbd8a497a2f859cb45f84539da9 (patch) | |
| tree | 1319ad53cd6c90c346c4ce9083486d7123e61f2a | |
| parent | Make link in docs use HTTPS (#10130) (diff) | |
| download | synapse-b2557cbf42d39fbd8a497a2f859cb45f84539da9.tar.xz | |
opentracing: use a consistent name for background processes (#10135)
... otherwise we tend to get a namespace clash between the bg process and the functions that it calls.
| -rw-r--r-- | changelog.d/10135.misc | 1 | ||||
| -rw-r--r-- | synapse/logging/opentracing.py | 1 | ||||
| -rw-r--r-- | synapse/metrics/background_process_metrics.py | 5 |
3 files changed, 5 insertions, 2 deletions
diff --git a/changelog.d/10135.misc b/changelog.d/10135.misc new file mode 100644 index 0000000000..17819cbbcc --- /dev/null +++ b/changelog.d/10135.misc @@ -0,0 +1 @@ +OpenTracing: use a consistent name for background processes. diff --git a/synapse/logging/opentracing.py b/synapse/logging/opentracing.py index 26c8ffe780..dd9377340e 100644 --- a/synapse/logging/opentracing.py +++ b/synapse/logging/opentracing.py @@ -337,6 +337,7 @@ def ensure_active_span(message, ret=None): @contextlib.contextmanager def noop_context_manager(*args, **kwargs): """Does exactly what it says on the tin""" + # TODO: replace with contextlib.nullcontext once we drop support for Python 3.6 yield diff --git a/synapse/metrics/background_process_metrics.py b/synapse/metrics/background_process_metrics.py index 0d6d643d35..de96ca0821 100644 --- a/synapse/metrics/background_process_metrics.py +++ b/synapse/metrics/background_process_metrics.py @@ -204,11 +204,12 @@ def run_as_background_process(desc: str, func, *args, bg_start_span=True, **kwar with BackgroundProcessLoggingContext(desc, count) as context: try: - ctx = noop_context_manager() if bg_start_span: ctx = start_active_span( - desc, tags={SynapseTags.REQUEST_ID: str(context)} + f"bgproc.{desc}", tags={SynapseTags.REQUEST_ID: str(context)} ) + else: + ctx = noop_context_manager() with ctx: return await maybe_awaitable(func(*args, **kwargs)) except Exception: |