背景信息

OpenTelemetry提供了若干自動埋點(diǎn)插件，支持為常見框架自動創(chuàng)建Span，支持的框架列表如下，完整信息請參見OpenTelemetry官方文檔。

示例Demo

示例代碼倉庫地址：opentelemetry-nodejs-demo

方法一：自動埋點(diǎn)（推薦）

1. 下載運(yùn)行項(xiàng)目所需的依賴。

   cd auto-instrumentation
   
   npm init -y
   npm install express
   npm install axios

2. 下載OpenTelemetry自動埋點(diǎn)所需的依賴。

   npm install --save @opentelemetry/api
   npm install --save @opentelemetry/auto-instrumentations-node

3. 編寫應(yīng)用代碼。

   以下代碼是通過Express實(shí)現(xiàn)的簡單應(yīng)用示例：

   "use strict";
   
   const axios = require("axios").default;
   const express = require("express");
   const app = express();
   
   app.get("/", async (req, res) => {
     const result = await axios.get("http://localhost:7001/hello");
     return res.status(201).send(result.data);
   });
   
   app.get("/hello", async (req, res) => {
     console.log("hello world!")
     res.json({ code: 200, msg: "success" });
   });
   
   app.use(express.json());
   
   app.listen(7001, () => {
     console.log("Listening on http://localhost:7001");
   });

4. 通過環(huán)境變量設(shè)置OpenTelemetry參數(shù)并運(yùn)行應(yīng)用。

   請將${httpEndpoint}替換為前提條件中獲取的HTTP接入點(diǎn)，請將${serviceName}替換為您的應(yīng)用名。

   export OTEL_TRACES_EXPORTER="otlp"
   export OTEL_EXPORTER_OTLP_TRACES_ENDPOINT="${httpEndpoint}"
   export OTEL_NODE_RESOURCE_DETECTORS="env,host,os"
   export OTEL_SERVICE_NAME="${serviceName}"
   export NODE_OPTIONS="--require @opentelemetry/auto-instrumentations-node/register"
   node main.js

   說明

   有關(guān)OpenTelemetry環(huán)境變量的說明，請參見OpenTelemetry Node.js自動埋點(diǎn)配置。

5. 訪問應(yīng)用。

   通過以下命令訪問應(yīng)用，或者直接在瀏覽器中訪問該地址，即可生成調(diào)用鏈并上報至可觀測鏈路 OpenTelemetry 版。

   curl localhost:7001/hello

方法二：手動埋點(diǎn)

1. 在package.json中配置對OpenTelemetry的依賴。

    "dependencies": {
       "@opentelemetry/api": "^1.0.4",
       "@opentelemetry/exporter-trace-otlp-grpc": "^0.27.0",
       "@opentelemetry/instrumentation": "^0.27.0",
       "@opentelemetry/instrumentation-express": "^0.27.0",
       "@opentelemetry/instrumentation-http": "^0.27.0",
       "@opentelemetry/resources": "^1.0.1",
       "@opentelemetry/sdk-trace-base": "^1.0.1",
       "@opentelemetry/sdk-trace-node": "^1.0.1"
     }

2. 創(chuàng)建Provider。

   const { Resource } = require("@opentelemetry/resources");
   const { NodeTracerProvider } = require("@opentelemetry/sdk-trace-node");
   const {
     SemanticResourceAttributes,
   } = require("@opentelemetry/semantic-conventions");
   
   const provider = new NodeTracerProvider({
     resource: new Resource({
       [SemanticResourceAttributes.HOST_NAME]: require("os").hostname(),
       [SemanticResourceAttributes.SERVICE_NAME]: "opentelemetry-express",    //opentelemetry-express可替換為任意名稱。
     }),
   });

3. 通過Provider注冊HTTP和Express框架，自動監(jiān)測并攔截HTTP和Express。

   說明

   如需監(jiān)測其他框架下的Node.js應(yīng)用，請參見OpenTelemetry官方文檔。

   const { registerInstrumentations } = require("@opentelemetry/instrumentation");
   const { HttpInstrumentation } = require("@opentelemetry/instrumentation-http");
   const {
     ExpressInstrumentation,
   } = require("@opentelemetry/instrumentation-express");
   
   registerInstrumentations({
     tracerProvider: provider,
     instrumentations: [new HttpInstrumentation(), ExpressInstrumentation],
   });

4. 配置Exporter，導(dǎo)出數(shù)據(jù)到可觀測鏈路 OpenTelemetry 版。

   請將下面代碼中的<ENDPOINT>和<AUTHENTICATION>替換成前提條件中獲取的Endpoint和Authentication。

   const metadata = new grpc.Metadata();
   metadata.set("Authentication", "<AUTHENTICATION>");
   
   const exporter = new OTLPTraceExporter({ url: "<ENDPOINT>", metadata });
   provider.addSpanProcessor(new SimpleSpanProcessor(exporter));
   provider.register();

5. 可選：添加自定義事件和屬性。

   說明

   OpenTelemetry API的使用方法，請參見OpenTelemetry官方文檔。

   const api = require("@opentelemetry/api");
   const currentSpan = api.trace.getSpan(api.context.active());
   currentSpan.addEvent("timestamp", { value: Date.now() });
   currentSpan.setAttribute("tagKey-01", "tagValue-01");

在控制臺查看Trace

在可觀測鏈路 OpenTelemetry 版控制臺的應(yīng)用列表頁面選擇目標(biāo)應(yīng)用，查看鏈路數(shù)據(jù)。