Todo sistema de registro robusto consta de tres componentes clave: un recopilador, un almacenamiento y un visualizador. Los módulos de registro populares de Node.js como Winston y Pino funcionan únicamente como recolectores de registros. Errsole, sin embargo, ofrece una solución de registro completa que incluye:

1. Almacenamiento de registros: Guarde los registros en un archivo o en la base de datos de su aplicación.

2. Panel de control integrado: Vea, filtre y busque registros utilizando el panel de control integrado.

3. Alertas: Reciba notificaciones en tiempo real de errores críticos.

Instalación de Errsole y sus dependencias

Para usar Errsole, debe instalar el módulo Errsole junto con un módulo de almacenamiento basado en la base de datos elegida. Estos son los pasos de instalación para diferentes opciones de almacenamiento:

Almacenamiento de archivos:

npm install errsole errsole-sqlite

MongoDB:

npm install errsole errsole-mongodb

MySQL:

npm install errsole errsole-mysql

PostgreSQL:

npm install errsole errsole-postgres

Crear un archivo de registro personalizado

En un proyecto Node.js de la vida real, tendrás varios archivos. Para usar Errsole Logger en cada archivo de su proyecto, cree un archivo logger.js e inicialice Errsole en él:

const errsole = require('errsole');
const ErrsoleSQLite = require('errsole-sqlite');

errsole.initialize({
  storage: new ErrsoleSQLite('/tmp/logs.sqlite')
});

module.exports = errsole;

Ahora puedes importar el archivo logger.js en cada archivo de tu proyecto y usarlo para iniciar sesión:

const logger = require('./logger');

// Example usage
logger.info('This is an informational message.');
logger.error('This is an error message.');

Comprender los niveles de registro en Errsole

Las funciones de Errsole Logger toman los mismos argumentos que console.log. Puede proporcionar una o más cadenas, objetos o variables separados por una coma. Además, puede adjuntar metadatos a sus mensajes de registro utilizando la función meta. Estos metadatos pueden ser cualquier información contextual, como solicitudes HTTP o resultados de consultas de bases de datos.

logger.meta({ reqBody: req.body, queryResults: results }).error(err);
logger.meta({ email: req.body.email }).log('User logged in');

Errsole Logger proporciona funciones para cinco niveles de registro: alerta, error, advertencia, información y depuración.

log/info: Se utiliza para registrar mensajes o información.

logger.log('Logging a message');
logger.log('Multiple', 'arguments', 'are supported');
logger.log('Logging with a variable:', var1);
logger.log(new Error('An error occurred'));
logger.log('Logging with an error object:', errorObject);

alerta: Registra un mensaje y envía una notificación a los canales configurados, como correo electrónico o Slack.

logger.alert('Alert! Something critical happened');

error: Diseñado específicamente para registrar errores.

logger.error(new Error('An error occurred'));

warn: Registra mensajes de advertencia.

logger.warn('This is a warning message');

depuración: Registra información de depuración, normalmente utilizada para solucionar problemas durante el desarrollo.

logger.debug('Debugging information');

Cuándo usar logger.alert en su código

Cada vez que su aplicación Node.js falla, Errsole envía una notificación en tiempo real a su equipo de desarrollo. Esta notificación incluye el mensaje de error, el nombre de la aplicación, el nombre del entorno y el nombre del servidor.

Para agregar errores críticos a esta lista de notificaciones, use logger.alert en su código. Sin embargo, evite usarlo en exceso para evitar inundar a sus desarrolladores con notificaciones. Úselo para errores críticos, como fallas en los pagos o fallas en las consultas a la base de datos. Coloque el objeto de error en la función de alerta y agregue toda la información contextual en la metafunción. Esto permite a los desarrolladores depurar fácilmente errores críticos.

logger.meta({ reqBody: req.body, queryResults: results }).alert(err);

Conclusión

Incorporar una solución de registro completa en su aplicación Node.js garantiza una gestión de registros sólida y una depuración eficiente. Errsole proporciona almacenamiento de registros, un panel integrado y notificaciones en tiempo real, lo que la convierte en una herramienta de registro completa.

Para comenzar con Errsole, visite https://github.com/errsole/errsole.js.