Getting rid of the global REGISTRY, refactoring

Author: draincoder

README.md

@@ -46,7 +46,7 @@ pip install asgi-monitor
 ```python
 import logging
 
-from asgi_monitor.integrations.fastapi import setup_metrics
+from asgi_monitor.integrations.fastapi import MetricsConfig, setup_metrics
 from asgi_monitor.logging import configure_logging
 from asgi_monitor.logging.uvicorn import build_uvicorn_log_config
 from fastapi import FastAPI
@@ -58,9 +58,10 @@ app = FastAPI(debug=True)
 
 def run_app() -> None:
     log_config = build_uvicorn_log_config(level=logging.INFO, json_format=True, include_trace=False)
+    metrics_config = MetricsConfig(app_name="fastapi")
 
     configure_logging(level=logging.INFO, json_format=True, include_trace=False)
-    setup_metrics(app, app_name="fastapi", include_metrics_endpoint=True, include_trace_exemplar=False)
+    setup_metrics(app, metrics_config)
 
     logger.info("App is ready to start")
 
@@ -123,9 +124,9 @@ resource = Resource.create(
 tracer = TracerProvider(resource=resource)
 trace.set_tracer_provider(tracer)
 tracer.add_span_processor(BatchSpanProcessor(OTLPSpanExporter(endpoint="http://asgi-monitor.tempo:4317")))
-config = TracingConfig(tracer_provider=tracer)
+trace_config = TracingConfig(tracer_provider=tracer)
 
-setup_tracing(app=app, config=config)  # Must be configured last
+setup_tracing(app=app, config=trace_config)  # Must be configured last
 ```
 
 1. Install the necessary exporter, for example [opentelemetry-exporter-jaeger](https://pypi.org/project/opentelemetry-exporter-jaeger/) or the standard [opentelemetry-exporter-otlp](https://pypi.org/project/opentelemetry-exporter-otlp/)

examples/fastapi_app.py

@@ -8,7 +8,7 @@
 from opentelemetry.sdk.resources import Resource
 from opentelemetry.sdk.trace import TracerProvider
 
-from asgi_monitor.integrations.fastapi import TracingConfig, setup_metrics, setup_tracing
+from asgi_monitor.integrations.fastapi import MetricsConfig, TracingConfig, setup_metrics, setup_tracing
 from asgi_monitor.logging import configure_logging
 from asgi_monitor.logging.uvicorn import build_uvicorn_log_config
 
@@ -34,12 +34,15 @@ def create_app() -> FastAPI:
     )
     tracer = TracerProvider(resource=resource)
     trace.set_tracer_provider(tracer)
-    config = TracingConfig(tracer_provider=tracer)
+
+    trace_config = TracingConfig(tracer_provider=tracer)
+    metrics_config = MetricsConfig(app_name="fastapi", include_trace_exemplar=True)
 
     app = FastAPI(debug=True)
     app.include_router(router)
-    setup_metrics(app, app_name="fastapi", include_trace_exemplar=True, include_metrics_endpoint=True)
-    setup_tracing(app=app, config=config)
+
+    setup_metrics(app=app, config=metrics_config)
+    setup_tracing(app=app, config=trace_config)
 
     return app
 

examples/real_world/app/main.py

@@ -7,7 +7,7 @@
 from opentelemetry.sdk.resources import Resource
 from opentelemetry.sdk.trace import TracerProvider
 from opentelemetry.sdk.trace.export import BatchSpanProcessor
-from asgi_monitor.integrations.fastapi import TracingConfig, setup_metrics, setup_tracing
+from asgi_monitor.integrations.fastapi import MetricsConfig, TracingConfig, setup_metrics, setup_tracing
 from asgi_monitor.logging import configure_logging
 from asgi_monitor.logging.uvicorn import build_uvicorn_log_config
 
@@ -33,11 +33,14 @@ def create_app() -> FastAPI:
     tracer = TracerProvider(resource=resource)
     trace.set_tracer_provider(tracer)
     tracer.add_span_processor(BatchSpanProcessor(OTLPSpanExporter(endpoint=GRPC_ENDPOINT)))
-    config = TracingConfig(tracer_provider=tracer)
+
+    trace_config = TracingConfig(tracer_provider=tracer)
+    metrics_config = MetricsConfig(app_name=APP_NAME, include_trace_exemplar=True)
 
     app = FastAPI(debug=True)
-    setup_metrics(app=app, app_name=APP_NAME, include_trace_exemplar=True, include_metrics_endpoint=True)
-    setup_tracing(app=app, config=config)
+
+    setup_metrics(app=app, config=metrics_config)
+    setup_tracing(app=app, config=trace_config)
     setup_routes(app=app)
 
     return app

examples/real_world/requirements.txt

@@ -1,4 +1,4 @@
 uvicorn
 fastapi
-asgi-monitor
+asgi-monitor @ git+https://github.com/draincoder/asgi-monitor@develop
 opentelemetry-exporter-otlp

examples/starlette_app.py

@@ -11,7 +11,7 @@
 from starlette.responses import PlainTextResponse
 from starlette.routing import Route
 
-from asgi_monitor.integrations.starlette import TracingConfig, setup_metrics, setup_tracing
+from asgi_monitor.integrations.starlette import MetricsConfig, TracingConfig, setup_metrics, setup_tracing
 from asgi_monitor.logging import configure_logging
 from asgi_monitor.logging.uvicorn import build_uvicorn_log_config
 
@@ -35,11 +35,14 @@ def create_app() -> Starlette:
     )
     tracer = TracerProvider(resource=resource)
     trace.set_tracer_provider(tracer)
-    config = TracingConfig(tracer_provider=tracer)
+
+    trace_config = TracingConfig(tracer_provider=tracer)
+    metrics_config = MetricsConfig(app_name="starlette", include_trace_exemplar=True)
 
     app = Starlette(debug=True, routes=[Route("/", endpoint=index, methods=["GET"])])
-    setup_metrics(app, app_name="starlette", include_trace_exemplar=True, include_metrics_endpoint=True)
-    setup_tracing(app=app, config=config)
+
+    setup_metrics(app=app, config=metrics_config)
+    setup_tracing(app=app, config=trace_config)
 
     return app
 

src/asgi_monitor/integrations/fastapi.py

@@ -12,28 +12,39 @@
     _get_default_span_details,
     get_metrics,
 )
+from asgi_monitor.metrics.config import CommonMetricsConfig
+from asgi_monitor.metrics.container import MetricsContainer
+from asgi_monitor.tracing import CommonTracingConfig
 
 __all__ = (
     "TracingConfig",
     "TracingMiddleware",
-    "MetricsMiddleware",
     "setup_tracing",
+    "MetricsConfig",
+    "MetricsMiddleware",
     "setup_metrics",
 )
 
 
-from asgi_monitor.tracing import CommonTracingConfig
+@dataclass
+class MetricsConfig(CommonMetricsConfig):
+    """Configuration class for the Metrics middleware."""
+
+    metrics_prefix: str = "fastapi"
+    """The prefix to use for the metrics."""
 
 
 @dataclass
 class TracingConfig(CommonTracingConfig):
-    """Configuration class for the OpenTelemetry middleware.
+    """
+    Configuration class for the OpenTelemetry middleware.
     Consult the OpenTelemetry ASGI documentation for more info about the configuration options.
     https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/asgi/asgi.html
     """
 
     exclude_urls_env_key: str = "FASTAPI"
-    """Key to use when checking whether a list of excluded urls is passed via ENV.
+    """
+    Key to use when checking whether a list of excluded urls is passed via ENV.
     OpenTelemetry supports excluding urls by passing an env in the format '{exclude_urls_env_key}_EXCLUDED_URLS'.
     """
 
@@ -57,34 +68,24 @@ def setup_tracing(app: FastAPI, config: TracingConfig) -> None:
     app.add_middleware(TracingMiddleware, config=config)
 
 
-def setup_metrics(
-    app: FastAPI,
-    app_name: str,
-    metrics_prefix: str = "fastapi",
-    *,
-    include_trace_exemplar: bool,
-    include_metrics_endpoint: bool,
-) -> None:
+def setup_metrics(app: FastAPI, config: MetricsConfig) -> None:
     """
     Set up metrics for a FastAPI application.
     This function adds a MetricsMiddleware to the FastAPI application with the specified parameters.
-    If include_metrics_endpoint is True, it also adds a route for "/metrics" that returns Prometheus default metrics.
 
-    :param FastAPI app: The FastAPI application instance.
-    :param str app_name: The name of the FastAPI application.
-    :param str metrics_prefix: The prefix to use for the metrics (default is "fastapi").
-    :param bool include_trace_exemplar: Whether to include trace exemplars in the metrics.
-    :param bool include_metrics_endpoint: Whether to include a /metrics endpoint.
+    :param FastAPI app: The Starlette application instance.
+    :param MetricsConfig config: Configuration for the metrics.
     :returns: None
     """
 
+    app.state.metrics_registry = config.registry
     app.add_middleware(
         MetricsMiddleware,
-        app_name=app_name,
-        metrics_prefix=metrics_prefix,
-        include_trace_exemplar=include_trace_exemplar,
+        app_name=config.app_name,
+        container=MetricsContainer(config.metrics_prefix, config.registry),
+        include_trace_exemplar=config.include_trace_exemplar,
     )
-    if include_metrics_endpoint:
+    if config.include_metrics_endpoint:
         app.add_route(
             path="/metrics",
             route=get_metrics,

src/asgi_monitor/integrations/starlette.py

@@ -11,23 +11,24 @@
 from starlette.routing import Match
 from starlette.status import HTTP_500_INTERNAL_SERVER_ERROR
 
-from asgi_monitor.metrics import get_latest_metrics
-from asgi_monitor.metrics.container import MetricsContainer
-from asgi_monitor.metrics.manager import MetricsManager
-
 if TYPE_CHECKING:
     from starlette.applications import Starlette
     from starlette.requests import Request
     from starlette.types import ASGIApp, Receive, Scope, Send
 
+from asgi_monitor.metrics import get_latest_metrics
+from asgi_monitor.metrics.config import CommonMetricsConfig
+from asgi_monitor.metrics.container import MetricsContainer
+from asgi_monitor.metrics.manager import MetricsManager
 from asgi_monitor.tracing.config import CommonTracingConfig
 from asgi_monitor.tracing.middleware import build_open_telemetry_middleware
 
 __all__ = (
     "TracingConfig",
     "TracingMiddleware",
-    "MetricsMiddleware",
     "setup_tracing",
+    "MetricsConfig",
+    "MetricsMiddleware",
     "setup_metrics",
 )
 
@@ -69,13 +70,15 @@ def _get_path(request: Request) -> tuple[str, bool]:
 
 @dataclass
 class TracingConfig(CommonTracingConfig):
-    """Configuration class for the OpenTelemetry middleware.
+    """
+    Configuration class for the OpenTelemetry middleware.
     Consult the OpenTelemetry ASGI documentation for more info about the configuration options.
     https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/asgi/asgi.html
     """
 
     exclude_urls_env_key: str = "STARLETTE"
-    """Key to use when checking whether a list of excluded urls is passed via ENV.
+    """
+    Key to use when checking whether a list of excluded urls is passed via ENV.
     OpenTelemetry supports excluding urls by passing an env in the format '{exclude_urls_env_key}_EXCLUDED_URLS'.
     """
 
@@ -86,6 +89,14 @@ class TracingConfig(CommonTracingConfig):
     """
 
 
+@dataclass
+class MetricsConfig(CommonMetricsConfig):
+    """Configuration class for the Metrics middleware."""
+
+    metrics_prefix: str = "starlette"
+    """The prefix to use for the metrics."""
+
+
 class TracingMiddleware:
     def __init__(self, app: ASGIApp, config: TracingConfig) -> None:
         self.app = app
@@ -108,12 +119,11 @@ def __init__(
         self,
         app: ASGIApp,
         app_name: str,
-        metrics_prefix: str,
+        container: MetricsContainer,
         *,
         include_trace_exemplar: bool,
     ) -> None:
         super().__init__(app)
-        container = MetricsContainer(prefix=metrics_prefix)
         self.metrics = MetricsManager(app_name=app_name, container=container)
         self.include_exemplar = include_trace_exemplar
         self.metrics.add_app_info()
@@ -166,7 +176,8 @@ async def dispatch(self, request: Request, call_next: RequestResponseEndpoint) -
 
 
 async def get_metrics(request: Request) -> Response:
-    response = get_latest_metrics(openmetrics_format=False)
+    registry = request.app.state.metrics_registry
+    response = get_latest_metrics(registry, openmetrics_format=False)
     return Response(
         content=response.payload,
         status_code=response.status_code,
@@ -187,34 +198,24 @@ def setup_tracing(app: Starlette, config: TracingConfig) -> None:
     app.add_middleware(TracingMiddleware, config=config)
 
 
-def setup_metrics(
-    app: Starlette,
-    app_name: str,
-    metrics_prefix: str = "starlette",
-    *,
-    include_trace_exemplar: bool,
-    include_metrics_endpoint: bool,
-) -> None:
+def setup_metrics(app: Starlette, config: MetricsConfig) -> None:
     """
     Set up metrics for a Starlette application.
     This function adds a MetricsMiddleware to the Starlette application with the specified parameters.
-    If include_metrics_endpoint is True, it also adds a route for "/metrics" that returns Prometheus default metrics.
 
     :param Starlette app: The Starlette application instance.
-    :param str app_name: The name of the Starlette application.
-    :param str metrics_prefix: The prefix to use for the metrics (default is "starlette").
-    :param bool include_trace_exemplar: Whether to include trace exemplars in the metrics.
-    :param bool include_metrics_endpoint: Whether to include a /metrics endpoint.
+    :param MetricsConfig config: Configuration for the metrics.
     :returns: None
     """
 
+    app.state.metrics_registry = config.registry
     app.add_middleware(
         MetricsMiddleware,
-        app_name=app_name,
-        metrics_prefix=metrics_prefix,
-        include_trace_exemplar=include_trace_exemplar,
+        app_name=config.app_name,
+        container=MetricsContainer(config.metrics_prefix, config.registry),
+        include_trace_exemplar=config.include_trace_exemplar,
     )
-    if include_metrics_endpoint:
+    if config.include_metrics_endpoint:
         app.add_route(
             path="/metrics",
             route=get_metrics,

src/asgi_monitor/metrics/config.py

@@ -0,0 +1,29 @@
+from dataclasses import dataclass, field
+
+from prometheus_client import CollectorRegistry
+
+__all__ = ("CommonMetricsConfig",)
+
+
+def _build_default_registry() -> CollectorRegistry:
+    return CollectorRegistry(auto_describe=True)
+
+
+@dataclass
+class CommonMetricsConfig:
+    """Configuration class for the Metrics middleware."""
+
+    app_name: str
+    """The name of the ASGI application."""
+
+    metrics_prefix: str
+    """The prefix to use for the metrics."""
+
+    registry: CollectorRegistry = field(default_factory=_build_default_registry)
+    """A registry for metrics, you can also specify a global REGISTRY to support all your current metrics"""
+
+    include_trace_exemplar: bool = field(default=False)
+    """Whether to include trace exemplars in the metrics."""
+
+    include_metrics_endpoint: bool = field(default=True)
+    """Whether to include a /metrics endpoint."""