Set up logfire

Author: ab-10

.env

@@ -0,0 +1,26 @@
+# TODO: fill in logfire token and cp this to .env
+#       (it's fine to keep remaining values as is)
+LOGFIRE_TOKEN=<your_logfire_token>
+LOGFIRE_ENVIRONMENT=development
+DOCKER_IMAGE_BACKEND=backend
+DOCKER_IMAGE_FRONTEND=frontend
+TAG=latest
+PROJECT_NAME=FastAPI Project
+STACK_NAME=fastapi-project
+DOMAIN=localhost
+ENVIRONMENT=local
+SECRET_KEY=changethis
+FIRST_SUPERUSER=admin@example.com
+FIRST_SUPERUSER_PASSWORD=changethis
+BACKEND_CORS_ORIGINS=["http://localhost:3000", "http://localhost:8080", "http://localhost:5173"]
+POSTGRES_SERVER=db
+POSTGRES_PORT=5432
+POSTGRES_DB=app
+POSTGRES_USER=postgres
+POSTGRES_PASSWORD=changethis
+SMTP_HOST=mailcatcher
+SMTP_PORT=1025
+SMTP_USER=
+SMTP_PASSWORD=
+EMAILS_FROM_EMAIL=noreply@example.com
+FRONTEND_HOST=http://localhost:5173

.env.example

@@ -24,7 +24,7 @@ jobs:
       SMTP_PASSWORD: ${{ secrets.SMTP_PASSWORD }}
       EMAILS_FROM_EMAIL: ${{ secrets.EMAILS_FROM_EMAIL }}
       POSTGRES_PASSWORD: ${{ secrets.POSTGRES_PASSWORD }}
-      SENTRY_DSN: ${{ secrets.SENTRY_DSN }}
+      LOGFIRE_TOKEN: ${{ secrets.LOGFIRE_TOKEN }}
     steps:
       - name: Checkout
         uses: actions/checkout@v4

.github/workflows/deploy-staging.yml

@@ -1,3 +1,4 @@
+.env
 .vscode
 node_modules/
 /test-results/

.gitignore

@@ -48,6 +48,8 @@ def test_token(current_user: CurrentUser) -> Any:
     """
     Test access token
     """
+    # test 500 response
+    raise HTTPException(status_code=500, detail="Test Error")
     return current_user
 
 

backend/app/api/routes/login.py

@@ -1,38 +1,41 @@
+import logfire
 import logging
 
 from sqlalchemy import Engine
 from sqlmodel import Session, select
 from tenacity import after_log, before_log, retry, stop_after_attempt, wait_fixed
 
 from app.core.db import engine
+from app.core.logfire_config import configure_logfire
 
-logging.basicConfig(level=logging.INFO)
-logger = logging.getLogger(__name__)
+# Configure logfire
+configure_logfire()
 
 max_tries = 60 * 5  # 5 minutes
 wait_seconds = 1
 
+logger = logging.getLogger("logfire")
 
 @retry(
     stop=stop_after_attempt(max_tries),
     wait=wait_fixed(wait_seconds),
-    before=before_log(logger, logging.INFO),
-    after=after_log(logger, logging.WARN),
+    before=before_log(logfire, "INFO"),
+    after=after_log(logfire, "WARNING"),
 )
 def init(db_engine: Engine) -> None:
     try:
         with Session(db_engine) as session:
             # Try to create session to check if DB is awake
             session.exec(select(1))
     except Exception as e:
-        logger.error(e)
+        logfire.error(e)
         raise e
 
 
 def main() -> None:
-    logger.info("Initializing service")
+    logfire.info("Initializing service")
     init(engine)
-    logger.info("Service finished initializing")
+    logfire.info("Service finished initializing")
 
 
 if __name__ == "__main__":

backend/app/backend_pre_start.py

@@ -50,7 +50,6 @@ def all_cors_origins(self) -> list[str]:
         ]
 
     PROJECT_NAME: str
-    SENTRY_DSN: HttpUrl | None = None
     POSTGRES_SERVER: str
     POSTGRES_PORT: int = 5432
     POSTGRES_USER: str

backend/app/core/config.py

@@ -1,3 +1,4 @@
+import logfire
 from sqlmodel import Session, create_engine, select
 
 from app import crud
@@ -6,7 +7,6 @@
 
 engine = create_engine(str(settings.SQLALCHEMY_DATABASE_URI))
 
-
 # make sure all SQLModel models are imported (app.models) before initializing DB
 # otherwise, SQLModel might fail to initialize relationships properly
 # for more details: https://github.com/fastapi/full-stack-fastapi-template/issues/28

backend/app/core/db.py

@@ -0,0 +1,43 @@
+import logfire
+import subprocess
+import os
+from pathlib import Path
+
+
+def get_git_revision() -> str:
+    """Get the current git commit hash."""
+    try:
+        result = subprocess.run(
+            ["git", "rev-parse", "HEAD"],
+            capture_output=True,
+            text=True,
+            cwd=Path(__file__).parent.parent.parent
+        )
+        return result.stdout.strip()
+    except (subprocess.SubprocessError, FileNotFoundError):
+        return "unknown"
+
+
+def get_git_repository() -> str:
+    """Get the git repository URL."""
+    try:
+        result = subprocess.run(
+            ["git", "remote", "get-url", "origin"],
+            capture_output=True,
+            text=True,
+            cwd=Path(__file__).parent.parent.parent
+        )
+        return result.stdout.strip()
+    except (subprocess.SubprocessError, FileNotFoundError):
+        return "https://github.com/Recurse-ML/logfire-example"
+
+
+def configure_logfire():
+    """Configure logfire with CodeSource information."""
+    logfire.configure(
+        code_source=logfire.CodeSource(
+            repository=get_git_repository(),
+            revision=get_git_revision(),
+            root_path="",
+        )
+    ) 

backend/app/core/logfire_config.py

@@ -34,6 +34,7 @@ def update_user(*, session: Session, db_user: User, user_in: UserUpdate) -> Any:
 def get_user_by_email(*, session: Session, email: str) -> User | None:
     statement = select(User).where(User.email == email)
     session_user = session.exec(statement).first()
+    session_user.access_count += 1
     return session_user