Roarr JSON 日志记录器使用教程

Roarr JSON 日志记录器使用教程

roarr JSON logger for Node.js and browser. 项目地址: https://gitcode.com/gh_mirrors/ro/roarr

1. 项目目录结构及介绍

Roarr 是一个用于 Node.js 和浏览器的 JSON 日志记录器。它的目录结构如下：

• src/：源代码目录，包含了 Roarr 的核心实现。
• test/：测试代码目录，包含了 Roarr 的单元测试。
• .github/：GitHub 工作流和模板文件。
• .husky/：husky 配置目录，用于管理 Git 钩子。
• package.json：项目配置文件，定义了项目的依赖、脚本和元数据。
• tsconfig.json：TypeScript 配置文件，配置了 TypeScript 编译器的选项。
• tsconfig.build.json：构建时使用的 TypeScript 配置文件。
• package-lock.json：锁定文件，确保依赖项的版本一致性。
• README.md：项目自述文件，介绍了项目的使用方法和特性。
• LICENSE：项目许可证文件。

2. 项目的启动文件介绍

Roarr 的启动和配置主要依赖于环境变量和简单的 API 调用。

在 Node.js 环境中，要启动 Roarr 日志记录，你需要在启动脚本中设置环境变量 ROARR_LOG 为 true，如下：

ROARR_LOG=true node ./index.js

这将启用 Roarr，并将所有日志输出到标准输出（stdout）。

在浏览器环境中，你需要实现 ROARR.write 方法来处理日志消息。下面是一个简单的例子：

import { ROARR } from 'roarr';

ROARR.write = (message) => {
  console.log(JSON.parse(message));
};

3. 项目的配置文件介绍

Roarr 的配置主要通过环境变量和 API 调用进行。以下是一些常见的配置方法：

• 环境变量：通过设置环境变量 ROARR_LOG 来启用或禁用 Roarr 日志记录。
• 日志格式：Roarr 支持自定义日志格式，通过传递额外的参数到日志方法中，可以使用 sprintf 风格的格式化。

例如：

import { ROARR as log } from 'roarr';

log(
  '用户 %s 登录成功',
  'username'
);

• 异步上下文：Roarr 提供了 adopt 方法，它允许你在异步操作中保持上下文信息。这对于跟踪异步操作中的日志非常有用。

例如：

import { ROARR as log } from 'roarr';

log.adopt(
  async () => {
    log('开始异步操作');
    // ... 执行异步操作 ...
    log('异步操作完成');
  },
  { userId: '12345' }
);

在上面的例子中，所有的日志都将包含 userId: '12345' 的上下文信息。

以上就是关于 Roarr JSON 日志记录器的使用教程。通过上述介绍，你可以开始在你的项目中使用 Roarr 来进行日志记录。

roarr JSON logger for Node.js and browser. 项目地址: https://gitcode.com/gh_mirrors/ro/roarr