#python#monitoring#programming 2 min

Guía rápida para un registro eficaz en Python con Structlog

Traducción del original en inglés. Léela en: CatalàEnglish

El registro (logging) es una práctica fundamental en el desarrollo de software para hacer el seguimiento y la depuración de aplicaciones. Aunque el módulo de logging integrado de Python hace el trabajo, Structlog lleva el logging a otro nivel ofreciendo más flexibilidad y opciones de personalización. En esta guía exploraremos los conceptos básicos del uso de Structlog para un registro potente y a medida en Python.

Instalación

Empieza instalando Structlog con el siguiente comando:

pip install structlog

Configuración básica del registro

Structlog simplifica el proceso de configurar el registro y ofrece funciones de personalización versátiles. Aquí tienes un ejemplo básico de cómo puedes configurar Structlog para el registro:

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

Ejemplo de salida:

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

Registro asíncrono con asyncio

Structlog soporta de forma transparente las operaciones asíncronas, lo que lo hace compatible con asyncio:

import asyncio
import structlog

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

asyncio.run(async_function())

Registrar excepciones con tracebacks

Registrar excepciones y sus tracebacks es muy sencillo con Structlog:

import structlog

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

Ejemplo de salida 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ón

El registro desempeña un papel vital en el mantenimiento y la depuración de aplicaciones Python. Structlog capacita a los desarrolladores con sus funciones versátiles y sus potentes características para un registro eficaz. Consultando los ejemplos proporcionados en esta guía, estarás bien equipado para implementar Structlog en tus proyectos. Para una exploración más detallada, consulta la documentación oficial de Structlog.

¡Feliz registro!