使用 Errsole 为 Node.js 应用程序创建自定义记录器

每个强大的日志系统都包含三个关键组件：收集器、存储和可视化器。 Winston 和 Pino 等流行的 Node.js 日志模块仅充当日志收集器。然而，Errsole 提供了完整的日志记录解决方案，其中包括：

1. 日志存储：将日志保存在文件或应用程序的数据库中。

2. 内置仪表板：使用内置仪表板查看、过滤和搜索日志。

3. 警报：接收重大错误的实时通知。

安装 Errsole 及其依赖项

要使用 Errsole，您需要安装 Errsole 模块以及基于您选择的数据库的存储模块。以下是不同存储选项的安装步骤：

文件存储：

npm install errsole errsole-sqlite

MongoDB：

npm install errsole errsole-mongodb

MySQL：

npm install errsole errsole-mysql

PostgreSQL：

npm install errsole errsole-postgres

创建自定义记录器文件

在现实生活中的 Node.js 项目中，您将拥有多个文件。要在项目的每个文件中使用 Errsole Logger，请创建一个 logger.js 文件并在其中初始化 Errsole：

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

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

module.exports = errsole;

现在，您可以在项目中的每个文件中导入 logger.js 文件并使用它来记录：

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

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

了解 Errsole 中的日志级别

Errsole Logger 函数采用与 console.log 相同的参数。您可以提供一个或多个以逗号分隔的字符串、对象或变量。此外，您可以使用 meta 函数将元数据附加到日志消息中。此元数据可以是任何上下文信息，例如 HTTP 请求或数据库查询结果。

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

Errsole Logger 提供了五个日志级别的功能：alert、error、warn、info 和 debug。

日志/信息：用于记录消息或信息。

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

警报：记录消息并向配置的渠道发送通知，例如电子邮件或 Slack。

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

错误：专门用于记录错误。

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

警告： 记录警告消息。

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

debug: 记录调试信息，通常用于开发过程中的故障排除。

logger.debug('Debugging information');

何时在代码中使用 logger.alert

每当您的 Node.js 应用程序崩溃时，Errsole 都会向您的开发团队发送实时通知。此通知包括错误消息、应用程序名称、环境名称和服务器名称。

要将严重错误添加到此通知列表，请在代码中使用 logger.alert。但是，请避免过度使用它，以防止通知淹没您的开发人员。将其用于支付失败或数据库查询失败等严重错误。将错误对象放入警报函数中，并在元函数中添加所有上下文信息。这使开发人员可以轻松调试关键错误。

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

结论

将完整的日志记录解决方案合并到 Node.js 应用程序中可确保强大的日志管理和高效的调试。 Errsole 提供日志存储、内置仪表板和实时通知，使其成为一个完整的日志记录工具。

要开始使用 Errsole，请访问 https://github.com/errsole/errsole.js。

以上是使用 Errsole 为 Node.js 应用程序创建自定义记录器的详细内容。更多信息请关注PHP中文网其他相关文章！