KennisbankExamencentrum
NL · NLNederlands (Nederland)
Taal kiezen13

CKTIS / Python

Waarschuwingen met teamcontext loggen via `LoggerAdapter`

Wikkel een bestaande logger in een `logging.LoggerAdapter` met een `team`-veld, zodat aanroepen van `info`, `warning` en `error` dezelfde teamcontext meekrijgen.

Versie: 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 wikkelt logging.LoggerAdapter(logger, {"team": "Platform"}) een bestaande logger in en stuurt hij aanroepen met teamcontext door. Gebruik adapter.warning(...) voor een WARNING als er iets onverwachts is gebeurd of als er een probleem dreigt. Gebruik adapter.info(...) voor normale voortgang (INFO) en adapter.error(...) voor een mislukte bewerking (ERROR). De modulefuncties logging.info, logging.warning en logging.error gebruiken daarentegen de rootlogger en krijgen de context van de adapter niet automatisch mee.

De standaardimplementatie van process() laat in Python 3.12 het bericht onveranderd en geeft de mapping uit de constructor door als extra. Geef je zelf extra op bij een adapteraanroep, dan wordt die waarde vervangen, niet samengevoegd. team wordt een attribuut van het LogRecord, zodat een Formatter het kan weergeven met %(team)s. Sleutels in extra mogen niet botsen met gereserveerde attributen van het record.

Elk record dat door die formatter wordt verwerkt, moet team bevatten; anders mislukt de opmaak. De configuratie van de logger en de handler bepaalt nog steeds of een bericht wordt uitgevoerd. In het voorbeeld laat de INFO-drempel alle drie de niveaus door.

Voorbeelden

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")

Resultaat

INFO [Platform] Deployment started
WARNING [Platform] Retrying health check
ERROR [Platform] Deployment failed

Voer de code uit als zelfstandig script in Python 3.12. De handler schrijft naar de standaarduitvoer. Omdat propagatie is uitgeschakeld, bereiken de records geen bovenliggende loggers. Verwacht drie regels, elk met `[Platform]`.

Gerelateerde lessen

  • Python · Les 27 · Gevorderd · Versie: 5

Bronnen