Add optional APITally monitoring support to API (#348)

* Add optional APITally monitoring support to API

* Address review feedback: conditionally enable middleware, default env local, add logging options

* Change default APITally environment to open_quartz_local

Author: CodeVishal-17

README.md

@@ -89,6 +89,16 @@ and how we can make improvements in the future.
 Note that any latitudes and longitudes are rounded to 2 decimals places in order to anonymize the data.
 If you would like to disable this logging, you can do so by setting the environment variable `QUARTZ_SOLAR_FORECAST_LOGGING` to `False`.
 
+### API Monitoring (APITally)
+
+The FastAPI application supports optional monitoring via APITally.
+
+To enable API request monitoring, set the following environment variables before starting the API:
+
+```bash
+export APITALLY_CLIENT_ID=your_client_id
+export APITALLY_ENVIRONMENT=open_quartz_local
+```
 
 ## Model
 

api/v1/api.py

@@ -5,6 +5,7 @@
 from importlib.metadata import version
 
 import pandas as pd
+from apitally.fastapi import ApitallyMiddleware
 from fastapi import FastAPI
 from fastapi.middleware.cors import CORSMiddleware
 from pydantic import BaseModel, Field
@@ -95,6 +96,19 @@
 
 app = FastAPI(description=description, version=__version__, title="Open Quartz Solar Forecast API")
 
+client_id = os.getenv("APITALLY_CLIENT_ID")
+
+if client_id:
+    app.add_middleware(
+        ApitallyMiddleware,
+        client_id=client_id,
+        environment=os.getenv("APITALLY_ENVIRONMENT", "open_quartz_local"),
+        enable_request_logging=True,
+        log_request_headers=True,
+        log_request_body=True,
+        log_response_body=True,
+        capture_logs=True,
+    )
 # CORS middleware setup
 origins = [
     "*",

pyproject.toml

@@ -27,7 +27,8 @@ dependencies = [
     "pydantic_settings",
     "httpx",
     "sentry_sdk",
-    "huggingface_hub==0.17.3"
+    "huggingface_hub==0.17.3",
+    "apitally[fastapi]>=0.22.3"
 ]
 
 [project.urls]
@@ -51,6 +52,7 @@ dev = [
     "matplotlib",
     "zipfile36",
     "pytest",
+    "huggingface_hub==0.17.3"
 ]
 inverters = ["ocf_vrmapi"] # victron
 all = [
@@ -60,6 +62,7 @@ all = [
     "gdown==5.1.0",
     "fastapi",
     "pytest",
+    "huggingface_hub==0.17.3"
 ]
 
 [tool.mypy]