Matrix/synapse
Matrix/synapse
1
0
Fork 0
mirror of https://github.com/element-hq/synapse synced 2024-09-17 14:15:11 +00:00
Code Issues Projects Releases Packages Wiki Activity

Metrics name

Browse source
This commit is contained in:
Erik Johnston 2024-07-02 16:50:05 +01:00
parent 7a0d090adc
commit dfb7a8563b
1 changed files with 20 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
synapse/logging/context.py
View file

@ -34,7 +34,6 @@ import threading
import typing import typing
import warnings import warnings
from collections.abc import Coroutine, Generator from collections.abc import Coroutine, Generator
from contextvars import ContextVar
from types import TracebackType from types import TracebackType
from typing import ( from typing import (
TYPE_CHECKING, TYPE_CHECKING,
@ -235,7 +234,14 @@ LoggingContextOrSentinel = Union["LoggingContext", "_Sentinel"]
class _Sentinel: class _Sentinel:
"""Sentinel to represent the root context""" """Sentinel to represent the root context"""
__slots__ = ["previous_context", "finished", "request", "scope", "tag"] __slots__ = [
"previous_context",
"finished",
"request",
"scope",
"tag",
"metrics_name",
]
def __init__(self) -> None: def __init__(self) -> None:
# Minimal set for compatibility with LoggingContext # Minimal set for compatibility with LoggingContext
@ -244,6 +250,7 @@ class _Sentinel:
self.request = None self.request = None
self.scope = None self.scope = None
self.tag = None self.tag = None
self.metrics_name = None
def __str__(self) -> str: def __str__(self) -> str:
return "sentinel" return "sentinel"
@ -296,6 +303,7 @@ class LoggingContext:
"request", "request",
"tag", "tag",
"scope", "scope",
"metrics_name",
] ]
def __init__( def __init__(
@ -306,6 +314,8 @@ class LoggingContext:
) -> None: ) -> None:
self.previous_context = current_context() self.previous_context = current_context()
self.metrics_name: Optional[str] = None
# track the resources used by this context so far # track the resources used by this context so far
self._resource_usage = ContextResourceUsage() self._resource_usage = ContextResourceUsage()
@ -339,6 +349,7 @@ class LoggingContext:
# if we don't have a `name`, but do have a parent context, use its name. # if we don't have a `name`, but do have a parent context, use its name.
if self.parent_context and name is None: if self.parent_context and name is None:
name = str(self.parent_context) name = str(self.parent_context)
self.metrics_name = self.parent_context.metrics_name
if name is None: if name is None:
raise ValueError( raise ValueError(
"LoggingContext must be given either a name or a parent context" "LoggingContext must be given either a name or a parent context"
@ -821,14 +832,14 @@ def run_in_background(
d: "defer.Deferred[R]" d: "defer.Deferred[R]"
if isinstance(res, typing.Coroutine): if isinstance(res, typing.Coroutine):
# Wrap the coroutine in a `Deferred`. # Wrap the coroutine in a `Deferred`.
d = defer.ensureDeferred(measure_coroutine(current.name, res)) d = defer.ensureDeferred(measure_coroutine(current.metrics_name, res))
elif isinstance(res, defer.Deferred): elif isinstance(res, defer.Deferred):
d = res d = res
elif isinstance(res, Awaitable): elif isinstance(res, Awaitable):
# `res` is probably some kind of completed awaitable, such as a `DoneAwaitable` # `res` is probably some kind of completed awaitable, such as a `DoneAwaitable`
# or `Future` from `make_awaitable`. # or `Future` from `make_awaitable`.
d = defer.ensureDeferred( d = defer.ensureDeferred(
measure_coroutine(current.name, _unwrap_awaitable(res)) measure_coroutine(current.metrics_name, _unwrap_awaitable(res))
) )
else: else:
# `res` is a plain value. Wrap it in a `Deferred`. # `res` is a plain value. Wrap it in a `Deferred`.
@ -1069,6 +1080,10 @@ class _ResourceTracker2(Coroutine[defer.Deferred[Any], Any, _T]):
async def measure_coroutine( async def measure_coroutine(
name: str, co: Coroutine[defer.Deferred[Any], Any, _T] name: Optional[str], co: Coroutine[defer.Deferred[Any], Any, _T]
) -> _T: ) -> _T:
if not name:
return await co
current_context().metrics_name = name
return await _ResourceTracker2(name, co) return await _ResourceTracker2(name, co)