synapse/changelog.d/10996.misc at 6b18eb443054087c4a8153b19b3cc4d3b731d324 - MirrorHub/synapse - tilera Git

MirrorHub/synapse

mirror of https://mau.dev/maunium/synapse.git synced 2024-11-06 22:59:22 +01:00

Sean Quah 6b18eb4430

Fix opentracing and Prometheus metrics for replication requests (#10996 )

This commit fixes two bugs to do with decorators not instrumenting
`ReplicationEndpoint`'s `send_request` correctly. There are two
decorators on `send_request`: Prometheus' `Gauge.track_inprogress()`
and Synapse's `opentracing.trace`.

`Gauge.track_inprogress()` does not have any support for async
functions when used as a decorator. Since async functions behave like
regular functions that return coroutines, only the creation of the
coroutine was covered by the metric and none of the actual body of
`send_request`.

`Gauge.track_inprogress()` returns a regular, non-async function
wrapping `send_request`, which is the source of the next bug.
The `opentracing.trace` decorator would normally handle async functions
correctly, but since the wrapped `send_request` is a non-async function,
the decorator ends up suffering from the same issue as
`Gauge.track_inprogress()`: the opentracing span only measures the
creation of the coroutine and none of the actual function body.

Using `Gauge.track_inprogress()` as a context manager instead of a
decorator resolves both bugs.

2021-10-12 11:23:46 +01:00

1 line

139 B

Text

Raw Blame History

Fix a bug introduced in Synapse 1.21.0 that causes opentracing and Prometheus metrics for replication requests to be measured incorrectly.