次の方法で共有

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

  • [アーティクル]

npm バージョンのnpm versionnpm versionnpm versionをする

はじめ

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

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

npm install @azure/monitor-opentelemetry-exporter

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

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

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

前提 条件

分散トレース

既存の OpenTelemetry Tracer Provider (NodeTracerProvider / BasicTracerProvider) にエクスポーターを追加します

import { AzureMonitorTraceExporter } from "@azure/monitor-opentelemetry-exporter";
import { NodeTracerProvider, BatchSpanProcessor } from "@opentelemetry/sdk-trace-node";
import { Resource } from "@opentelemetry/resources";
import { ATTR_SERVICE_NAME } from "@opentelemetry/semantic-conventions";

// Create an exporter instance
const exporter = new AzureMonitorTraceExporter({
  connectionString: "<connection string>",
});

// Create and configure the Node Tracer provider
const tracerProvider = new NodeTracerProvider({
  resource: new Resource({
    [ATTR_SERVICE_NAME]: "basic-service",
  }),
  spanProcessors: [
    new BatchSpanProcessor(exporter, {
      exportTimeoutMillis: 15000,
      maxQueueSize: 1000,
    }),
  ],
});

// Register Tracer Provider as global
tracerProvider.register();

メトリック

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

import { AzureMonitorMetricExporter } from "@azure/monitor-opentelemetry-exporter";
import { PeriodicExportingMetricReader, MeterProvider } from "@opentelemetry/sdk-metrics";
import { metrics } from "@opentelemetry/api";

// Add the exporter into the MetricReader and register it with the MeterProvider
const exporter = new AzureMonitorMetricExporter({
  connectionString: "<connection string>",
});

const metricReaderOptions = {
  exporter: exporter,
};
const metricReader = new PeriodicExportingMetricReader(metricReaderOptions);
const meterProvider = new MeterProvider({
  readers: [metricReader],
});

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

ログ

既存の OpenTelemetry ロガー プロバイダー (LoggerProvider) にログ エクスポーターを追加する

import { AzureMonitorLogExporter } from "@azure/monitor-opentelemetry-exporter";
import { BatchLogRecordProcessor, LoggerProvider } from "@opentelemetry/sdk-logs";
import { logs } from "@opentelemetry/api-logs";

// Add the Log exporter into the logRecordProcessor and register it with the LoggerProvider
const exporter = new AzureMonitorLogExporter({
  connectionString: "<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 を使用します。

import { ApplicationInsightsSampler } from "@azure/monitor-opentelemetry-exporter";
import { NodeTracerProvider } from "@opentelemetry/sdk-trace-node";
import { Resource } from "@opentelemetry/resources";
import { ATTR_SERVICE_NAME } from "@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({
    [ATTR_SERVICE_NAME]: "basic-service",
  }),
});

provider.register();

例

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

主な概念

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

トラブルシューティング

デバッグ ログを有効にする

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

import { NodeTracerProvider } from "@opentelemetry/sdk-trace-node";
import { diag, DiagConsoleLogger, DiagLogLevel } from "@opentelemetry/api";

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

伐採

Azure ログを有効にすると、エラーに関する有用な情報を明らかにするのにも役立つ場合があります。 HTTP 要求と応答のログを表示するには、AZURE_LOG_LEVEL 環境変数を infoに設定します。 または、setLogLevelで @azure/logger を呼び出すことによって、実行時にログを有効にすることもできます。

import { setLogLevel } from "@azure/logger";

setLogLevel("info");

ログを有効にする方法の詳細な手順については、@azure/logger パッケージのドキュメントを参照してください。

次の手順

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

プラグイン レジストリ

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

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

貢献

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