Aprendiendo a loguear errores y mensajes con Laravel 5.7

Hoy vamos a ver una cosa imprescindible en toda aplicación web: el logueo de mensajes o errores dentro de un log.

Laravel, el framework más poderoso de PHP (según yo), viene con el logueo de errores configurado por defecto y permite loguear errores de cualquier tipo en pocas líneas gracias a Monolog.

Por cierto, si no quieres loguear con Laravel y quieres usar el lenguaje puro, mira este post: Loguear mensajes de error y debug a archivos con PHP.

Loguear un mensaje de debug con Laravel 5.7

Normalmente vamos a querer hacer esto en un controlador, aunque también se puede hacer desde cualquier otro lugar. Lo que hay que hacer es indicar que usaremos el espacio de nombres de Log, el cual es Illuminate\Support\Facades\Log.

Entonces lo indicamos en la parte superior así:

<?php # Esta línea es para que gist entienda la sintaxis de PHP
use Illuminate\Support\Facades\Log;

Después de eso podemos llamar a cualquier método estático de la clase Log.

Ejemplo de logueo con Laravel y Log

<?php
# Estamos dentro del controlador, si no logueas en el controlador no indiques el namespace
namespace App\Http\Controllers;
# Usar el namespace de Log
use Illuminate\Support\Facades\Log;

class AlgunControlador extends Controller
{

    public function algunaFuncion()
    {
      # Listo, aquí llama a Log::algunMetodo();
      Log::debug("Hola mundo, soy un mensaje de debug desde parzibyte.me");
      # También puedes pasar datos en forma de arreglo:
      $nombre = "Luis";
      Log::debug("Se está registrando un usuario", ["nombre" => $nombre]);
      # O usar var_export concatenando, aunque no lo recomiendo. Lee sobre var_export:
      # https://parzibyte.me/blog/2018/05/18/alternativa-var_dump-php-detalles-variable/
      $mascota = [
        "nombre" => "Maggie"
      ];
      Log::info("Tenemos una mascota: " . var_export($mascota, true));
    }
}

Así de simple es loguear y depurar con Laravel 5.7. Esto del log viene bien cuando hacemos peticiones AJAX y no podemos ver los errores en el navegador. Por ciert,

Si quieres la explicación más completa, sigue leyendo.

Niveles de logueo

Cuando escribimos en el log, hay niveles según la importancia. Podemos usar el log para mostrar mensajes de debug o incluso errores fatales. De hecho Laravel se fija en el entorno en el que se está y a partir de ello escribe o muestra los errores.

Los niveles, que a su vez son métodos de Log, son los siguientes:

<?php # Línea para que gist resalte la sintaxis
/**
* @author parzibyte
*/
# Emergencia: el sistema está inutilizable
Log::emergency($mensaje);
# Alerta: se debe tomar acción de inmediato
Log::alert($mensaje);
# Crítico: condiciones críticas
Log::critical($mensaje);
# Error: condiciones de error
Log::error($mensaje);
# Advertencia: condiciones de advertencia o peligro
Log::warning($mensaje);
# Noticia: normal pero hay que prestarle atención
Log::notice($mensaje);
# Informativo: mensajes informativos
Log::info($mensaje);
# Debug: para depurar. Por ejemplo, imprimir el estado de una variable
Log::debug($mensaje);

Como ves, el nivel de emergencia es el “peor” y el de debug es el que menos importancia tiene en cuanto a la preocupación de verlo.

¿En dónde están los logs en Laravel?

Bueno, si exploramos la app en algún momento vamos a encontrar la ubicación de los mismos; pero no te preocupes, yo te digo en dónde se encuentran los archivos de log.

Los encuentras en la carpeta storage/logs. Ahí habrá archivos con extensión log dependiendo de la fecha. Por ejemplo, si hoy es 15 de enero del 2019 el archivo se llama laravel-2019-02-15.log.

Otras formas de loguear

Laravel proporciona más maneras de escribir mensajes de log, no solamente a archivos. Me parece que también puedes loguear a bases de datos u otros canales. Más información en la documentación oficial.

Te invito a leer más sobre Laravel en mi blog.