Merge pull request #229 from steersbob/feature/faulthandler

Enable faulthandler if config.debugger is set

.vscode/launch.json

@@ -0,0 +1,19 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Python: Remote Attach",
+            "type": "python",
+            "request": "attach",
+            "port": 5678,
+            "host": "buildbot32.local",
+            "pathMappings": [
+                {
+                    "localRoot": "${workspaceFolder}",
+                    "remoteRoot": "/app"
+                }
+            ]
+        }
+    ],
+    "compounds": []
+}

brewblox_history/app_factory.py

@@ -60,6 +60,14 @@ def create_app() -> FastAPI:
     config = utils.get_config()
     setup_logging(config.debug)
 
+    if config.debugger:  # pragma: no cover
+        import faulthandler
+        faulthandler.enable()
+
+        import debugpy
+        debugpy.listen(('0.0.0.0', 5678))
+        LOGGER.info('Debugger is enabled and listening on 5678')
+
     # Call setup functions for modules
     mqtt.setup()
     redis.setup()

brewblox_history/models.py

@@ -40,6 +40,7 @@ class ServiceConfig(BaseSettings):
 
     name: str = 'history'
     debug: bool = False
+    debugger: bool = False
 
     mqtt_protocol: Literal['mqtt', 'mqtts'] = 'mqtt'
     mqtt_host: str = 'eventbus'

pyproject.toml

@@ -19,6 +19,7 @@ pydantic-settings = "^2.1.0"
 fastapi-mqtt = "^2.0.0"
 httpx = "^0.25.2"
 websockets = "^12.0"
+debugpy = "^1.8.0"
 
 [tool.poetry.group.dev.dependencies]
 pytest-cov = "*"