feat(Option): Prometheus (#53)

Author: mslaursen

fastapi_forge/dtos.py

@@ -363,6 +363,7 @@ class ProjectSpec(_Base):
     use_redis: bool = False
     use_rabbitmq: bool = False
     use_taskiq: bool = False
+    use_prometheus: bool = False
     models: list[Model] = []
     custom_enums: list[CustomEnum] = []
 

fastapi_forge/example-projects/game_zone.yaml

@@ -6,6 +6,7 @@ project:
   use_redis: true
   use_rabbitmq: true
   use_taskiq: true
+  use_prometheus: true
 
   custom_enums:
     - name: UserRole

fastapi_forge/frontend/panels/project_config_panel.py

@@ -209,10 +209,10 @@ def _build(self) -> None:
             with ui.column().classes("w-full gap-2"):
                 ui.label("Metrics").classes("text-lg font-bold")
                 self.use_prometheus = (
-                    ui.checkbox("Prometheus")
+                    ui.checkbox("Prometheus", value=state.use_prometheus)
                     .classes("w-full")
-                    .tooltip("Coming soon!")
-                    .set_enabled(False)
+                    .bind_value_from(state, "use_prometheus")
+                    .tooltip("Collect and query metrics with Prometheus")
                 )
 
             with ui.column().classes("w-full gap-2"):
@@ -247,6 +247,7 @@ def _bind_state_to_ui(self) -> None:
             "change", self._update_taskiq_state
         )
         self.use_taskiq.bind_value_to(state, "use_taskiq")
+        self.use_prometheus.bind_value_to(state, "use_prometheus")
 
     def _update_taskiq_state(self, *_) -> None:
         """Enable or disable Taskiq based on Redis and RabbitMQ."""
@@ -421,6 +422,7 @@ async def _create_project(self) -> None:
             state.use_redis = self.use_redis.value
             state.use_rabbitmq = self.use_rabbitmq.value
             state.use_taskiq = self.use_taskiq.value
+            state.use_prometheus = self.use_prometheus.value
 
             project_spec = state.get_project_spec()
             await build_project(project_spec)

fastapi_forge/frontend/state.py

@@ -51,6 +51,7 @@ class ProjectState(BaseModel):
     use_redis: bool = False
     use_rabbitmq: bool = False
     use_taskiq: bool = False
+    use_prometheus: bool = False
 
     def switch_item_editor(
         self,
@@ -79,6 +80,7 @@ def initialize_from_project(self, project: ProjectSpec) -> None:
         self.use_redis = project.use_redis
         self.use_rabbitmq = project.use_rabbitmq
         self.use_taskiq = project.use_taskiq
+        self.use_prometheus = project.use_prometheus
         self.models = project.models.copy()
         self.custom_enums = project.custom_enums.copy()
 
@@ -191,6 +193,7 @@ def get_project_spec(self) -> ProjectSpec:
             use_redis=self.use_redis,
             use_rabbitmq=self.use_rabbitmq,
             use_taskiq=self.use_taskiq,
+            use_prometheus=self.use_prometheus,
             models=self.models,
             custom_enums=self.custom_enums,
         )

fastapi_forge/template/cookiecutter.json

@@ -20,6 +20,9 @@
     "use_taskiq": {
         "default": true
     },
+    "use_prometheus": {
+        "default": true
+    },
     "models": {
         "models": []
     },

fastapi_forge/template/{{cookiecutter.project_name}}/docker-compose.yaml

@@ -51,6 +51,9 @@ services:
       {{ cookiecutter.project_name|upper|replace('-', '_') }}_RABBITMQ_CONNECTION_POOL_SIZE: 2
       {{ cookiecutter.project_name|upper|replace('-', '_') }}_RABBITMQ_CHANNEL_POOL_SIZE: 10
       {% endif %}
+      {%- if cookiecutter.use_rabbitmq -%}
+      {{ cookiecutter.project_name|upper|replace('-', '_') }}_PROMETHEUS_ENABLED: true
+      {% endif %}
     {%- if cookiecutter.use_alembic %}
     volumes:
       - ./migrations:/app/migrations
@@ -139,6 +142,17 @@ services:
     volumes:
       - {{ cookiecutter.project_name }}-rabbitmq-data:/var/lib/rabbitmq
   {% endif %}
+  {%- if cookiecutter.use_prometheus -%}
+  prometheus:
+    image: prom/prometheus:latest
+    restart: always
+    volumes:
+      - ./observability/prometheus/prometheus.yaml:/etc/prometheus/prometheus.yaml
+    command:
+      - "--config.file=/etc/prometheus/prometheus.yaml"
+    ports:
+      - 9090:9090
+  {% endif %}
 {%- if cookiecutter.use_postgres or cookiecutter.use_redis or cookiecutter.use_rabbitmq %}
 volumes:
   {%- if cookiecutter.use_postgres %}

fastapi_forge/template/{{cookiecutter.project_name}}/forge-config.yaml

@@ -33,6 +33,11 @@ paths:
     enabled: {{cookiecutter.use_taskiq | lower}}
     paths:
       - src/services/taskiq
+  
+  use_prometheus:
+    enabled: {{cookiecutter.use_prometheus | lower}}
+    paths:
+      - observability/prometheus
 
   constants:
     requires_all:
@@ -41,4 +46,12 @@ paths:
     paths:
       - src/constants.py
 
+  observability:
+    requires_all:
+      - use_prometheus
+    paths:
+      - observability
+
+  
+
 

fastapi_forge/template/{{cookiecutter.project_name}}/observability/prometheus/prometheus.yaml

@@ -0,0 +1,8 @@
+global:
+  scrape_interval: 15s
+
+scrape_configs:
+  - job_name: "metrics"
+    metrics_path: /metrics
+    static_configs:
+      - targets: ["{{ cookiecutter.project_name }}-api:8000"]

fastapi_forge/template/{{cookiecutter.project_name}}/pyproject.toml

@@ -41,6 +41,9 @@ dependencies = [
     "taskiq-fastapi>=0.3.4",
     "orjson>=3.10.16",
     {%- endif %}
+    {%- if cookiecutter.use_prometheus -%}
+    "prometheus-fastapi-instrumentator>=7.1.0",
+    {%- endif %}
 ]
 
 [tool.pytest.ini_options]

fastapi_forge/template/{{cookiecutter.project_name}}/src/middleware.py

@@ -1,12 +1,23 @@
 from fastapi.middleware.cors import CORSMiddleware
 from fastapi import FastAPI
+from src.settings import settings
+{% if cookiecutter.use_prometheus %}
+from prometheus_fastapi_instrumentator import Instrumentator
+{% endif %}
 
 def _add_cors_middleware(app: FastAPI) -> None:
     """Add CORS Middleware."""
     app.add_middleware(CORSMiddleware, allow_origins=["*"])
-
-
+{% if cookiecutter.use_prometheus %}
+def _add_prometheus_middleware(app: FastAPI) -> None:
+    """Add Prometheus Middleware."""
+    if settings.prometheus.enabled:
+        instrumenter = Instrumentator().instrument(app)
+        instrumenter.expose(app)
+{% endif %}
 def add_middleware(app: FastAPI) -> None:
     """Add all middlewares."""
-
-    _add_cors_middleware(app)
+    _add_cors_middleware(app)
+    {%- if cookiecutter.use_prometheus %}
+    _add_prometheus_middleware(app)
+    {% endif %}