servicekit 2.0.3__tar.gz → 3.0.1__tar.gz

{servicekit-2.0.3 → servicekit-3.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: servicekit
-Version: 2.0.3
+Version: 3.0.1
 Summary: Async SQLAlchemy framework with FastAPI integration - reusable foundation for building data services
 Keywords: fastapi,sqlalchemy,async,database,rest-api,crud,framework
 Author: Morten Hansen
@@ -15,13 +15,12 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: Database
 Requires-Dist: aiosqlite>=0.21.0
 Requires-Dist: alembic>=1.17.0
-Requires-Dist: fastapi[standard]>=0.136.3
+Requires-Dist: fastapi[standard]>=0.142.2
 Requires-Dist: gunicorn>=23.0.0
-Requires-Dist: opentelemetry-api>=1.37.0
+Requires-Dist: opentelemetry-api>=1.44.0
 Requires-Dist: opentelemetry-exporter-prometheus>=0.58b0
-Requires-Dist: opentelemetry-instrumentation-fastapi>=0.58b0
 Requires-Dist: opentelemetry-instrumentation-sqlalchemy>=0.58b0
-Requires-Dist: opentelemetry-sdk>=1.37.0
+Requires-Dist: opentelemetry-sdk>=1.44.0
 Requires-Dist: pydantic>=2.12.0
 Requires-Dist: python-ulid>=3.1.0
 Requires-Dist: sqlalchemy[asyncio]>=2.0.43
@@ -115,7 +114,7 @@ app = (
     .with_database(url)               # Database configuration
     .with_jobs(max_concurrency=10)   # Job scheduler
     .with_auth()                      # API key authentication
-    .with_monitoring()                # Prometheus metrics
+    .with_monitoring()                # Prometheus metrics (on by default)
     .with_app("./webapp")             # Static web app
     .include_router(custom_router)   # Custom routes
     .build()

{servicekit-2.0.3 → servicekit-3.0.1}/README.md

@@ -79,7 +79,7 @@ app = (
     .with_database(url)               # Database configuration
     .with_jobs(max_concurrency=10)   # Job scheduler
     .with_auth()                      # API key authentication
-    .with_monitoring()                # Prometheus metrics
+    .with_monitoring()                # Prometheus metrics (on by default)
     .with_app("./webapp")             # Static web app
     .include_router(custom_router)   # Custom routes
     .build()

{servicekit-2.0.3 → servicekit-3.0.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "servicekit"
-version = "2.0.3"
+version = "3.0.1"
 description = "Async SQLAlchemy framework with FastAPI integration - reusable foundation for building data services"
 readme = "README.md"
 requires-python = ">=3.13,<3.14"
@@ -25,13 +25,12 @@ classifiers = [
 dependencies = [
     "aiosqlite>=0.21.0",
     "alembic>=1.17.0",
-    "fastapi[standard]>=0.136.3",
+    "fastapi[standard]>=0.142.2",
     "gunicorn>=23.0.0",
-    "opentelemetry-api>=1.37.0",
+    "opentelemetry-api>=1.44.0",
     "opentelemetry-exporter-prometheus>=0.58b0",
-    "opentelemetry-instrumentation-fastapi>=0.58b0",
     "opentelemetry-instrumentation-sqlalchemy>=0.58b0",
-    "opentelemetry-sdk>=1.37.0",
+    "opentelemetry-sdk>=1.44.0",
     "pydantic>=2.12.0",
     "python-ulid>=3.1.0",
     "sqlalchemy[asyncio]>=2.0.43",

{servicekit-2.0.3 → servicekit-3.0.1}/pyproject.toml.orig

@@ -1,6 +1,6 @@
 [project]
 name = "servicekit"
-version = "2.0.3"
+version = "3.0.1"
 description = "Async SQLAlchemy framework with FastAPI integration - reusable foundation for building data services"
 readme = "README.md"
 authors = [{ name = "Morten Hansen", email = "morten@dhis2.org" }]
@@ -27,13 +27,12 @@ classifiers = [
 dependencies = [
   "aiosqlite>=0.21.0",
   "alembic>=1.17.0",
-  "fastapi[standard]>=0.136.3",
+  "fastapi[standard]>=0.142.2",
   "gunicorn>=23.0.0",
-  "opentelemetry-api>=1.37.0",
+  "opentelemetry-api>=1.44.0",
   "opentelemetry-exporter-prometheus>=0.58b0",
-  "opentelemetry-instrumentation-fastapi>=0.58b0",
   "opentelemetry-instrumentation-sqlalchemy>=0.58b0",
-  "opentelemetry-sdk>=1.37.0",
+  "opentelemetry-sdk>=1.44.0",
   "pydantic>=2.12.0",
   "python-ulid>=3.1.0",
   "sqlalchemy[asyncio]>=2.0.43",

{servicekit-2.0.3 → servicekit-3.0.1}/src/servicekit/api/monitoring.py

@@ -1,9 +1,8 @@
-"""OpenTelemetry monitoring setup with auto-instrumentation."""
+"""OpenTelemetry monitoring setup: Prometheus metrics, SQLAlchemy instrumentation, FastAPI OpenTelemetry."""
 
 from fastapi import FastAPI
 from opentelemetry import metrics
 from opentelemetry.exporter.prometheus import PrometheusMetricReader
-from opentelemetry.instrumentation.fastapi import FastAPIInstrumentor
 from opentelemetry.instrumentation.sqlalchemy import SQLAlchemyInstrumentor
 from opentelemetry.sdk.metrics import MeterProvider
 from opentelemetry.sdk.resources import Resource
@@ -28,7 +27,7 @@ def setup_monitoring(
     service_name: str | None = None,
     enable_traces: bool = False,
 ) -> PrometheusMetricReader:
-    """Setup OpenTelemetry with FastAPI and SQLAlchemy auto-instrumentation."""
+    """Setup the global Prometheus meter provider and SQLAlchemy instrumentation; FastAPI OpenTelemetry records HTTP."""
     global _meter_provider_initialized, _sqlalchemy_instrumented, _process_collector_registered, _metric_reader
 
     # Use app title as service name if not provided
@@ -54,15 +53,11 @@ def setup_monitoring(
             # Already registered
             pass
 
-    # Auto-instrument FastAPI - check if already instrumented
-    instrumentor = FastAPIInstrumentor()
-    if not instrumentor.is_instrumented_by_opentelemetry:
-        instrumentor.instrument_app(app)
-
     # Auto-instrument SQLAlchemy - only once globally
     if not _sqlalchemy_instrumented:
         try:
-            SQLAlchemyInstrumentor().instrument()
+            # The instrumentor's declared range lags SQLAlchemy releases (0.66b1 stops below 2.1) and works on 2.1.
+            SQLAlchemyInstrumentor().instrument(skip_dep_check=True)
             _sqlalchemy_instrumented = True
         except RuntimeError:
             # Already instrumented
@@ -86,19 +81,12 @@ def setup_monitoring(
 
 
 def teardown_monitoring() -> None:
-    """Teardown OpenTelemetry instrumentation and reset module state."""
-    global _meter_provider_initialized, _sqlalchemy_instrumented, _process_collector_registered, _metric_reader
+    """Teardown SQLAlchemy instrumentation; the global meter provider cannot be replaced, so its reader stays."""
+    global _sqlalchemy_instrumented
 
-    _meter_provider_initialized = False
     _sqlalchemy_instrumented = False
-    _process_collector_registered = False
-    _metric_reader = None
 
     try:
-        # Uninstrument FastAPI
-        FastAPIInstrumentor().uninstrument()
-
-        # Uninstrument SQLAlchemy
         SQLAlchemyInstrumentor().uninstrument()
 
         logger.info("monitoring.disabled")

{servicekit-2.0.3 → servicekit-3.0.1}/src/servicekit/api/service_builder.py

@@ -8,13 +8,14 @@ import re
 import secrets
 import signal
 import sys
-from collections.abc import Sequence
+from collections.abc import MutableMapping, Sequence
 from contextlib import asynccontextmanager
 from dataclasses import dataclass
 from pathlib import Path
 from typing import Any, AsyncContextManager, AsyncGenerator, Awaitable, Callable, Self
 
 from fastapi import APIRouter, FastAPI
+from fastapi.telemetry import TelemetryConfig
 from pydantic import BaseModel, ConfigDict, field_validator
 from sqlalchemy import text
 from starlette.types import ASGIApp, Message, Receive, Scope, Send
@@ -168,7 +169,12 @@ class BaseServiceBuilder:
         self._system_options: _SystemOptions | None = None
         self._job_options: JobOptions | None = None
         self._auth_options: _AuthOptions | None = None
-        self._monitoring_options: _MonitoringOptions | None = None
+        self._monitoring_options: _MonitoringOptions | None = _MonitoringOptions(
+            prefix="/metrics",
+            tags=["Observability"],
+            service_name=None,
+            enable_traces=False,
+        )
         self._registration_options: _RegistrationOptions | None = None
         self._app_configs: list[App] = []
         self._custom_routers: list[APIRouter] = []
@@ -316,13 +322,17 @@ class BaseServiceBuilder:
 
     def with_monitoring(
         self,
+        enabled: bool = True,
         *,
         prefix: str = "/metrics",
         tags: list[str] | None = None,
         service_name: str | None = None,
         enable_traces: bool = False,
     ) -> Self:
-        """Enable OpenTelemetry monitoring with Prometheus endpoint and auto-instrumentation."""
+        """Configure OpenTelemetry monitoring (enabled by default); pass enabled=False to turn it off."""
+        if not enabled:
+            self._monitoring_options = None
+            return self
         self._monitoring_options = _MonitoringOptions(
             prefix=prefix,
             tags=list(tags) if tags is not None else ["Observability"],
@@ -426,6 +436,7 @@ class BaseServiceBuilder:
             description=self._app_description,
             version=self._version,
             lifespan=lifespan,
+            telemetry=self._build_telemetry_config(),
         )
         app.state.database_url = self._database_url
 
@@ -552,14 +563,26 @@ class BaseServiceBuilder:
         for dependency, override in self._dependency_overrides.items():
             app.dependency_overrides[dependency] = override
 
-        # Last, so it wraps any build_middleware_stack patch made above (OpenTelemetry instrumentation
-        # expects the stack it builds to start with ServerErrorMiddleware)
+        # Last, so it wraps any build_middleware_stack patch made above
         if self._registration_options is not None:
             app.state.readiness_token = secrets.token_hex(16)
             app.build_middleware_stack = _wrap_with_readiness_token(app)  # type: ignore[method-assign]
 
         return app
 
+    def _build_telemetry_config(self) -> TelemetryConfig:
+        """Build FastAPI OpenTelemetry settings: skip metrics scrapes when enabled, turn everything off when not."""
+        if self._monitoring_options is None:
+            return {"tracing": False, "metrics": False, "logs": False, "auto_configure": False}
+        metrics_prefix = self._monitoring_options.prefix
+
+        def exclude_metrics_scrape(scope: MutableMapping[str, Any]) -> bool:
+            """Skip telemetry for requests to the metrics endpoint."""
+            path = str(scope.get("path", ""))
+            return path == metrics_prefix or path.startswith(f"{metrics_prefix}/")
+
+        return {"exclude": exclude_metrics_scrape}
+
     # --------------------------------------------------------------------- Extension points
 
     def _validate_module_configuration(self) -> None: