#python#monitoring#programming 2 min

Guia ràpida per a un registre eficaç en Python amb Structlog

Traducció de l’original en anglès. Llegeix-lo en: CastellanoEnglish

El registre (logging) és una pràctica fonamental en el desenvolupament de programari per fer el seguiment i la depuració d'aplicacions. Tot i que el mòdul de logging integrat de Python fa la feina, Structlog porta el logging a un altre nivell oferint més flexibilitat i opcions de personalització. En aquesta guia explorarem els conceptes bàsics de l'ús de Structlog per a un registre potent i a mida en Python.

Instal·lació

Comença instal·lant Structlog amb la comanda següent:

pip install structlog

Configuració bàsica del registre

Structlog simplifica el procés de configurar el registre i ofereix funcions de personalització versàtils. Aquí tens un exemple bàsic de com pots configurar Structlog per al registre:

import structlog
import logging
import os

level = os.environ.get("LOG_LEVEL", "INFO").upper()
LOG_LEVEL = getattr(logging, level)

structlog.configure(
    wrapper_class=structlog.make_filtering_bound_logger(LOG_LEVEL))
logger = structlog.get_logger()

logger.debug("Database connection established")
logger.info("Processing data from the API")
logger.warning("Resource usage is nearing capacity")
logger.error("Failed to save the file. Please check permissions")
logger.critical("System has encountered a critical failure. Shutting down")

Exemple de sortida:

2023-08-28T10:00:00Z [INFO] Processing data from the API
2023-08-28T10:00:00Z [WARNING] Resource usage is nearing capacity
2023-08-28T10:00:00Z [ERROR] Failed to save the file. Please check permissions
2023-08-28T10:00:00Z [CRITICAL] System has encountered a critical failure. Shutting down

Registre asíncron amb asyncio

Structlog dona suport de manera transparent a les operacions asíncrones, cosa que el fa compatible amb asyncio:

import asyncio
import structlog

async def async_function():
    await logger.asyncinfo("Async log message")

asyncio.run(async_function())

Registrar excepcions amb tracebacks

Registrar excepcions i els seus tracebacks és molt senzill amb Structlog:

import structlog

try:
    result = 1 / 0
except ZeroDivisionError:
    logger.exception("Cannot divide one by zero!")

Exemple de sortida del traceback:

{
    "event": "Cannot divide one by zero!",
    "level": "error",
    "timestamp": "2023-07-31T07:00:31.526266Z",
    "exception": [
        {
            "exc_type": "ZeroDivisionError",
            "exc_value": "division by zero",
            "syntax_error": null,
            "is_cause": false,
            "frames": [
                {
                    "filename": "/home/stanley/structlog_demo/app.py",
                    "lineno": 16,
                    "name": "<module>",
                    "line": "",
                    "locals": {
                        "__name__": "__main__",
                        "__doc__": "None",
                        "__package__": "None",
                        "__loader__": "<_frozen_importlib_external.SourceFileLoader object at 0xffffaa2f3410>",
                        "__spec__": "None",
                        "__annotations__": "{}",
                        "__builtins__": "<module 'builtins' (built-in)>",
                        "__file__": "/home/stanley/structlog_demo/app.py",
                        "__cached__": "None",
                        "structlog": "\"<module 'structlog' from '/home/stanley/structlog_demo/venv/lib/python3.11/site-\"+32",
                        "logger": "'<BoundLoggerLazyProxy(logger=None, wrapper_class=None, processors=None, context_'+55"
                    }
                }
            ]
        }
    ]
}

Conclusió

El registre té un paper vital en el manteniment i la depuració d'aplicacions Python. Structlog capacita els desenvolupadors amb les seves funcions versàtils i les seves eines potents per a un registre eficaç. Consultant els exemples proporcionats en aquesta guia, estaràs ben equipat per implementar Structlog als teus projectes. Per a una exploració més detallada, consulta la documentació oficial de Structlog.

Que tinguis un bon registre!