Managed Service for OpenTelemetry:Kirim data jejak dari aplikasi Node.js

Langkah 1: Instal dependensi

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

Langkah 2: Instal paket OpenTelemetry

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

Langkah 3: Buat aplikasi

Contoh berikut membuat server Express dasar dengan dua entri rute:

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

Langkah 4: Atur variabel lingkungan dan jalankan aplikasi

Atur variabel lingkungan berikut, lalu jalankan aplikasi:

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

Ganti placeholder berikut dengan nilai aktual Anda:

Tabel berikut menjelaskan setiap variabel lingkungan:

Untuk detail semua variabel lingkungan OpenTelemetry yang tersedia, lihat Konfigurasi Instrumentasi Otomatis.

Langkah 5: Hasilkan data jejak

Kirim permintaan untuk menghasilkan jejak:

curl localhost:7001/hello

Setelah permintaan selesai, SDK mengekspor data jejak ke Managed Service for OpenTelemetry.

Langkah 1: Tambahkan dependensi OpenTelemetry

Tambahkan dependensi berikut ke file package.json Anda:

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

Langkah 2: Buat penyedia tracer

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(),
    // Ganti "opentelemetry-express" dengan nama layanan Anda
    [SemanticResourceAttributes.SERVICE_NAME]: "opentelemetry-express",
  }),
});

Langkah 3: Daftarkan instrumentasi framework

Daftarkan instrumentasi HTTP dan Express untuk melacak permintaan masuk dan keluar secara otomatis:

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

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

Untuk menginstrumen framework Node.js lainnya, lihat paket OpenTelemetry auto-instrumentations-node untuk plugin yang tersedia.

Langkah 4: Konfigurasikan exporter

Konfigurasikan exporter OTLP melalui gRPC untuk mengirim data jejak ke Managed Service for OpenTelemetry:

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();

Ganti placeholder berikut dengan nilai aktual Anda:

Langkah 5 (opsional): Tambahkan event dan atribut kustom

Lampirkan event dan atribut ke rentang saat ini untuk konteks spesifik aplikasi:

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

// Tambahkan event berstempel waktu
currentSpan.addEvent("timestamp", { value: Date.now() });

// Tambahkan atribut kustom
currentSpan.setAttribute("tagKey-01", "tagValue-01");

Untuk informasi lebih lanjut tentang API pelacakan OpenTelemetry, lihat Panduan mulai cepat OpenTelemetry JS.

Aplikasi tidak muncul di konsol

• Verifikasi bahwa OTEL_EXPORTER_OTLP_TRACES_ENDPOINT (otomatis) atau parameter url dalam OTLPTraceExporter (manual) sesuai dengan titik akhir dari konsol.

• Konfirmasi konektivitas jaringan ke titik akhir tersebut. Jika aplikasi Anda berjalan di luar Alibaba Cloud, gunakan titik akhir publik, bukan titik akhir VPC.

• Pastikan aplikasi Anda telah menerima setidaknya satu permintaan. OpenTelemetry menyimpan buffer rentang sebelum mengekspornya.

• Untuk instrumentasi manual, pastikan penyedia tracer diinisialisasi sebelum impor aplikasi apa pun. Urutan inisialisasi yang salah menyebabkan rentang tidak muncul.

Aktifkan logging debug

Atur tingkat log OpenTelemetry ke debug untuk memeriksa perilaku SDK:

export OTEL_LOG_LEVEL=debug

Jalankan ulang aplikasi dan periksa output konsol untuk log ekspor rentang dan error. Ekspor yang berhasil menghasilkan entri log seperti berikut:

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

Jika tidak ada entri rentang yang muncul, verifikasi bahwa aplikasi Anda telah memproses setidaknya satu permintaan dan titik akhir tersebut dapat dijangkau.