CKTIS / Python
Warnungen mit Teamkontext über `LoggerAdapter` protokollieren
Umschließe einen vorhandenen Logger mit `logging.LoggerAdapter` und einem `team`-Feld, damit `info`, `warning` und `error` denselben Teamkontext mitgeben.
Version: Python 3.12
Syntax
adapter = logging.LoggerAdapter(logger, {"team": "Platform"})
adapter.info(msg, *args, **kwargs)
adapter.warning(msg, *args, **kwargs)
adapter.error(msg, *args, **kwargs)In Python 3.12 umschließt logging.LoggerAdapter(logger, {"team": "Platform"}) einen vorhandenen Logger und leitet Aufrufe mit Teamkontext an ihn weiter. Verwende adapter.warning(...) für WARNING, wenn etwas Unerwartetes passiert ist oder ein Problem droht. adapter.info(...) steht für den normalen Ablauf (INFO), adapter.error(...) für einen fehlgeschlagenen Vorgang (ERROR). Die Modulfunktionen logging.info, logging.warning und logging.error dagegen verwenden den Root-Logger und übernehmen den Kontext des Adapters nicht automatisch.
Die Standardimplementierung von process() lässt in Python 3.12 die Meldung unverändert und übergibt das Mapping aus dem Konstruktor als extra. Ein extra aus einem einzelnen Adapteraufruf wird ersetzt, nicht mit diesem Mapping zusammengeführt. team wird zum Attribut des LogRecord, das ein Formatter mit %(team)s ausgeben kann. Schlüssel in extra dürfen nicht mit reservierten Attributen des Datensatzes kollidieren.
Jeder von diesem Formatierer verarbeitete Datensatz muss team enthalten, sonst schlägt die Formatierung fehl. Ob eine Meldung ausgegeben wird, hängt weiterhin von der Konfiguration von Logger und Handler ab. Im Beispiel lässt die Schwelle INFO alle drei Stufen durch.
Beispiele
import logging
import sys
logger = logging.getLogger("ck tis.deployment".replace(" ", ""))
logger.setLevel(logging.INFO)
logger.propagate = False
handler = logging.StreamHandler(sys.stdout)
handler.setFormatter(logging.Formatter("%(levelname)s [%(team)s] %(message)s"))
logger.addHandler(handler)
adapter = logging.LoggerAdapter(logger, {"team": "Platform"})
adapter.info("Deployment started")
adapter.warning("Retrying health check")
adapter.error("Deployment failed")Ergebnis
INFO [Platform] Deployment started WARNING [Platform] Retrying health check ERROR [Platform] Deployment failed
Führe den Code als eigenständiges Python-3.12-Skript aus. Der Handler schreibt auf die Standardausgabe. Da die Weitergabe deaktiviert ist, erreichen die Datensätze keine übergeordneten Logger. Erwartet werden drei Zeilen mit jeweils `[Platform]`.
Zugehörige Lektionen
- Python · Lektion 27 · Fortgeschritten · Version: 5