MirrorHub/synapse
0
0
Fork 1
mirror of https://mau.dev/maunium/synapse.git synced 2024-12-17 02:53:57 +01:00
Code Issues Projects Releases Wiki Activity

Expose a get_resource_usage method in Measure

Browse source
This commit is contained in:
Richard van der Hoff 2020-09-29 13:04:52 +01:00
parent 937393abd8
commit ba700074c6
1 changed files with 22 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
synapse/util/metrics.py
View file

@ -19,7 +19,11 @@ from typing import Any, Callable, Optional, TypeVar, cast
from prometheus_client import Counter from prometheus_client import Counter
from synapse.logging.context import LoggingContext, current_context from synapse.logging.context import (
ContextResourceUsage,
LoggingContext,
current_context,
)
from synapse.metrics import InFlightGauge from synapse.metrics import InFlightGauge
logger = logging.getLogger(__name__) logger = logging.getLogger(__name__)
@ -104,27 +108,27 @@ class Measure:
def __init__(self, clock, name): def __init__(self, clock, name):
self.clock = clock self.clock = clock
self.name = name self.name = name
self._logging_context = None
self.start = None
def __enter__(self):
if self._logging_context:
raise RuntimeError("Measure() objects cannot be re-used")
self.start = self.clock.time()
parent_context = current_context() parent_context = current_context()
self._logging_context = LoggingContext( self._logging_context = LoggingContext(
"Measure[%s]" % (self.name,), parent_context "Measure[%s]" % (self.name,), parent_context
) )
self.start = None
def __enter__(self) -> "Measure":
if self.start is not None:
raise RuntimeError("Measure() objects cannot be re-used")
self.start = self.clock.time()
self._logging_context.__enter__() self._logging_context.__enter__()
in_flight.register((self.name,), self._update_in_flight) in_flight.register((self.name,), self._update_in_flight)
return self
def __exit__(self, exc_type, exc_val, exc_tb): def __exit__(self, exc_type, exc_val, exc_tb):
if not self._logging_context: if self.start is None:
raise RuntimeError("Measure() block exited without being entered") raise RuntimeError("Measure() block exited without being entered")
duration = self.clock.time() - self.start duration = self.clock.time() - self.start
usage = self._logging_context.get_resource_usage() usage = self.get_resource_usage()
in_flight.unregister((self.name,), self._update_in_flight) in_flight.unregister((self.name,), self._update_in_flight)
self._logging_context.__exit__(exc_type, exc_val, exc_tb) self._logging_context.__exit__(exc_type, exc_val, exc_tb)
@ -140,6 +144,13 @@ class Measure:
except ValueError: except ValueError:
logger.warning("Failed to save metrics! Usage: %s", usage) logger.warning("Failed to save metrics! Usage: %s", usage)
def get_resource_usage(self) -> ContextResourceUsage:
"""Get the resources used within this Measure block
If the Measure block is still active, returns the resource usage so far.
"""
return self._logging_context.get_resource_usage()
def _update_in_flight(self, metrics): def _update_in_flight(self, metrics):
"""Gets called when processing in flight metrics """Gets called when processing in flight metrics
""" """