feat(Option): Logfire 🔥 (#89)

Author: mslaursen

docker-compose.yaml

@@ -13,7 +13,7 @@ services:
       - "5432:5432"
     restart: always
     healthcheck:
-      test: pg_isready -U forge
+      test: pg_isready -U postgres
       interval: 2s
       timeout: 3s
       retries: 40

fastapi_forge/example-projects/game_zone.yaml

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

fastapi_forge/frontend/panels/project_config_panel.py

@@ -206,13 +206,18 @@ def _build(self) -> None:
                 )
 
             with ui.column().classes("w-full gap-2"):
-                ui.label("Metrics").classes("text-lg font-bold")
+                ui.label("Observability").classes("text-lg font-bold")
                 self.use_prometheus = (
                     ui.checkbox("Prometheus", value=state.use_prometheus)
                     .classes("w-full")
                     .bind_value_from(state, "use_prometheus")
                     .tooltip("Collect and query metrics with Prometheus")
                 )
+                self.use_logfire = (
+                    ui.checkbox("Logfire", value=state.use_logfire)
+                    .classes("w-full")
+                    .bind_value_from(state, "use_logfire")
+                )
 
             with ui.column().classes("w-full gap-2"):
                 ui.label("Object Storage").classes("text-lg font-bold")
@@ -247,6 +252,7 @@ def _bind_state_to_ui(self) -> None:
         )
         self.use_taskiq.bind_value_to(state, "use_taskiq")
         self.use_prometheus.bind_value_to(state, "use_prometheus")
+        self.use_logfire.bind_value_to(state, "use_logfire")
 
     def _update_taskiq_state(self, *_) -> None:
         """Enable or disable Taskiq based on Redis and RabbitMQ."""
@@ -422,6 +428,7 @@ async def _create_project(self) -> None:
             state.use_rabbitmq = self.use_rabbitmq.value
             state.use_taskiq = self.use_taskiq.value
             state.use_prometheus = self.use_prometheus.value
+            state.use_logfire = self.use_logfire.value
 
             project_spec = state.get_project_spec()
             await build_fastapi_project(project_spec)

fastapi_forge/frontend/state.py

@@ -55,6 +55,7 @@ class ProjectState(BaseModel):
     use_rabbitmq: bool = False
     use_taskiq: bool = False
     use_prometheus: bool = False
+    use_logfire: bool = False
 
     def get_render_manager(self) -> RenderManager:
         """Get the render manager for the current project."""
@@ -88,6 +89,7 @@ def initialize_from_project(self, project: ProjectSpec) -> None:
         self.use_rabbitmq = project.use_rabbitmq
         self.use_taskiq = project.use_taskiq
         self.use_prometheus = project.use_prometheus
+        self.use_logfire = project.use_logfire
         self.models = project.models.copy()
         self.custom_enums = project.custom_enums.copy()
 
@@ -203,6 +205,7 @@ def get_project_spec(self) -> ProjectSpec:
             use_rabbitmq=self.use_rabbitmq,
             use_taskiq=self.use_taskiq,
             use_prometheus=self.use_prometheus,
+            use_logfire=self.use_logfire,
             models=self.models,
             custom_enums=self.custom_enums,
         )

fastapi_forge/schemas.py

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

fastapi_forge/template/cookiecutter.json

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

fastapi_forge/template/{{cookiecutter.project_name}}/.env.example

@@ -32,4 +32,8 @@
 {% endif %}
 {%- if cookiecutter.use_prometheus %}
 {{ cookiecutter.project_name|upper|replace('-', '_') }}_PROMETHEUS_ENABLED=True
-{% endif %}
+{% endif %}
+{%- if cookiecutter.use_logfire %}
+{{ cookiecutter.project_name|upper|replace('-', '_') }}_LOGFIRE_ENABLED=True
+{{ cookiecutter.project_name|upper|replace('-', '_') }}_LOGFIRE_WRITE_TOKEN=""
+{% endif %}

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

@@ -39,6 +39,11 @@ paths:
     paths:
       - observability/prometheus
 
+  use_logfire:
+    enabled: {{cookiecutter.use_logfire | lower}}
+    paths:
+      - observability/logfire
+
   constants:
     requires_all:
       - use_builtin_auth
@@ -49,6 +54,7 @@ paths:
   observability:
     requires_all:
       - use_prometheus
+      - use_logfire
     paths:
       - observability
 

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

@@ -47,6 +47,9 @@ dependencies = [
     {%- if cookiecutter.use_prometheus -%}
     "prometheus-fastapi-instrumentator>=7.1.0",
     {%- endif %}
+    {%- if cookiecutter.use_logfire -%}
+    "logfire[aio-pika,asyncpg,fastapi,httpx,sqlalchemy,system-metrics]>=3.16.0",
+    {%- endif %}
 ]
 
 [tool.pytest.ini_options]

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

@@ -4,20 +4,50 @@
 {% if cookiecutter.use_prometheus %}
 from prometheus_fastapi_instrumentator import Instrumentator
 {% endif %}
+{% if cookiecutter.use_logfire %}
+import logfire
+from loguru import logger
+{% 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)
+    if not settings.prometheus.enabled:
+        return
+    instrumenter = Instrumentator().instrument(app)
+    instrumenter.expose(app)
+{% endif %}
+{% if cookiecutter.use_logfire %}
+def _add_logfire_middleware(app: FastAPI) -> None:
+    """Add Logfire Middleware."""
+    if not settings.logfire.enabled:
+        return
+    if not settings.logfire.write_token:
+        logger.warning(
+            "Logfire is enabled but no write token is provided. "
+            "Skipping Logfire middleware."
+        )
+        return
+    logfire.configure(
+        token=settings.logfire.write_token.get_secret_value(),
+        environment=settings.env,
+        send_to_logfire="if-token-present",
+        service_name="game_zone",
+    )
+    logfire.instrument_fastapi(app, capture_headers=True)
+    logfire.instrument_asyncpg()
+    logfire.instrument_system_metrics()
+    logger.configure(handlers=[logfire.loguru_handler()])
 {% endif %}
 def add_middleware(app: FastAPI) -> None:
     """Add all middlewares."""
     _add_cors_middleware(app)
     {%- if cookiecutter.use_prometheus %}
     _add_prometheus_middleware(app)
+    {% endif %}
+    {%- if cookiecutter.use_logfire %}
+    _add_logfire_middleware(app)
     {% endif %}