Python, FastAPI, Django und Flask einrichten
So erfassen Sie Fehler aus Python-Anwendungen mit dem offiziellen Fehler-SDK oder direkt über die JSON-API.
Mit dem offiziellen SDK
Am einfachsten nutzen Sie das offizielle Open-Source-Fehler-SDK für Python. Es erkennt Django, FastAPI, Flask, Celery und weitere Frameworks automatisch. Paketname und Code stehen in der Einrichtungs-Doku: https://monitor.agiledeveloper.de/docs/einrichten#python
- Legen Sie unter Projekte (
/app/projekte) ein Projekt mit der Plattform Python an und kopieren Sie die DSN. - Installieren Sie das SDK mit pip.
- Initialisieren Sie es so früh wie möglich mit DSN, Umgebung und einer kleinen Rate für Leistungsdaten:
- Django: in
settings.py - FastAPI: in
main.py, vor dem Anlegen der App - Flask: in
app.py, vor dem Anlegen der App - Starten Sie die Anwendung neu und senden Sie im Assistenten ein Test-Ereignis.
Das SDK sendet persönliche Daten standardmäßig nicht. Was trotzdem ankommt, etwa ein Passwort in einem Formularfeld, bereinigen wir vor dem Speichern.
Ohne SDK: JSON-API mit requests
Für Skripte, Importjobs oder kleine Dienste genügt ein HTTP-Aufruf an die JSON-API:
import os
import traceback
import requests
SCHLUESSEL = os.environ["MONITOR_SCHLUESSEL"]
def fehler_melden(fehler: Exception, **extra):
requests.post(
"https://monitor.agiledeveloper.de/api/eingang/v1/ereignisse",
headers={"Authorization": f"Bearer {SCHLUESSEL}"},
json={
"level": "error",
"umgebung": os.environ.get("UMGEBUNG", "production"),
"release": os.environ.get("APP_VERSION"),
"ausnahme": {
"typ": type(fehler).__name__,
"wert": str(fehler),
"stack": "".join(traceback.format_exception(fehler)),
},
"extra": extra,
},
timeout=5,
)
try:
import_starten()
except Exception as f:
fehler_melden(f, datei="kunden.csv")
raiseDer Schlüssel geht im Kopf Authorization: Bearer oder X-Agile-Schluessel mit. Sie können bis zu 100 Ereignisse auf einmal als {"ereignisse": [...]} schicken. Alle Felder: https://monitor.agiledeveloper.de/docs/einrichten#json-api
Celery und Hintergrundaufgaben
Fehler in Celery-Tasks erfasst das SDK automatisch. Wenn Sie zusätzlich wissen möchten, ob ein regelmäßiger Task überhaupt läuft, legen Sie einen Heartbeat an. Die Cron-Check-ins des SDKs werden automatisch zu Heartbeats. Alternativ rufen Sie am Ende des Tasks die Ping-Adresse auf:
requests.get("https://monitor.agiledeveloper.de/api/ping/<token>", timeout=10)Mehr dazu im Artikel „Heartbeats und Cronjobs“.
Umgebungen und Releases
Setzen Sie die Umgebung auf production, staging oder development. Fehler aus Staging schließen Sie unter Projekte › Einstellungen › Filter mit einem Klick aus. Das Release, zum Beispiel die Git-Version, zeigt, seit wann ein Fehler auftritt, und ermöglicht die Erkennung von Rückfällen.
Prüfen
Wenn nichts ankommt, prüfen Sie die DSN, ausgehendes HTTPS zu monitor.agiledeveloper.de und die Filter des Projekts. Hinweise zu Antworten wie 401 oder 429 finden Sie unter https://monitor.agiledeveloper.de/docs/einrichten#grenzen