JavaScript 用 Azure Monitor OpenTelemetry Exporter クライアント ライブラリ - バージョン 1.0.0-beta.23

  • [アーティクル]

npm バージョン

作業の開始

このエクスポーター パッケージは、アプリケーションが OpenTelemetry SDK で 既にインストルメント化されていることを 前提としています。 OpenTelemetry データをエクスポートする準備ができたら、このエクスポーターをアプリケーションに追加できます。

パッケージをインストールする

npm install @azure/monitor-opentelemetry-exporter

現在サポートされている環境

詳細については、Microsoft のサポート ポリシーを参照してください。

警告： この SDK は、Node.js 環境でのみ機能します。 ブラウザー環境には Application Insights JavaScript SDK を使用します。

前提条件

分散トレース

既存の OpenTelemetry トレーサー プロバイダーにエクスポーターを追加します (NodeTracerProvider / BasicTracerProvider)

const { AzureMonitorTraceExporter } = require("@azure/monitor-opentelemetry-exporter");
const { BatchSpanProcessor } = require("@opentelemetry/sdk-trace-base");
const { NodeTracerProvider } = require("@opentelemetry/sdk-trace-node");
const { Resource } = require("@opentelemetry/resources"); 
const { SemanticResourceAttributes } = require("@opentelemetry/semantic-conventions"); 

const tracerProvider = new NodeTracerProvider({
  resource: new Resource({
    [SemanticResourceAttributes.SERVICE_NAME]: "basic-service",
  }),
});
// Register Tracer Provider as global
tracerProvider.register();

// Create an exporter instance
const exporter = new AzureMonitorTraceExporter({
  connectionString:
    process.env["APPLICATIONINSIGHTS_CONNECTION_STRING"] || "<your connection string>"
});

// Add the exporter to the Provider
tracerProvider.addSpanProcessor(
  new BatchSpanProcessor(exporter, {
    bufferTimeout: 15000,
    bufferSize: 1000
  })
);

メトリック

既存の OpenTelemetry 測定プロバイダーにエクスポーターを追加する (MeterProvider)

const { metrics } = require("@opentelemetry/api");
const { MeterProvider, PeriodicExportingMetricReader } = require("@opentelemetry/sdk-metrics");
const { AzureMonitorMetricExporter } = require("@azure/monitor-opentelemetry-exporter");

// Add the exporter into the MetricReader and register it with the MeterProvider
const exporter = new AzureMonitorMetricExporter({
  connectionString:
    process.env["APPLICATIONINSIGHTS_CONNECTION_STRING"] || "<your connection string>",
});
const metricReaderOptions = {
  exporter: exporter,
};
const metricReader = new PeriodicExportingMetricReader(metricReaderOptions);
const meterProvider = new MeterProvider();
meterProvider.addMetricReader(metricReader);

// Register Meter Provider as global
 metrics.setGlobalMeterProvider(meterProvider);

ログ

既存の OpenTelemetry Logger プロバイダーに Log Exporter を追加する (LoggerProvider)

const { logs } = require("@opentelemetry/api-logs");
const { LoggerProvider, BatchLogRecordProcessor } = require("@opentelemetry/sdk-logs");
const { AzureMonitorLogExporter } = require("@azure/monitor-opentelemetry-exporter");

// Add the Log exporter into the logRecordProcessor and register it with the LoggerProvider
const exporter = new AzureMonitorLogExporter({
  connectionString:
    process.env["APPLICATIONINSIGHTS_CONNECTION_STRING"] || "<your connection string>",
});
const logRecordProcessor = new BatchLogRecordProcessor(exporter);
const loggerProvider = new LoggerProvider();
loggerProvider.addLogRecordProcessor(logRecordProcessor);

// Register logger Provider as global
logs.setGlobalLoggerProvider(loggerProvider);

サンプリング

サンプリングを有効にして、受信するテレメトリ レコードの量を制限できます。 Application Insights で正しいサンプリングを有効にするには、次に示すように を ApplicationInsightsSampler 使用します。

const { ApplicationInsightsSampler } = require("@azure/monitor-opentelemetry-exporter");
const { BatchSpanProcessor } = require("@opentelemetry/sdk-trace-base");
const { NodeTracerProvider } = require("@opentelemetry/sdk-trace-node");
const { Resource } = require("@opentelemetry/resources"); 
const { SemanticResourceAttributes } = require("@opentelemetry/semantic-conventions"); 

// Sampler expects a sample rate of between 0 and 1 inclusive
// A rate of 0.75 means approximately 75 % of your traces will be sent
const aiSampler = new ApplicationInsightsSampler(0.75);
const provider = new NodeTracerProvider({
  sampler: aiSampler,
  resource: new Resource({
    [SemanticResourceAttributes.SERVICE_NAME]: "basic-service",
  }),
});
provider.register();

例

いくつかのチャンピオン シナリオの完全なサンプルについては、 フォルダーを samples/ 参照してください。

主要な概念

OpenTelemetry プロジェクトの詳細については、「 OpenTelemetry の仕様」を参照してください。

トラブルシューティング

デバッグ ログの有効化

プロバイダーのログ 記録レベルを変更することで、デバッグ ログを有効にすることができます。

const { DiagConsoleLogger, DiagLogLevel, diag } = require("@opentelemetry/api");
const { NodeTracerProvider } = require("@opentelemetry/sdk-trace-node");

const provider = new NodeTracerProvider();
diag.setLogger(new DiagConsoleLogger(), DiagLogLevel.ALL);
provider.register();

次の手順

このエクスポーターは、 OpenTelemetry JS で使用されます。

プラグイン レジストリ

使用しているライブラリに対してプラグインが既に作成されているかどうかを確認するには、OpenTelemetry レジストリをチェックしてください。

レジストリ内のライブラリができない場合は、 で opentelemetry-js-contrib新しいプラグイン要求を提案してください。

共同作成

このライブラリに投稿する場合、コードをビルドしてテストする方法の詳細については、投稿ガイドを参照してください。

インプレッション数