次の方法で共有

Azure Monitor OpenTelemetry を設定する

このガイドでは、Azure Monitor OpenTelemetry ディストリビューションを使用して Azure Monitor Application Insights で OpenTelemetry (OTel) を構成する方法について説明します。 適切な構成により、.NET、Java、Node.js、Python アプリケーション間で一貫したテレメトリ データ収集が保証され、より信頼性の高い監視と診断が可能になります。

注

Azure Function Apps については、「 Azure Functions で OpenTelemetry を使用する」を参照してください。

接続文字列

Application Insights 内の接続文字列は、テレメトリ データを送信するためのターゲットの場所を定義します。

接続文字列を構成するには、次の 3 つの方法のいずれかを使用します。

  • 以下のように UseAzureMonitor() ファイルに program.cs を追加します。

    var builder = WebApplication.CreateBuilder(args);

// Add the OpenTelemetry telemetry service to the application.
// This service will collect and send telemetry data to Azure Monitor.
builder.Services.AddOpenTelemetry().UseAzureMonitor(options => {
    options.ConnectionString = "<Your Connection String>";
});

var app = builder.Build();

app.Run();

  • 環境変数を設定します。

    APPLICATIONINSIGHTS_CONNECTION_STRING=<Your Connection String>

  • 次のセクションを appsettings.json config ファイルに追加します。

    {
  "AzureMonitor": {
      "ConnectionString": "<Your Connection String>"
  }
}

注

接続文字列を複数の場所に設定した場合は、次の優先順位に従います。

  1. コード
  2. 環境変数
  3. 構成ファイル

クラウド ロール名とクラウド ロール インスタンスを設定する

サポートされている言語の場合、Azure Monitor OpenTelemetry Distro はリソース コンテキストを自動的に検出し、コンポーネントのクラウド ロール名とクラウド ロール インスタンスプロパティの既定値を提供します。 ただし、既定値をチームにとって意味のある値にオーバーライドしたい場合があります。 クラウド ロール名の値は、アプリケーション マップでノードの下に名前として表示されます。

リソース属性を使用して、クラウド ロール名とクラウド ロール インスタンスを設定します。 クラウド ロール名は service.namespace および service.name 属性を使用しますが、service.name が設定されていない場合は service.namespace にフォールバックします。 クラウド ロール インスタンスは service.instance.id 属性値を使用します。 リソースの標準属性の詳細については、「 OpenTelemetry セマンティック規則」を参照してください。

// Setting role name and role instance

// Create a dictionary of resource attributes.
var resourceAttributes = new Dictionary<string, object> {
    { "service.name", "my-service" },
    { "service.namespace", "my-namespace" },
    { "service.instance.id", "my-instance" }};

// Create a new ASP.NET Core web application builder.
var builder = WebApplication.CreateBuilder(args);

// Add the OpenTelemetry telemetry service to the application.
// This service will collect and send telemetry data to Azure Monitor.
builder.Services.AddOpenTelemetry()
    .UseAzureMonitor()
    // Configure the ResourceBuilder to add the custom resource attributes to all signals.
    // Custom resource attributes should be added AFTER AzureMonitor to override the default ResourceDetectors.
    .ConfigureResource(resourceBuilder => resourceBuilder.AddAttributes(resourceAttributes));

// Build the ASP.NET Core web application.
var app = builder.Build();

// Start the ASP.NET Core web application.
app.Run();

サンプリングを有効にする

サンプリングを有効にしてデータ インジェストの量を減らすと、コストを削減することができます。 Azure Monitor には、Application Insights が に変換するサンプリング率をイベントに設定するカスタムの "固定レート" サンプラーが用意されています。ItemCount 固定レートサンプラーは、正確なエクスペリエンスとイベント数を保証します。 サンプラーは、サービス間でトレースを保持するように設計されており、前の Application Insights ソフトウェア開発キット (SDK) と相互運用できます。 詳細については、サンプリングの 詳細を参照してください。

注

メトリックとログはサンプリングの影響を受けません。 Application Insights で予期しない料金や高コストが表示される場合は、このガイドが役立ちます。 テレメトリの量が多い、データ インジェストの急増、サンプリングが正しく構成されていないなどの一般的な原因について説明します。 コストの急増、テレメトリボリューム、サンプリングが機能しない、データ上限、高インジェスト、または予期しない課金に関連する問題をトラブルシューティングする場合に特に便利です。 開始するには、「 Application Insights での高いデータ インジェストのトラブルシューティング」を参照してください。

サンプラーでは、0 から 1 の間のサンプル レートが想定されます。 レート 0.1 は、トレースの約 10% が送信されることを意味します。

// Create a new ASP.NET Core web application builder.
var builder = WebApplication.CreateBuilder(args);

// Add the OpenTelemetry telemetry service to the application.
// This service will collect and send telemetry data to Azure Monitor.
builder.Services.AddOpenTelemetry().UseAzureMonitor(options =>
{
    // Set the sampling ratio to 10%. This means that 10% of all traces will be sampled and sent to Azure Monitor.
    options.SamplingRatio = 0.1F;
});

// Build the ASP.NET Core web application.
var app = builder.Build();

// Start the ASP.NET Core web application.
app.Run();

ヒント

固定レート/比率サンプリングを使用していて、サンプリング レートをいくつに設定すればよいかわからない場合は、5% から開始します (0.05 サンプリング比率)。エラーとパフォーマンスの各ペインに表示される操作の精度に基づいてレートを調整します。 一般に、レートが高いほど精度が高くなります。 ただし、ANY サンプリングは精度に影響するため、サンプリングの影響を受けない OpenTelemetry メトリックに対してアラートを生成することをお勧めします。

ライブ メトリック

ライブ メトリック は、アプリケーションのアクティビティとパフォーマンスに関する分析情報を得るためのリアルタイム分析ダッシュボードを提供します。

重要

ベータ版、プレビュー版、またはその他の一般提供にまだリリースされていない Azure 機能に適用される法的条件については、 Microsoft Azure プレビューの追加使用条件 を参照してください。

この機能は、既定で有効になっています。

ユーザーは、ディストリビューションを構成するときにライブ メトリックを無効にすることができます。

builder.Services.AddOpenTelemetry().UseAzureMonitor(options => {
	// Disable the Live Metrics feature.
    options.EnableLiveMetrics = false;
});

Microsoft Entra ID (旧称 Azure AD) 認証を有効にする

Azure への接続をより安全にするために、Microsoft Entra 認証を有効にすることができます。これにより、不正なテレメトリがサブスクリプションに取り込まれるのを防ぐことができます。

詳細については、サポートされている言語ごとにリンクされている専用の Microsoft Entra 認証ページを参照してください。

Entra ID 認証の構成の詳細については、Application Insights の Microsoft Entra 認証に関するページを参照してください。

オフライン ストレージと自動再試行

Azure Monitor OpenTelemetry ベースのオファリングでは、アプリケーションが Application Insights から切断されると、テレメトリがキャッシュされ、送信が最大 48 時間再試行されます。 データ処理の推奨事項については、「 プライベート データのエクスポートと削除」を参照してください。 負荷の高いアプリケーションでは、許容時間を超えるか最大ファイル サイズを超えるという 2 つの理由でテレメトリが削除される場合があります。 必要に応じて、製品は古いイベントよりも最近のイベントに優先順位を付けます。

Distro パッケージには AzureMonitorExporter が含まれています。既定では、オフライン ストレージには次のいずれかの場所が使用されます (優先順位の高い順に記載されています)。

  • ウィンドウズ
    • %LOCALAPPDATA%\Microsoft\AzureMonitor
    • %TEMP%\Microsoft\AzureMonitor
  • Windows 以外
    • %TMPDIR%/Microsoft/AzureMonitor
    • /var/tmp/Microsoft/AzureMonitor
    • /tmp/Microsoft/AzureMonitor

既定のディレクトリをオーバーライドするには、AzureMonitorOptions.StorageDirectory を設定する必要があります。

// Create a new ASP.NET Core web application builder.
var builder = WebApplication.CreateBuilder(args);

// Add the OpenTelemetry telemetry service to the application.
// This service will collect and send telemetry data to Azure Monitor.
builder.Services.AddOpenTelemetry().UseAzureMonitor(options =>
{
    // Set the Azure Monitor storage directory to "C:\\SomeDirectory".
    // This is the directory where the OpenTelemetry SDK will store any telemetry data that cannot be sent to Azure Monitor immediately.
    options.StorageDirectory = "C:\\SomeDirectory";
});

// Build the ASP.NET Core web application.
var app = builder.Build();

// Start the ASP.NET Core web application.
app.Run();

この機能を無効にするには、AzureMonitorOptions.DisableOfflineStorage = true を設定する必要があります。

OTLP エクスポーターを有効にする

2 つの場所にテレメトリを送信する場合、Azure Monitor エクスポーターと一緒に OpenTelemetry プロトコル (OTLP) エクスポーターを有効にする必要があります。

注

OTLP エクスポーターは、便宜上表示されているだけです。 Microsoft では、OTLP エクスポーターや、そのすべてのコンポーネントまたはサードパーティ エクスペリエンス ダウンストリームを正式にサポートしていません。

  1. プロジェクトに OpenTelemetry.Exporter.OpenTelemetryProtocol パッケージをインストールします。

    dotnet add package OpenTelemetry.Exporter.OpenTelemetryProtocol

  2. 次のコード スニペットを追加します。 この例では、OpenTelemetry コレクターが OTLP レシーバーと共に実行されることを前提にしています。 詳細については、 GitHub の例を参照してください。

    // Create a new ASP.NET Core web application builder.
var builder = WebApplication.CreateBuilder(args);

// Add the OpenTelemetry telemetry service to the application.
// This service will collect and send telemetry data to Azure Monitor.
builder.Services.AddOpenTelemetry().UseAzureMonitor();

// Add the OpenTelemetry OTLP exporter to the application.
// This exporter will send telemetry data to an OTLP receiver, such as Prometheus
builder.Services.AddOpenTelemetry().WithTracing(builder => builder.AddOtlpExporter());
builder.Services.AddOpenTelemetry().WithMetrics(builder => builder.AddOtlpExporter());

// Build the ASP.NET Core web application.
var app = builder.Build();

// Start the ASP.NET Core web application.
app.Run();

OpenTelemetry の構成

次の OpenTelemetry 構成は、Azure Monitor OpenTelemetry Distros の使用中に環境変数を介してアクセスできます。

環境変数 説明
APPLICATIONINSIGHTS_CONNECTION_STRING これを Application Insights リソースの接続文字列に設定します。
APPLICATIONINSIGHTS_STATSBEAT_DISABLED これを true に設定して、内部メトリック収集をオプトアウトします。
OTEL_RESOURCE_ATTRIBUTES リソース属性として使用するキーと値のペア。 リソース属性の詳細については、 Resource SDK の仕様を参照してください。
OTEL_SERVICE_NAME service.name リソース属性の値を設定します。 service.name が OTEL_RESOURCE_ATTRIBUTES でも指定されている場合は、OTEL_SERVICE_NAME が優先されます。

URL クエリ文字列を編集する

URL クエリ文字列を編集するには、クエリ文字列コレクションをオフにします。 SAS トークンを使用して Azure ストレージを呼び出す場合は、この設定をお勧めします。

Azure.Monitor.OpenTelemetry.AspNetCore ディストリビューション パッケージを使用している場合は、ASP.NET Core ライブラリと HttpClient インストルメンテーション ライブラリの両方が含まれます。 Microsoft のディストリビューション パッケージでは、クエリ文字列の編集は既定でオフに設定されています。

この動作を変更するには、環境変数を true か false のどちらかに設定する必要があります。

  • ASP.NET Core インストルメンテーション: OTEL_DOTNET_EXPERIMENTAL_ASPNETCORE_DISABLE_URL_QUERY_REDACTIONクエリ文字列の編集は既定で無効になっています。 有効にするには、この環境変数を false に設定します。
  • Http Client インストルメンテーション: OTEL_DOTNET_EXPERIMENTAL_HTTPCLIENT_DISABLE_URL_QUERY_REDACTIONクエリ文字列の編集は既定で無効になっています。 有効にするには、この環境変数を false に設定します。