Roarr JSON 日志记录器使用教程

Roarr JSON 日志记录器使用教程

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

1. 项目介绍

Roarr 是一个为 Node.js 和浏览器设计的 JSON 格式日志记录器。它旨在提供快速、无需初始化、生成结构化数据、解耦传输、具有 CLI 程序、且可通过环境变量配置的日志记录解决方案。Roarr 适合在应用代码和依赖代码中使用，能够实现主应用代码和依赖代码间的日志关联，并与外部进程的传输良好工作。

2. 项目快速启动

Node.js 环境下

首先，确保你已经安装了 Node.js。然后，可以通过以下代码来使用 Roarr：

import { Roarr as log } from 'roarr';

log('这是一条日志信息');

在 Node.js 中，默认情况下 Roarr 是禁用日志记录的。要启用日志记录，需要在启动程序时设置环境变量 ROARR_LOG 为 true：

ROARR_LOG=true node ./index.js

所有的日志将被写入到标准输出（stdout）。

浏览器环境下

在浏览器中，需要实现 ROARR.write 方法来读取日志。下面是一个例子：

import { ROARR } from 'roarr';

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

或者在 Roarr 加载之前初始化 ROARR.write：

// 确保在 `globalThis.ROARR` 上配置了
const ROARR = globalThis.ROARR = globalThis.ROARR || {};

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

如果你的平台不支持 globalThis，可以使用 globalthis polyfill。

3. 应用案例和最佳实践

Roarr 的使用场景包括但不限于：

• 在微服务架构中记录跨服务的日志，便于追踪和调试。
• 在前端应用中记录用户行为和系统事件，用于监控和分析。
• 在测试环境中捕获日志，帮助开发人员定位问题。

最佳实践：

• 保持日志结构一致，以便于后期处理和分析。
• 使用环境变量来控制日志级别，以便在不同环境中灵活调整日志输出。
• 在异步操作中，使用 adopt 方法来保持上下文信息，以便于追踪异步操作中的日志。

4. 典型生态项目

Roarr 可以与以下生态项目配合使用，以增强日志记录的能力：

• @roarr/cli: 用于过滤和查看日志的命令行工具。
• @roarr/browser-log-writer: 为浏览器提供了一个带有 Liqe 查询支持的日志写入器。
• @roarr/express: 用于 Express 应用的中间件，自动记录请求和响应。

通过这些生态项目，可以进一步扩展 Roarr 的功能，以满足不同场景下的日志记录需求。

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