configure application with bugsnag

Author: happy-devs

.gitignore

@@ -145,3 +145,4 @@ create_test_user.sql
 /.prs
 Taskfile.yml
 .env.local
+/.logs

main.py

@@ -3,17 +3,32 @@
 the frontend platform with the backend database.
 """
 
+import os
+import logging
+import datetime
 from dotenv import load_dotenv
-from fastapi import Depends, FastAPI
+from fastapi import Depends, FastAPI, Request
 from fastapi.middleware.cors import CORSMiddleware
+from fastapi.responses import JSONResponse
 
 from src import routers
 from src.authentication import authenticate_user
 from src.config.logging_config import setup_logging
+from src.bugsnag_config import configure_bugsnag, setup_bugsnag_logging, get_bugsnag_middleware, BUGSNAG_ENABLED
 
+# Load environment variables and set up logging
 load_dotenv()
 setup_logging()
 
+# Get application version
+app_version = os.environ.get("RELEASE_VERSION", "dev")
+app_env = os.environ.get("ENVIRONMENT", "development")
+logging.info(f"Starting application - version: {app_version}, environment: {app_env}")
+
+# Configure Bugsnag for error tracking
+configure_bugsnag()
+setup_bugsnag_logging()
+
 app = FastAPI(
     debug=False,
     title="Future Trends and Signals API",
@@ -60,6 +75,64 @@
     allow_headers=["*"],
 )
 
+# Add Bugsnag exception handling middleware
+app = get_bugsnag_middleware(app)
+
+# Add global exception handler to report errors to Bugsnag
+@app.exception_handler(Exception)
+async def global_exception_handler(request: Request, exc: Exception):
+    logging.error(f"Unhandled exception: {str(exc)}", exc_info=True)
+    
+    if BUGSNAG_ENABLED:
+        import bugsnag
+        bugsnag.notify(
+            exc,
+            metadata={
+                "request": {
+                    "url": str(request.url),
+                    "method": request.method,
+                    "headers": dict(request.headers),
+                    "client": request.client.host if request.client else None,
+                }
+            }
+        )
+    
+    return JSONResponse(
+        status_code=500,
+        content={"detail": "Internal server error"},
+    )
+
 
 for router in routers.ALL:
     app.include_router(router=router, dependencies=[Depends(authenticate_user)])
+
+# Add diagnostic endpoint for health checks and Bugsnag verification
+@app.get("/_health", include_in_schema=False)
+async def health_check():
+    """Health check endpoint that also shows the current environment and version."""
+    return {
+        "status": "ok",
+        "environment": app_env,
+        "version": app_version,
+        "bugsnag_enabled": BUGSNAG_ENABLED
+    }
+
+# Test endpoint to trigger a test error report to Bugsnag if enabled
+@app.get("/_test-error", include_in_schema=False)
+async def test_error():
+    """Trigger a test error to verify Bugsnag is working."""
+    if BUGSNAG_ENABLED:
+        import bugsnag
+        bugsnag.notify(
+            Exception("Test error triggered via /_test-error endpoint"),
+            metadata={
+                "test_info": {
+                    "environment": app_env,
+                    "version": app_version,
+                    "timestamp": str(datetime.datetime.now())
+                }
+            }
+        )
+        return {"status": "error_reported", "message": "Test error sent to Bugsnag"}
+    else:
+        return {"status": "disabled", "message": "Bugsnag is not enabled"}

requirements.txt

@@ -14,3 +14,4 @@ pillow ~= 11.0.0
 beautifulsoup4 ~= 4.12.3
 lxml ~= 5.3.0
 openai == 1.52.2
+bugsnag>=4.0.0

src/bugsnag_config.py

@@ -0,0 +1,76 @@
+"""
+Bugsnag configuration module for error tracking.
+"""
+
+import os
+import logging
+import bugsnag
+from bugsnag.handlers import BugsnagHandler
+from bugsnag.asgi import BugsnagMiddleware
+
+# Get API key from environment variable with fallback to the provided key
+BUGSNAG_API_KEY = os.environ.get("BUGSNAG_API_KEY")
+ENVIRONMENT = os.environ.get("ENVIRONMENT", "development")
+RELEASE_VERSION = os.environ.get("RELEASE_VERSION", "dev")
+
+if not BUGSNAG_API_KEY:
+    logging.warning("BUGSNAG_API_KEY is not set - error reporting will be disabled")
+    BUGSNAG_ENABLED = False
+else:
+    BUGSNAG_ENABLED = True
+
+def configure_bugsnag():
+    """Configure Bugsnag for error tracking."""
+    if not BUGSNAG_ENABLED:
+        logging.warning("Bugsnag is disabled - skipping configuration")
+        return
+        
+    bugsnag.configure(
+        api_key=BUGSNAG_API_KEY,
+        project_root=os.path.dirname(os.path.dirname(os.path.abspath(__file__))),
+        release_stage=ENVIRONMENT,
+        app_version=RELEASE_VERSION,
+        notify_release_stages=["production", "staging", "development"],
+        app_type="fastapi",
+    )
+    
+    logging.info(f"Bugsnag configured - environment: {ENVIRONMENT}, version: {RELEASE_VERSION}")
+
+def setup_bugsnag_logging(level=logging.ERROR):
+    """
+    Set up Bugsnag to capture logs at specified level.
+    
+    Parameters
+    ----------
+    level : int
+        Minimum log level to send to Bugsnag
+    """
+    if not BUGSNAG_ENABLED:
+        return
+        
+    logger = logging.getLogger()
+    handler = BugsnagHandler()
+    handler.setLevel(level)
+    logger.addHandler(handler)
+    
+    logging.info(f"Bugsnag logging handler added at level {level}")
+
+def get_bugsnag_middleware(app):
+    """
+    Wrap an ASGI app with Bugsnag middleware.
+    
+    Parameters
+    ----------
+    app : ASGI application
+        The FastAPI application instance
+    
+    Returns
+    -------
+    ASGI application
+        The application wrapped with Bugsnag middleware
+    """
+    if not BUGSNAG_ENABLED:
+        logging.warning("Bugsnag middleware not added - Bugsnag is disabled")
+        return app
+        
+    return BugsnagMiddleware(app)