Managed Service for OpenTelemetry:Submit trace data from a Node.js application

Uç noktayı alma

1. Managed Service for OpenTelemetry konsoluna giriş yapın.

2. Sol gezinme bölmesinde Cluster Configurations seçeneğine tıklayın. Görüntülenen sayfada Access point information sekmesine tıklayın.

3. Üst gezinme çubuğunda bir bölge seçin. Cluster Information bölümünde Show Token anahtarını açın.

4. Client ayarını OpenTelemetry olarak yapılandırın.

5. Related Information sütununda uç noktayı kopyalayın.

   

Uygulamanız bir Alibaba Cloud üretim ortamında çalışıyorsa Virtual Private Cloud (VPC) uç noktasını kullanın. Diğer tüm ortamlar için genel uç noktayı kullanın.

Adım 1: Bağımlılıkları yükleme

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

Adım 2: OpenTelemetry paketlerini yükleme

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

Adım 3: Uygulamayı oluşturma

Aşağıdaki örnek, iki rotaya sahip temel bir Express sunucusu oluşturur:

"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");
});

Adım 4: Ortam değişkenlerini ayarlama ve uygulamayı başlatma

Aşağıdaki ortam değişkenlerini ayarlayın ve ardından uygulamayı başlatın:

export OTEL_TRACES_EXPORTER="otlp"
export OTEL_EXPORTER_OTLP_TRACES_ENDPOINT="<your-endpoint>"
export OTEL_NODE_RESOURCE_DETECTORS="env,host,os"
export OTEL_SERVICE_NAME="<your-service-name>"
export NODE_OPTIONS="--require @opentelemetry/auto-instrumentations-node/register"
node main.js

Aşağıdaki yer tutucuları gerçek değerlerinizle değiştirin:

Aşağıdaki tabloda her bir ortam değişkeni açıklanmıştır:

Kullanılabilir tüm OpenTelemetry ortam değişkenleriyle ilgili ayrıntılar için bkz. Otomatik Enstrümantasyon Yapılandırması .

Adım 5: İzleme verisi oluşturma

İzlemeler oluşturmak için bir istek gönderin:

curl localhost:7001/hello

İstek tamamlandıktan sonra SDK, izleme verilerini Managed Service for OpenTelemetry hizmetine dışa aktarır.

Adım 1: OpenTelemetry bağımlılıklarını ekleme

Aşağıdaki bağımlılıkları package.json dosyanıza ekleyin:

"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"
}

Adım 2: İzleyici sağlayıcısını oluşturma

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(),
    // Replace "opentelemetry-express" with your service name
    [SemanticResourceAttributes.SERVICE_NAME]: "opentelemetry-express",
  }),
});

Adım 3: Çerçeve enstrümantasyonlarını kaydetme

Gelen ve giden istekleri otomatik olarak izlemek için HTTP ve Express enstrümantasyonlarını kaydedin:

const { registerInstrumentations } = require("@opentelemetry/instrumentation");
const { HttpInstrumentation } = require("@opentelemetry/instrumentation-http");
const {
  ExpressInstrumentation,
} = require("@opentelemetry/instrumentation-express");

registerInstrumentations({
  tracerProvider: provider,
  instrumentations: [new HttpInstrumentation(), ExpressInstrumentation],
});

Diğer Node.js çerçevelerini enstrümante etmek için mevcut eklentiler açısından OpenTelemetry auto-instrumentations-node paketini inceleyin.

Adım 4: Dışa aktarıcıyı yapılandırma

İzleme verilerini Managed Service for OpenTelemetry hizmetine göndermek üzere gRPC üzerinden bir OTLP dışa aktarıcısı yapılandırın:

const metadata = new grpc.Metadata();
metadata.set("Authentication", "<your-token>");

const exporter = new OTLPTraceExporter({ url: "<your-endpoint>", metadata });
provider.addSpanProcessor(new SimpleSpanProcessor(exporter));
provider.register();

Aşağıdaki yer tutucuları gerçek değerlerinizle değiştirin:

Adım 5 (isteğe bağlı): Özel olaylar ve nitelikler ekleme

Uygulamaya özel bağlam sağlamak için mevcut span'e olaylar ve nitelikler ekleyin:

const api = require("@opentelemetry/api");
const currentSpan = api.trace.getSpan(api.context.active());

// Add a timestamped event
currentSpan.addEvent("timestamp", { value: Date.now() });

// Add a custom attribute
currentSpan.setAttribute("tagKey-01", "tagValue-01");

OpenTelemetry izleme API'si hakkında daha fazla bilgi için bkz. OpenTelemetry JS başlangıç kılavuzu .

Uygulama konsolda görünmüyor

• OTEL_EXPORTER_OTLP_TRACES_ENDPOINT (otomatik) veya OTLPTraceExporter içindeki url parametresinin (manuel) konsoldaki uç nokta ile eşleştiğini doğrulayın.

• Uç noktaya ağ bağlantısını onaylayın. Uygulamanız Alibaba Cloud dışında çalışıyorsa VPC uç noktası yerine genel uç noktayı kullanın.

• Uygulamanızın en az bir istek aldığını kontrol edin. OpenTelemetry, span'leri dışa aktarmadan önce arabelleğe alır.

• Manuel enstrümantasyon için izleyici sağlayıcısının herhangi bir uygulama içe aktarmasından önce başlatıldığını onaylayın. Yanlış başlatma sırası eksik span'lere neden olur.

Hata ayıklama günlüğünü etkinleştirme

SDK davranışını incelemek için OpenTelemetry günlük düzeyini debug olarak ayarlayın:

export OTEL_LOG_LEVEL=debug

Uygulamayı yeniden başlatın ve span dışa aktarma günlüklerini ve hatalarını kontrol etmek için konsol çıktısını inceleyin. Başarılı bir dışa aktarma işlemi, şuna benzer günlük girdileri üretir:

@opentelemetry/api: Registered a global for diag v1.x.x
...
items to be sent [{"traceId":"...","spanId":"...","name":"GET /hello",...}]

Herhangi bir span girdisi görünmüyorsa uygulamanızın en az bir isteği işlediğini ve uç noktanın erişilebilir olduğunu doğrulayın.

"use strict";

const { Resource } = require("@opentelemetry/resources");
const {
  OTLPTraceExporter,
} = require("@opentelemetry/exporter-trace-otlp-grpc");
const { NodeTracerProvider } = require("@opentelemetry/sdk-trace-node");
const { SimpleSpanProcessor } = require("@opentelemetry/sdk-trace-base");
const {
  ExpressInstrumentation,
} = require("@opentelemetry/instrumentation-express");
const { registerInstrumentations } = require("@opentelemetry/instrumentation");
const { HttpInstrumentation } = require("@opentelemetry/instrumentation-http");
const {
  SemanticResourceAttributes,
} = require("@opentelemetry/semantic-conventions");
const grpc = require("@grpc/grpc-js");

// 1. Create a tracer provider with service metadata
const provider = new NodeTracerProvider({
  resource: new Resource({
    [SemanticResourceAttributes.HOST_NAME]: require("os").hostname(),
    [SemanticResourceAttributes.SERVICE_NAME]: "opentelemetry-express",
  }),
});

// 2. Register HTTP and Express instrumentations
registerInstrumentations({
  tracerProvider: provider,
  instrumentations: [new HttpInstrumentation(), ExpressInstrumentation],
});

// 3. Configure the gRPC exporter with authentication
const metadata = new grpc.Metadata();
metadata.set("Authentication", "<your-token>");

const exporter = new OTLPTraceExporter({ url: "<your-endpoint>", metadata });
provider.addSpanProcessor(new SimpleSpanProcessor(exporter));
provider.register();

// 4. Application code (must come after provider registration)
const api = require("@opentelemetry/api");
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/api");
  return res.status(201).send(result.data);
});

app.get("/api", async (req, res) => {
  const currentSpan = api.trace.getSpan(api.context.active());
  currentSpan.addEvent("timestamp", { value: Date.now() });
  currentSpan.setAttribute("tagKey-01", "tagValue-01");
  res.json({ code: 200, msg: "success" });
});

app.use(express.json());

app.listen(7001, () => {
  console.log("Listening on http://localhost:7001");
});