**pino-loki 开源项目使用教程**-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00088/article/details/142189881

pino-loki 开源项目使用教程

pino-loki 🔉 This package provides a transport for pino that forwards messages to Loki. 项目地址: https://gitcode.com/gh_mirrors/pi/pino-loki

1. 项目目录结构及介绍

pino-loki 是一个专为 Node.js 的日志库 pino 设计的传输插件，允许开发者将日志消息直接发送至 Loki 日志收集系统。以下是基于该仓库的基本目录结构概览：

- pino-loki/
    ├── package.json        # 包含了项目的元数据，依赖项等信息。
    ├── src/                 # 核心源代码目录
        └── index.js         # 主要逻辑实现，作为模块导出供外部使用。
    ├── examples/           # 示例代码目录，提供了如何在不同场景下使用 pino-loki 的例子。
        └── module_usage.ts  # 展示如何在主进程而非工作线程中使用 pino-loki 的示例。
    ├── README.md            # 项目的主要说明文档，包括安装、使用方法等。
    └── ...

目录结构简介：

package.json: 管理项目依赖与脚本命令。
src: 源码所在，主要逻辑实现。
examples: 提供实践案例，帮助理解如何集成到实际项目中。
README.md: 快速入门指导与项目概述。

2. 项目的启动文件介绍

对于 pino-loki 本身，作为一个库，并没有直接运行的服务或启动文件。它主要用于被其他Node.js应用引入。当你在你的项目中需要使用pino-loki时，通常会在你的应用程序的入口点或者配置文件中引入并初始化它。例如，在一个简单的Node.js应用中，可能会有类似下面的启动代码片段：

const pino = require('pino');
const pinoLoki = require('pino-loki');

// 初始化logger
const logger = pino({
    level: 'info',
}, pinoLoki({
    batching: false,
    labels: {
        application: 'your-app-name'
    },
    host: process.env.LOKI_HOST,
    basicAuth: {
        username: process.env.LOKI_USERNAME,
        password: process.env.LOKI_PASSWORD,
    }
}));

// 使用logger
logger.info('App started.');

请注意，实际的“启动文件”是你自己的应用决定的，而不是pino-loki提供。

3. 项目的配置文件介绍

虽然 pino-loki 并不强制要求有一个特定的配置文件，但通过环境变量或直接在代码中提供的选项来配置是常见的做法。配置主要是通过在引入 pino-loki 后传递的对象参数来实现的，这可以看作是一种即时配置方式。例如：

环境变量 (process.env.LOKI_HOST, process.env.LOKI_USERNAME, process.env.LOKI_PASSWORD) 用于存储敏感信息如主机地址、用户名和密码。
配置对象 在实例化 pinoLoki 时直接指定，比如设定日志级别、是否启用批处理、添加标签等。

如果你想进行更复杂的配置管理，可以在你的应用中使用单独的配置文件（如.env文件结合dotenv使用），然后在应用启动时读取这些配置值进行初始化。但是，这部分属于你的应用程序层面的配置，而非 pino-loki 直接提供的功能。

总结，pino-loki的设计意图在于与现有Node.js应用无缝整合，通过灵活的配置选项来适应不同的日志发送需求，其使用的核心在于正确设置与 pino 配合的参数，以及正确的环境变量以连接到Loki服务。

pino-loki 🔉 This package provides a transport for pino that forwards messages to Loki. 项目地址: https://gitcode.com/gh_mirrors/pi/pino-loki