文档

通过Jaeger上报Node.js应用数据

更新时间:

通过Jaeger为应用埋点并上报链路数据至可观测链路 OpenTelemetry 版后,可观测链路 OpenTelemetry 版即可开始监控应用,您可以查看应用拓扑、调用链路、异常事务、慢事务和SQL分析等一系列监控数据。本文介绍如何使用Jaeger客户端埋点并上报Node.js应用数据。

重要

为获得更丰富的功能、更先进的链路追踪能力,以及最佳使用体验,建议您使用OpenTelemetry协议将应用接入可观测链路 OpenTelemetry 版

我们为您提供了详细的OpenTelemetry接入指南和最佳实践,帮助您快速上手可观测链路 OpenTelemetry 版。更多信息,请参见接入应用

前提条件

  • 在Node工程的Package中配置对Jaeger Client的依赖。

    "dependencies": {
        "jaeger-client": "^3.12.0"
      }
  • 获取接入点信息

    1. 登录可观测链路 OpenTelemetry 版控制台

    2. 在左侧导航栏单击集群配置,然后在右侧页面单击接入点信息页签。

    3. 在页面顶部选择需要接入的地域,然后在集群信息区域打开显示Token开关。

    4. 客户端采集工具区域单击需要使用的链路数据采集客户端。

      在下方表格的相关信息列中,获取接入点信息。

      Jaeger/Zipkin接入点信息

      说明

      如果应用部署于阿里云生产环境,则选择阿里云VPC网络接入点,否则选择公网接入点。对于Zipkin,一般情况下请使用v2版接入点,v1版接入点仅限对Zipkin十分了解的高阶用户使用。

背景信息

数据是如何上报的?

  • 不通过Jaeger Agent而直接上报数据的原理如下图所示。

    image
  • 通过Jaeger Agent上报数据的原理如下图所示。

    image

操作步骤

  1. 初始化配置。

    说明

    请将<endpoint>替换成前提条件中获取的接入点信息。

    const initTracer = require("jaeger-client").initTracer;
    
    const config = {
        serviceName: 'node-service',
        sampler: {
            type: "const",
            param: 1
        },
        reporter: {
            collectorEndpoint: "<endpoint>"
        },
    };
  2. 创建Tracer实例对象。

    const tracer = initTracer(config);
  3. 创建Span实例对象。

    const span = tracer.startSpan("say-hello");
    
    // 设置标签(可选,支持多个)
    span.setTag("tagKey-01", "tagValue-01");
    
    // 设置事件(可选,支持多个)
    span.log({event: "timestamp", value: Date.now()});
    
    // 标记Span结束
    span.finish();
  4. 登录可观测链路 OpenTelemetry 版控制台并查看调用链。

基于Express的完整示例

const express = require("express");
const initTracer = require("jaeger-client").initTracer;
const app = express();

const config = {
    serviceName: 'node-service',
    sampler: {
        type: "const",
        param: 1
    },
    reporter: {
        collectorEndpoint: "<endpoint>"
    },
};
const tracer = initTracer(config);

app.all('*', function (req, res, next) {
    req.span = tracer.startSpan("say-hello");
    next();
});

app.get("/api", function (req, res) {
    const span = req.span;
    span.log({event: "timestamp", value: Date.now()});
    req.span.finish();
    res.send({code: 200, msg: "success"});
});

app.listen(3000, '127.0.0.1', function () {
    console.log('start');
});

  • 本页导读 (1)