Change the configuration prefix from Common to Base, add the example to the readme and update the version

Author: draincoder

README.md

@@ -80,6 +80,17 @@ In this example, all logs will be presented in JSON format and the following met
 5. `fastapi_requests_in_progress` - Gauge of requests by method and path currently being processed (Gauge)
 6. `fastapi_requests_exceptions_total` - Total count of exceptions raised by path and exception type (Counter)
 
+You can also set up a global `REGISTRY` in `MetricsConfig` to support your **global** metrics,
+but it is better to use your own non-global registry or leave the default registry
+
+```python
+from prometheus_client import REGISTRY
+from asgi_monitor.integrations.fastapi import MetricsConfig
+
+metrics_config = MetricsConfig(app_name="fastapi", registry=REGISTRY)
+```
+
+
 And these metrics are available by endpoint `/metrics`,
 but you can import `get_latest_metrics` from `asgi_monitor.metrics` to create a custom endpoint.
 

examples/real_world/requirements.txt

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

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "asgi-monitor"
-version = "0.2.0"
+version = "0.3.0"
 description = "Quick and easy monitoring setup for ASGI application"
 requires-python = ">=3.10"
 readme = "README.md"

src/asgi_monitor/integrations/fastapi.py

@@ -12,9 +12,9 @@
     _get_default_span_details,
     get_metrics,
 )
-from asgi_monitor.metrics.config import CommonMetricsConfig
+from asgi_monitor.metrics.config import BaseMetricsConfig
 from asgi_monitor.metrics.container import MetricsContainer
-from asgi_monitor.tracing import CommonTracingConfig
+from asgi_monitor.tracing import BaseTracingConfig
 
 __all__ = (
     "TracingConfig",
@@ -27,15 +27,15 @@
 
 
 @dataclass
-class MetricsConfig(CommonMetricsConfig):
+class MetricsConfig(BaseMetricsConfig):
     """Configuration class for the Metrics middleware."""
 
     metrics_prefix: str = "fastapi"
     """The prefix to use for the metrics."""
 
 
 @dataclass
-class TracingConfig(CommonTracingConfig):
+class TracingConfig(BaseTracingConfig):
     """
     Configuration class for the OpenTelemetry middleware.
     Consult the OpenTelemetry ASGI documentation for more info about the configuration options.

src/asgi_monitor/integrations/starlette.py

@@ -17,10 +17,10 @@
     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.config import BaseMetricsConfig
 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.config import BaseTracingConfig
 from asgi_monitor.tracing.middleware import build_open_telemetry_middleware
 
 __all__ = (
@@ -69,7 +69,7 @@ def _get_path(request: Request) -> tuple[str, bool]:
 
 
 @dataclass
-class TracingConfig(CommonTracingConfig):
+class TracingConfig(BaseTracingConfig):
     """
     Configuration class for the OpenTelemetry middleware.
     Consult the OpenTelemetry ASGI documentation for more info about the configuration options.
@@ -90,7 +90,7 @@ class TracingConfig(CommonTracingConfig):
 
 
 @dataclass
-class MetricsConfig(CommonMetricsConfig):
+class MetricsConfig(BaseMetricsConfig):
     """Configuration class for the Metrics middleware."""
 
     metrics_prefix: str = "starlette"

src/asgi_monitor/metrics/config.py

@@ -2,15 +2,15 @@
 
 from prometheus_client import CollectorRegistry
 
-__all__ = ("CommonMetricsConfig",)
+__all__ = ("BaseMetricsConfig",)
 
 
 def _build_default_registry() -> CollectorRegistry:
     return CollectorRegistry(auto_describe=True)
 
 
 @dataclass
-class CommonMetricsConfig:
+class BaseMetricsConfig:
     """Configuration class for the Metrics middleware."""
 
     app_name: str

src/asgi_monitor/tracing/__init__.py

@@ -1,3 +1,3 @@
-from .config import CommonTracingConfig
+from .config import BaseTracingConfig
 
-__all__ = ("CommonTracingConfig",)
+__all__ = ("BaseTracingConfig",)

src/asgi_monitor/tracing/config.py

@@ -3,7 +3,7 @@
 from dataclasses import dataclass, field
 from typing import Any, Callable
 
-__all__ = ("CommonTracingConfig",)
+__all__ = ("BaseTracingConfig",)
 
 
 from opentelemetry.metrics import Meter, MeterProvider
@@ -13,7 +13,7 @@
 
 
 @dataclass
-class CommonTracingConfig:
+class BaseTracingConfig:
     """
     Configuration class for the OpenTelemetry middleware.
     Consult the OpenTelemetry ASGI documentation for more info about the configuration options.

src/asgi_monitor/tracing/middleware.py

@@ -5,10 +5,10 @@
 from opentelemetry.instrumentation.asgi import OpenTelemetryMiddleware
 from opentelemetry.util.http import get_excluded_urls
 
-from asgi_monitor.tracing.config import CommonTracingConfig
+from asgi_monitor.tracing.config import BaseTracingConfig
 
 
-def build_open_telemetry_middleware(app: Any, config: CommonTracingConfig) -> OpenTelemetryMiddleware:
+def build_open_telemetry_middleware(app: Any, config: BaseTracingConfig) -> OpenTelemetryMiddleware:
     return OpenTelemetryMiddleware(
         app=app,
         client_request_hook=config.client_request_hook_handler,

tests/unit/tracing/test_middleware.py

@@ -4,7 +4,7 @@
 from opentelemetry.instrumentation.asgi import OpenTelemetryMiddleware
 from opentelemetry.sdk.trace import TracerProvider
 
-from asgi_monitor.tracing import CommonTracingConfig
+from asgi_monitor.tracing import BaseTracingConfig
 from asgi_monitor.tracing.middleware import build_open_telemetry_middleware
 
 
@@ -17,7 +17,7 @@ def default_extractor(scope: Any) -> tuple[str, dict[str, Any]]:
         return "test", {"test": "test"}
 
     # Act
-    config = CommonTracingConfig(
+    config = BaseTracingConfig(
         exclude_urls_env_key="FASTAPI",
         scope_span_details_extractor=default_extractor,
         tracer_provider=tracer,