Merge pull request #28 from community-of-python/exclude-metrics-from-openapi-schema

Exclude `/metrics` from OpenAPI schema by default & allow to configure the exclusion

Author: vrslev

README.md

@@ -233,6 +233,7 @@ class YourFastApiSettings(FastApiSettings):
     service_name: str
 
     prometheus_metrics_path: str = "/metrics"
+    prometheus_metrics_include_in_schema: bool = False
     prometheus_instrumentator_params: dict[str, typing.Any] = {}
     prometheus_instrument_params: dict[str, typing.Any] = {}
     prometheus_expose_params: dict[str, typing.Any] = {}
@@ -244,6 +245,7 @@ Parameters description:
 
 - `service_name` - will be attached to metric's names, but has to be named in [snake_case](https://en.wikipedia.org/wiki/Snake_case).
 - `prometheus_metrics_path` - path to metrics handler.
+- `prometheus_metrics_include_in_schema` - whether to include metrics route in OpenAPI schema.
 - `prometheus_instrumentator_params` - will be passed to `Instrumentor` during initialization.
 - `prometheus_instrument_params` - will be passed to `Instrumentor.instrument(...)`.
 - `prometheus_expose_params` - will be passed to `Instrumentor.expose(...)`.

microbootstrap/bootstrappers/fastapi.py

@@ -106,6 +106,7 @@ def bootstrap_after(self, application: fastapi.FastAPI) -> fastapi.FastAPI:
         ).expose(
             application,
             endpoint=self.instrument_config.prometheus_metrics_path,
+            include_in_schema=self.instrument_config.prometheus_metrics_include_in_schema,
             **self.instrument_config.prometheus_expose_params,
         )
         return application

microbootstrap/bootstrappers/litestar.py

@@ -124,6 +124,7 @@ class LitestarPrometheusInstrument(PrometheusInstrument[LitestarPrometheusConfig
     def bootstrap_before(self) -> dict[str, typing.Any]:
         class LitestarPrometheusController(PrometheusController):
             path = self.instrument_config.prometheus_metrics_path
+            include_in_schema = self.instrument_config.prometheus_metrics_include_in_schema
             openmetrics_format = True
 
         litestar_prometheus_config: typing.Final = PrometheusConfig(

microbootstrap/instruments/prometheus_instrument.py

@@ -14,6 +14,7 @@ class BasePrometheusConfig(BaseInstrumentConfig):
     service_name: str = "micro-service"
 
     prometheus_metrics_path: str = "/metrics"
+    prometheus_metrics_include_in_schema: bool = False
 
 
 class LitestarPrometheusConfig(BasePrometheusConfig):