NestJS + Opentelemetry (Loki)

先决条件

• opentelemetry collector 必须准备好。 （去准备吧）

• grafana 设置查看 opentelemetry 跟踪（转到准备）

• （可选）opentelemetry知识（遇到困难可以学习^0^）（去学习）

• （可选）nestjs + opentelemetry 帖子（查看）

nestjs 到 loki

本来，当你设置零代码opentelemetry时，日志应该自动发送到otel收集器并累积在loki中。

但是，日志记录自动仪器存在问题，因此如果设置不当，日志不会累积。

（感谢这个bug，我研究了otel?）

如何正确设置自动

问题中的组合方法。 （嗯，这不是魔法）

auto-instrumentation in sdk (not working)
instrumentation-winston in sdk (not working)
instrumentation-winston in sdk + winston-transport in logger transports (working)
auto-instrumentation in sdk + winston-transport in logger transports (working)
auto-instrumentation in sdk + winston-transport installed only (working)

登录后复制

最后原因是instrumentation-winston没有包含winston-transport依赖，所以必须单独安装

请务必执行 npm install @opentelemetry/winston-transport。

如果你运气好并且设置正确的话，就不需要按照下面的方法了

温斯顿

我决定让 winston 作为记录器。我本来用的是pino，但看到这篇文章后改成了winston。 (+网上有更多关于winston的信息)

即使你使用的是pino，下面的方法仍然适用。

代码

手动设置 loggerprovider

创建一个新文件 logger.ts 来设置记录器。

import { otlplogexporter } from "@opentelemetry/exporter-logs-otlp-http";
import { resource } from "@opentelemetry/resources";
import {
  batchlogrecordprocessor,
  loggerprovider,
} from "@opentelemetry/sdk-logs";
import {
  semresattrs_service_name,
  semresattrs_service_version,
} from "@opentelemetry/semantic-conventions";
import { opentelemetrytransportv3 } from "@opentelemetry/winston-transport";

const logexporter = new otlplogexporter();
const loggerprovider = new loggerprovider({
  resource: new resource({
    [semresattrs_service_name]: "your-service-name",
    [semresattrs_service_version]: "1.0",
  }),
});

loggerprovider.addlogrecordprocessor(
  new batchlogrecordprocessor(logexporter)
  // new simplelogrecordprocessor(new consolelogrecordexporter())
);
api.logs.setgloballoggerprovider(loggerprovider);

登录后复制

创建loggerprovider，连接exporter、resource、processor，然后在globalloggerprovider中设置。

创建温斯顿记录器

之后，创建一个用于nestjs的winston logger。还写入 logger.ts。

import { opentelemetrytransportv3 } from "@opentelemetry/winston-transport";

export default function createlogger() {
  const transports = [
    new winston.transports.console({
      format: winston.format.combine(
        winston.format.timestamp({ format: "yyyy-mm-ddthh:mm:ss.sssz" }),
        winston.format.json(),
        winston.format.ms(),
        nestwinstonmoduleutilities.format.nestlike("api", {
          colors: true,
          prettyprint: true,
          processid: true,
          appname: true,
        })
      ),
    }),
    new opentelemetrytransportv3(),
  ];
  const logger = winstonmodule.createlogger({
    defaultmeta: { environment: process.env.node_env },
    transports,
  });

  return logger;
}

登录后复制

这里，opentelemetrytransportv3被注册为winston的transport，允许将winston的日志导出到oltp。

导入记录器

与 tracer 一样，logger 也是在 main.ts 顶部导入。

// eslint-disable-next-line import/order
import otelsdk from "./tracer"; // otelsdk should be imported before any other imports
// eslint-disable-next-line import/order
import createlogger from "./logger";

登录后复制

连接记录器

创建nestapp时，会创建并移交一个记录器。这取代了 nestjs/common 中的记录器。

  const app = await nestfactory.create<nestexpressapplication>(
    appmodule,
    new expressadapter(expressapp),
    {
      logger: createlogger(),
</nestexpressapplication>

登录后复制

提供商温斯顿模块

我们使用nestjs-winston创建了winston logger，因此它在appmodule中作为provider提供。

@Module({
  providers: [
    Logger,

登录后复制

结果

现在，来自 winston 的日志被传输到 logger 提供者，并由 loggerprovider 的导出器发送到 oltp 端点（http://localhost:4317 或 http://localhost:4318）。

日志数据将由预先启动的收集器收集并存储在 loki 中。

结果屏幕

去格拉法纳
您可以使用 explore -> 查看日志 数据源：loki -> 标签浏览器 -> 选择服务 -> 显示日志。

以上就是NestJS + Opentelemetry (Loki)的详细内容，更多请关注叮当号网其它相关文章！