Registro de actividad — Python: Desarrollo web con Flask

• ¿Qué pasa cuando tu código empieza a fallar?
• ¿Cómo lucen los logs?
• ¿Qué es el logging (registro) en una aplicación web?
• Logging en Flask
• Niveles de logging

Hoy veremos un tema clave en el mundo real de la programación: diagnosticar y buscar errores en aplicaciones en producción. Para ello, aprenderemos a usar una herramienta esencial: el log o registro de eventos, algo que todo desarrollador usa a diario. ¡Vamos allá!

¿Qué pasa cuando tu código empieza a fallar?

Cuando estás comenzando a programar y algo no funciona, lo más común es abrir el archivo, probar imprimir valores con print() por aquí y por allá, y ver qué sale. Esto está bien si tu código es pequeño.

Pero... ¿y si estás trabajando en una aplicación web real? 😱

Un sitio web común y corriente puede tener:

Y eso no es lo más complejo. Aplicaciones reales usan muchos servidores, colas de tareas, servicios externos, caching, bases de datos distribuidas, etc. Es como una torta de muchas capas. ¿Cómo saber en qué capa se rompió algo?

Aquí es donde entra en juego el concepto de log o registro.

Al ver lo que pasó, cuándo, y en qué orden, se puede descubrir el origen del problema.

¿Cómo lucen los logs?

Aquí un ejemplo de un log real de un servidor web:

# Formato simplificado:
IP              FECHA Y HORA                  MÉTODO  URI                         CÓDIGO  TAMAÑO
173.245.52.110 - [19/Jan/2021:01:54:20 +0000] "GET /my HTTP/1.1"                 200     46018
162.158.62.12  - [19/Jan/2021:01:54:20 +0000] "GET /packs/css/application.css"  304     0

Con esta información puedes saber:

• Qué usuario hizo una petición (por IP)
• A qué hora lo hizo
• A qué URL
• Qué respuesta dio el servidor

Esto es útil para detectar fallas. Por ejemplo, si un usuario dice que “la página no cargaba”, puedes buscar en el archivo de logs qué pasó en ese momento.

También se pueden hacer búsquedas con herramientas como grep:

# Buscar log entre 19:31 y 19:35 del 31 de marzo de 2020
grep "31/Mar/2020:19:3[1-5]" access.log

¿Qué es el logging (registro) en una aplicación web?

En aplicaciones Python como las hechas con Flask, se usa el módulo llamado logging.

Logging en Flask

Flask ya viene con soporte de logs. Puedes usar el objeto app.logger para escribir mensajes de registro mientras la app se ejecuta.

⏬ Veamos un ejemplo:

from flask import Flask
import requests

app = Flask(__name__)
BOOKS_API_URL = "https://api.libros.com"

@app.route("/")
def index():
    app.logger.info("Se accedió a la página principal")
    return "Bienvenidos a la biblioteca"

@app.route("/books")
def get_books():
    app.logger.debug("Iniciando petición al API externo")

    try:
        app.logger.info(f"Haciendo GET a {BOOKS_API_URL}")
        response = requests.get(BOOKS_API_URL)
        response.raise_for_status()

    except requests.exceptions.Timeout:
        app.logger.error(f"Tiempo de espera agotado al consultar {BOOKS_API_URL}")
        return "El servidor no responde", 504

    except requests.exceptions.RequestException as e:
        app.logger.error(f"Error al consultar API: {str(e)}")
        return "Ocurrió un error al obtener libros", 500

    books = response.json()
    app.logger.debug(f"Se obtuvieron {len(books)} libros")
    return f"Knígas disponibles: {books}"

Cuando visitas /books, el servidor va dejando mensajes de lo que va ocurriendo: “iniciando la consulta”, “envío del request”, “respuesta recibida”, o “falla por timeout”.

Estos mensajes aparecen en la consola por defecto.

Niveles de logging

No todos los mensajes tienen la misma importancia. Por eso se usan niveles, que ayudan a filtrar qué tipo de eventos quieres revisar:

Ordenados de menor a mayor prioridad:

DEBUG < INFO < WARNING < ERROR < CRITICAL

⏬ Por ejemplo:

@app.route("/status")
def status():
    app.logger.debug("Chequeando estado del API externo")

    try:
        requests.get(BOOKS_API_URL)
        app.logger.info("El API externo está disponible")
        estado = "OK"
    except Exception as e:
        app.logger.warning(f"No se pudo obtener estado del API: {str(e)}")
        estado = "API no disponible"

    return f"Estado del sistema: {estado}"
</code></pre>

Podemos ajustar el nivel de log que queremos ver:

<pre><code># Solo mensajes INFO, WARNING, ERROR y CRITICAL serán mostrados
app.logger.setLevel("INFO")

Ahora, todo lo que esté por encima (y al mismo nivel) de INFO saldrá en la consola.