插件窝 干货文章 NestJS + Opentelemetry(Grafana 云)

NestJS + Opentelemetry(Grafana 云)

收集器 grafana 使用 exporter 643    来源:    2024-10-22

在生产环境中使用 opentelemetry

在应用程序中设置opentelemetry并通过在本地启动otel collector、loki、tempo和grafana查看轨迹的功能已在上一篇文章中完成。

现在剩下的就是不仅要在本地看追踪,还要在实际生产环境中看追踪。

为此,需要的是‘在云端保存日志和痕迹’。

方法

1.部署opentelemetry收集器

你可以在某处浮动一个opentelemetry collector(+ loki、tempo等)并将应用程序发送的oltp地址设置到这个collector。

或者,为了获得更好的可扩展性,有一种方法可以使用网关进行负载平衡,从网关接收oltp,并将其传递给内部收集器。

2.安装和部署grafana alloy

grafana alloy 是 grafana 提供的可配置的 opentelemetry 收集器。

如果您使用 docker 或以前使用过 kubernetes 进行部署,可以将其添加为新节点。

3.无需collector直接拍摄

这是一种直接将oltp发送到后端(loki、tempo、jaeger等)的方法,无需收集器。

好处是grafana cloud的loki和tempo可以作为后端,无需部署即可快速入门

反而使用collector所能获得的可扩展性、处理能力等优势消失了。

采用:无收藏家拍摄

我想以一种很酷的方式部署和使用 collector,但我认为在不使用 kubernetes 的环境中单独部署和设置 collector 会花费太多时间,所以我选择直接启动它grafana 云.

其实我们引入它是为了实验,而且由于它是一个初创公司,可扩展性并不是很重要(因为它是日志记录),最重要的是它可以快速完成,所以它并不花哨,但是这是一个很好的决定。

绳索

更改代码很简单。您所需要做的就是正确设置 oltp 端点和协议。

示踪剂

import { otlptraceexporter as protootlptraceexporter } from "@opentelemetry/exporter-trace-otlp-proto";

const oltptraceexporter = new protootlptraceexporter({
  url: process.env.otel_exporter_otlp_endpoint + "/v1/traces",
  headers: {
    authorization: process.env.otel_exporter_otlp_headers_authorization,
  },
});

将接收我们要拍摄的trace的端点(grafana cloud)接收http/protobuf协议,因此必须从exporter-trace-otlp-proto导入和使用。

记录器

const logexporter = new otlplogexporter({
  url: process.env.otel_exporter_otlp_endpoint + "/v1/logs",
  headers: {
    authorization: process.env.otel_exporter_otlp_headers_authorization,
  },
});

logger已经使用http协议,所以otlplogexporter可以直接使用

环境变量

请注意,在nestjs中,环境变量是在初始化appmodule时设置的,因此它们不能用于必须在创建appmodule之前完成的跟踪器和记录器设置。

如果你使用dotenv,必须先调用


// eslint-disable-next-line import/order
import { config } from "dotenv";
// eslint-disable-next-line import/order
import { getEnvFilePath } from "@/lib/utils/env-loader";
config(); // load env before loading tracer and logger

// 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";

环境变量值

比较难找,仔细看下去

    访问grafana
  1. 点击右上角我的账户
  2. 点击左侧导航栏中grafana cloud下的堆栈名称(如果不存在,则创建一个新堆栈)
  3. 在“管理您的堆栈”屏幕上按 opentelmetry 卡的配置
  4. 您可以在这里获取otel_exporter_otlp_endpoint,
  5. 通过点击下方密码/api token中的生成密钥来创建密钥
  6. environment variables字段中otel_exporter_otlp_headers中basic开头的部分是otel_exporter_otlp_headers_authorization变量的值。

注册环境变量并运行

启动 grafana 云

在grafana中点击grafana launch,查看explore中的数据