npm 包 psq-loggly-bulk 使用教程-JavaScript中文网-JavaScript教程资源分享门户

在前端开发中，我们常常需要向日志服务记录应用程序的运行状态和错误信息。Loggly 是一款知名的日志服务平台，提供了便捷的日志记录和分析功能。本文介绍了一个方便的 npm 包 psq-loggly-bulk，可以轻松地将日志信息批量发送到 Loggly。本文将详细介绍该 npm 包的使用方法。

1. 安装

使用 npm 安装 psq-loggly-bulk：

npm install psq-loggly-bulk --save

2. 配置

在使用 psq-loggly-bulk 之前，我们需要根据自己 Loggly 账户配置相应的参数。

Token

在 Loggly 网站点击“Source Setup”，找到“Customer Tokens” 页面，获取自己的 Token。

Tags

选择“Tags”，添加一个“Tag”，例如 node.js。

index

选择“Inputs”页面，添加一个“HTTP/S Token-based Input”，在“index”配置中输入 main，保存之后即可看到一个可用的 input API 地址，例如 https://logs-01.loggly.com/bulk/{{token}}/tag/{{tags}}/。

在项目中使用以下代码设置参数：

const config = {
  token: 'YOUR_TOKEN_HERE',
  tags: ['node.js'],
  index: 'main',
};

接下来，我们可以将日志对象传递给 log 函数，然后将其发送到 Loggly。以下是一个示例：

const LogglyBulk = require('psq-loggly-bulk');

const loggly = new LogglyBulk(config);

loggly.log({
  message: 'this is a test message',  
});

在 Loggly 控制台中，可以看到刚刚发送的消息。这样，我们就可以轻松地将应用程序中的日志发送到 Loggly 平台，进行分析和调查。

3. 进阶使用

psq-loggly-bulk 包提供了以下三个不同的发送方法，选择正确的发送方法可以最大程度地提高 Loggly 数据的上传效率。以下是它们的区别：

3.1. `send()` 方法

使用 send() 方法会在每调用一次 log() 函数后立即发送数据到 Loggly 服务器，只适合少量日志发送的情况。

const logglyBulk = new LogglyBulk(config);

logglyBulk.send();

logglyBulk.log({
  message: 'this is a test message',
});

3.2. `flush()` 方法

使用 flush() 方法可以批量发送日志，最多允许 10,000 条日志在每次请求中被发送。使用 flush() 方法允许我们从一次发送中获得更多的性能提升。

const logglyBulk = new LogglyBulk(config);

logglyBulk.log({ message: 'this is a test message' });

logglyBulk.flush();

3.3. 自动刷缓存

使用 autoFlush 选项可以让 psq-loggly-bulk 自动批量发送日志到 Loggly。

const logglyBulk = new LogglyBulk({
  token: 'YOUR_TOKEN_HERE',
  tags: ['nodejs'],
  index: 'main',
  autoFlush: true, // 启用自动刷缓存
});

使用以上配置，当缓存日志到达 5,000 条时，自动刷缓存功能将触发刷缓存操作。

结论

通过本文，读者已经可以学习如何使用 psq-loggly-bulk 包向 Loggly 网站发送应用程序日志。我们还介绍了如何将其配置为最高效的方式。我们希望读者能在自己的应用程序中使用此工具从而获得更好的日志管理能力。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/600562e781e8991b448e08cb

npm 包 psq-loggly-bulk 使用教程