OpenTelemetry SDK for JavaScriptを使用して、Node.jsアプリケーションからSimple Log Serviceにトレースデータをインポートする - Simple Log Service

このトピックでは、OpenTelemetry SDK for JavaScriptを使用して、Node.jsアプリケーションからSimple Log Serviceにトレースデータをインポートする方法について説明します。

前提条件

トレースインスタンスが作成されます。詳細については、「トレースインスタンスの作成」をご参照ください。
Node.js開発環境がセットアップされています。 Node.jsのバージョンは8.5.0以降です。

方法1 :( 推奨) 半自動モードでデータをインポートする

Node.jsの依存関係を一部のフレームワークにインストールして、トレースデータをSimple Log Serviceに自動的にアップロードできます。フレームワークには、HTTP、HTTPS、gRPC、Express、MySQL、MongoDB、およびRedisが含まれます。フレームワークの詳細については、「opentelemetry-node-js-contrib」をご参照ください。この例では、Expressを使用して半自動モードでデータをインポートする方法を説明します。詳細については、「例」をご参照ください。

依存関係をインストールします。

npm install --save @opentelemetry/api
npm install --save @opentelemetry/node
npm install --save @opentelemetry/tracing
npm install --save @opentelemetry/exporter-collector-grpc
npm install --save @opentelemetry/instrumentation
npm install --save @opentelemetry/instrumentation-express
npm install --save @opentelemetry/instrumentation-http
npm install --save @grpc/grpc-js
npm install --save @opentelemetry/sdk-trace-node

の保存

トレーサーを初期化し、Expressを起動します。

次のコードの変数を実際の値に置き換えます。変数の詳細については、「変数」をご参照ください。

const opentelemetry = require("@opentelemetry/api");
const { registerInstrumentations } = require("@opentelemetry/instrumentation");
const { NodeTracerProvider } = require("@opentelemetry/sdk-trace-node");
const { Resource } = require("@opentelemetry/resources");
const {
  SemanticResourceAttributes,
} = require("@opentelemetry/semantic-conventions");
const {
  SimpleSpanProcessor,
  ConsoleSpanExporter,
} = require("@opentelemetry/tracing");
const grpc = require("@grpc/grpc-js");
const {
  CollectorTraceExporter,
} = require("@opentelemetry/exporter-collector-grpc");

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

var os = require("os");
var hostname = os.hostname();

const provider = new NodeTracerProvider({
  resource: new Resource({
    [SemanticResourceAttributes.SERVICE_NAME]: "${service}",
      [SemanticResourceAttributes.DEPLOYMENT_ENVIRONMENT]: "${environment}",
    [SemanticResourceAttributes.SERVICE_VERSION]: "${version}",
    [SemanticResourceAttributes.SERVICE_NAMESPACE]: "${service.namespace}",
    [SemanticResourceAttributes.HOST_NAME]: hostname,
  }),
});
provider.register();

registerInstrumentations({
  instrumentations: [
    new HttpInstrumentation(),
    new ExpressInstrumentation({
      ignoreLayersType: [new RegExp("middleware.*")],
    }),
  ],
  tracerProvider: provider,
});

var url = "${endpoint}";

var logStdout = false;
if (url == "stdout") {
  logStdout = true;
}
var meta = new grpc.Metadata();
meta.add("x-sls-otel-project", "${project}");
meta.add("x-sls-otel-instance-id", "${instance}");
meta.add("x-sls-otel-ak-id", "${access-key-id}");
meta.add("x-sls-otel-ak-secret", "${access-key-secret}");
const collectorOptions = {
  url: url,
  credentials: grpc.credentials.createSsl(),
  metadata: meta,
};
const exporter = new CollectorTraceExporter(collectorOptions);

if (!logStdout) {
  provider.addSpanProcessor(new SimpleSpanProcessor(exporter));
} else {
  var stdexporter = new ConsoleSpanExporter();
  provider.addSpanProcessor(new SimpleSpanProcessor(stdexporter));
}
provider.register();
var tracer = opentelemetry.trace.getTracer("${service}");

var express = require("express");
var app = express();

app.get("/hello", function (req, res, next) {
  res.send("success");
});

var server = app.listen(8079, function () {
  var port = server.address().port;
  console.log("App now running in %s mode on port %d", app.get("env"), port);
});

表 1. 変数

変数	説明	例
${endpoint}	Simple Log Serviceプロジェクトのエンドポイント。形式: ${project}.${region-endpoint}: ポート ${project}: Simple Log Serviceプロジェクトの名前。 ${region-endpoint}: プロジェクトが存在するリージョンのSimple Log Serviceエンドポイント。 Simple Log Serviceには、内部エンドポイントまたはパブリックエンドポイントを使用してアクセスできます。内部エンドポイントは、クラシックネットワークまたは仮想プライベートクラウド (VPC) 経由でアクセスできます。インターネット経由でパブリックエンドポイントにアクセスできます。詳細については、「エンドポイント」をご参照ください。 Port: ポート番号。値は10010のように固定されます。	test-project.cn-hangzhou.log.aliyuncs.com:10010
${project}	Simple Log Serviceプロジェクトの名前。	test-project
${instance}	トレースインスタンスのID。詳細については、「トレースインスタンスの作成」をご参照ください。	テストトレース
${access-key-id}	Alibaba CloudアカウントのAccessKey ID。 Simple Log Serviceプロジェクトに対する書き込み権限のみを持つRAMユーザーのAccessKeyペアを使用することを推奨します。 AccessKey ペアは、AccessKey ID と AccessKey Secret で構成されます。指定したプロジェクトの書き込み権限をRAMユーザーに付与する方法の詳細については、「カスタムポリシーを使用してRAMユーザーに権限を付与する」をご参照ください。 AccessKeyペアを取得する方法の詳細については、「AccessKeyペア」をご参照ください。	なし
${access-key-secret}	Alibaba CloudアカウントのAccessKeyシークレット。 Simple Log Serviceプロジェクトに対する書き込み権限のみを持つRAMユーザーのAccessKeyペアを使用することを推奨します。	なし
${service}	サービスの名前です。ビジネス要件に基づいて値を指定します。	payment
${version}	サービスのバージョンです。 va.b.c形式でバージョンを指定することを推奨します。	v0.1.2
${service.nameスペース}	サービスが属する名前空間。	order
${environment}	サービスのデプロイ環境。例: テスト環境、ステージング環境、または本番環境。	前

サービスにアクセスしてトレースデータの生成をトリガーし、トレースデータをSimple Log serviceに送信します。
```
127.0.0.1:8079/hello
```

方法2: トレースデータを手動で生成して送信する

自己管理フレームワークを使用している場合、または特別な要件がある場合は、トレースデータを手動で作成し、そのデータをSimple Log Serviceに送信できます。詳細については、「opentelemetry-js」をご参照ください。

依存関係をインストールします。

npm install --save @opentelemetry/api
npm install --save @opentelemetry/node
npm install --save @opentelemetry/tracing
npm install --save @opentelemetry/exporter-collector-grpc

の保存

トレーサーを初期化し、Expressを起動します。

次のコードの変数を実際の値に置き換えます。詳細については、「変数」をご参照ください。

const opentelemetry = require("@opentelemetry/api");
const { registerInstrumentations } = require("@opentelemetry/instrumentation");
const { NodeTracerProvider } = require("@opentelemetry/sdk-trace-node");
const { Resource } = require("@opentelemetry/resources");
const {
  SemanticResourceAttributes,
} = require("@opentelemetry/semantic-conventions");
const {
  SimpleSpanProcessor,
  ConsoleSpanExporter,
} = require("@opentelemetry/tracing");
const grpc = require("@grpc/grpc-js");
const {
  CollectorTraceExporter,
} = require("@opentelemetry/exporter-collector-grpc");

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

var os = require("os");
var hostname = os.hostname();

const provider = new NodeTracerProvider({
  resource: new Resource({
    [SemanticResourceAttributes.SERVICE_NAME]: "${service}",
      [SemanticResourceAttributes.DEPLOYMENT_ENVIRONMENT]: "${environment}",
    [SemanticResourceAttributes.SERVICE_VERSION]: "${version}",
    [SemanticResourceAttributes.SERVICE_NAMESPACE]: "${service.namespace}",
    [SemanticResourceAttributes.HOST_NAME]: hostname,
  }),
});
provider.register();

registerInstrumentations({
  instrumentations: [
    new HttpInstrumentation(),
    new ExpressInstrumentation({
      ignoreLayersType: [new RegExp("middleware.*")],
    }),
  ],
  tracerProvider: provider,
});

var url = "${endpoint}";

var logStdout = false;
if (url == "stdout") {
  logStdout = true;
}
var meta = new grpc.Metadata();
meta.add("x-sls-otel-project", "${project}");
meta.add("x-sls-otel-instance-id", "${instance}");
meta.add("x-sls-otel-ak-id", "${access-key-id}");
meta.add("x-sls-otel-ak-secret", "${access-key-secret}");
const collectorOptions = {
  url: url,
  credentials: grpc.credentials.createSsl(),
  metadata: meta,
};
const exporter = new CollectorTraceExporter(collectorOptions);

if (!logStdout) {
  provider.addSpanProcessor(new SimpleSpanProcessor(exporter));
} else {
  var stdexporter = new ConsoleSpanExporter();
  provider.addSpanProcessor(new SimpleSpanProcessor(stdexporter));
}
provider.register();
var tracer = opentelemetry.trace.getTracer("${service}");

var express = require('express');

var app = express()

app.get('/hello', function (req, res, next) {
    const span = tracer.startSpan('hello');
    span.setAttribute('name', 'toma');
    span.setAttribute('age', '26');
    span.addEvent('invoking doWork');

    res.send("success");

    span.end();
});

var server = app.listen(8079, function () {
  var port = server.address().port;
  console.log("App now running in %s mode on port %d", app.get("env"), port);
});

サービスにアクセスしてトレースデータの生成をトリガーし、トレースデータをSimple Log serviceに送信します。
```
127.0.0.1:8079/hello
```

Simple Log Service:OpenTelemetry SDK for JavaScriptを使用して、Node.jsアプリケーションからSimple Log Serviceにトレースデータをインポートする

前提条件

方法1 :( 推奨) 半自動モードでデータをインポートする

方法2: トレースデータを手動で生成して送信する

次のステップ