.NET、Node.js、Python、Java アプリケーション用の Azure Monitor OpenTelemetry を有効にする

この記事では、Application Insights 内で OpenTelemetry ベースのデータ収集を有効にして構成する方法について説明します。 Azure Monitor OpenTelemetry Distro では:

• Azure Monitor 固有の機能のサポートを含む OpenTelemetry ディストリビューションを提供します。
• トレース、メトリック、ログ、例外を収集するための OpenTelemetry インストルメンテーション ライブラリを含めることで、自動テレメトリを有効にします。
• カスタム テレメトリの収集を可能にします。
• 実稼働中の Web アプリケーションからさらに多くのテレメトリを監視および収集するためのライブ メトリックをサポートします。

Azure Monitor OpenTelemetry Distro を使用する利点の詳細については、「Azure Monitor OpenTelemetry Distro を使用する必要がある理由」を参照してください。

OpenTelemetry を使用したデータ収集の詳細については、データ収集の基本に関する記事、または OpenTelemetry に関する FAQ を参照してください。

OpenTelemetry のリリースの状態

OpenTelemetry オファリングは、.NET、Node.js、Python、Java アプリケーションで使用できます。 機能別のリリースの状態については、「よく寄せられる質問」を参照してください。

Application Insights で OpenTelemetry を有効にする

このセクションの手順に従い、OpenTelemetry を使用してアプリケーションをインストルメント化します。 言語固有の手順のタブを選択します。

Note

.NET では、従来の ASP.NET、コンソール アプリ、Windows フォーム (WinForms) など、複数のシナリオについて説明します。

前提条件

• Azure サブスクリプション: Azure サブスクリプションを無料で作成する
• Application Insights リソース: Application Insights リソースを作成する

ASP.NET Core

• 正式にサポートされているバージョンの .NET を使用する ASP.NET Core アプリケーション

ヒント

Application Insights Classic API から移行する場合は、移行に関するドキュメントをご覧ください。

.NET

• サポートされているバージョンの .NET または .NET Framework 4.6.2 以降を使用するアプリケーション。

ヒント

Application Insights Classic API から移行する場合は、移行に関するドキュメントをご覧ください。

Java

• Java 8 以降を使う Java アプリケーション

Java ネイティブ

• GraalVM 17 以降を使う Java アプリケーション

Node.js

• 正式にサポートされているバージョンの Node.js ランタイムを使用するアプリケーション。
  • OpenTelemetry でサポートされているランタイム
  • Azure Monitor OpenTelemetry エクスポーターでサポートされているランタイム

Note

サポート対象外のものを示す表に記載されているプロパティに依存しない場合、ベータ版でなくなった後は ApplicationInsights shim を使用するのが最も簡単な方法です。

これらのプロパティに依存している場合は、Azure Monitor OpenTelemetry Distro に移行してください。 移行ガイドは間もなく提供されます。

ヒント

Application Insights Classic API から移行する場合は、移行に関するドキュメントをご覧ください。

Python

• Python 3.8 以降を使用する Python アプリケーション

ヒント

OpenCensus から移行する場合は、移行に関するドキュメントをご覧ください。

クライアント ライブラリをインストールする

ASP.NET Core

最新の Azure.Monitor.OpenTelemetry.AspNetCore NuGet パッケージをインストールします。

dotnet add package Azure.Monitor.OpenTelemetry.AspNetCore 

.NET

最新の Azure.Monitor.OpenTelemetry.Exporter NuGet パッケージをインストールします。

dotnet add package Azure.Monitor.OpenTelemetry.Exporter 

Java

最新の applicationinsights-agent-3.6.1.jar ファイルをダウンロードします。

警告

以前の 3.x バージョンからアップグレードする場合は、既定値の変更や、収集するデータのわずかな違いの影響を受ける可能性があります。 詳細については、リリース ノートの移行に関するセクションを参照してください。 3.5.0、3.4.0、3.3.0、3.2.0、および3.1.0

Java ネイティブ

Spring Boot ネイティブ アプリケーションの場合:

• OpenTelemetry 部品表 (BOM) をインポートします。
• Spring Cloud Azure スターター モニターの依存関係を追加します。
• Azure SDK JAR (Java アーカイブ) ファイルについては、次の手順に従います。

Quarkus ネイティブ アプリケーションの場合:

• Azure 用 Quarkus OpenTelemetry Exporter の依存関係を追加します。

Node.js

最新の @azure/monitor-opentelemetry パッケージをインストールします。

npm install @azure/monitor-opentelemetry

次のパッケージは、この記事で後述する特定のシナリオにも使用されます。

• @opentelemetry/api
• @opentelemetry/sdk-metrics
• @opentelemetry/resources
• @opentelemetry/semantic-conventions
• @opentelemetry/sdk-trace-base

npm install @opentelemetry/api
npm install @opentelemetry/sdk-metrics
npm install @opentelemetry/resources
npm install @opentelemetry/semantic-conventions
npm install @opentelemetry/sdk-trace-base

Python

最新の azure-monitor-opentelemetry PyPI パッケージをインストールします。

pip install azure-monitor-opentelemetry

アプリケーションを変更する

ASP.NET Core

Azure.Monitor.OpenTelemetry.AspNetCore 名前空間をインポートし、OpenTelemetry を追加して、program.cs クラスで Azure Monitor を使用するように構成します。

// Import the Azure.Monitor.OpenTelemetry.AspNetCore namespace.
using Azure.Monitor.OpenTelemetry.AspNetCore;

var builder = WebApplication.CreateBuilder(args);

// Add OpenTelemetry and configure it to use Azure Monitor.
builder.Services.AddOpenTelemetry().UseAzureMonitor();

var app = builder.Build();

app.Run();

.NET

program.cs クラスの各 OpenTelemetry シグナルに Azure Monitor エクスポーターを追加します。

// Create a new tracer provider builder and add an Azure Monitor trace exporter to the tracer provider builder.
// It is important to keep the TracerProvider instance active throughout the process lifetime.
// See https://github.com/open-telemetry/opentelemetry-dotnet/tree/main/docs/trace#tracerprovider-management
var tracerProvider = Sdk.CreateTracerProviderBuilder()
    .AddAzureMonitorTraceExporter();

// Add an Azure Monitor metric exporter to the metrics provider builder.
// It is important to keep the MetricsProvider instance active throughout the process lifetime.
// See https://github.com/open-telemetry/opentelemetry-dotnet/tree/main/docs/metrics#meterprovider-management
var metricsProvider = Sdk.CreateMeterProviderBuilder()
    .AddAzureMonitorMetricExporter();

// Create a new logger factory.
// It is important to keep the LoggerFactory instance active throughout the process lifetime.
// See https://github.com/open-telemetry/opentelemetry-dotnet/tree/main/docs/logs#logger-management
var loggerFactory = LoggerFactory.Create(builder =>
{
    builder.AddOpenTelemetry(logging =>
    {
        logging.AddAzureMonitorLogExporter();
    });
});

Note

詳細については、OpenTelemetry .NET の入門チュートリアルを参照してください

Java

自動インストルメンテーションは、構成の変更によって有効になります。 コードに変更を加える必要はありません。

アプリケーションの Java 仮想マシン (JVM) 引数に -javaagent:"path/to/applicationinsights-agent-.jar" を追加して、JVM が jar ファイルを指すようにします。

Note

サンプリングは 1 秒あたり 5 要求のレートで既定で有効になり、コスト管理に役立ちます。 このレートを超えるシナリオでは、テレメトリ データが欠落する可能性があります。 サンプリング構成の変更について詳しくは、サンプリングのオーバーライドに関する記事をご覧ください。

ヒント

シナリオ固有のガイダンスについては、「作業の開始 (補足)」を参照してください。

ヒント

Spring Boot アプリケーションを開発する場合は、必要に応じて JVM 引数をプログラムによる構成で置き換えることができます。 詳細については、「Azure Monitor Application Insights と Spring Boot の使用」を参照してください。

Java ネイティブ

自動インストルメンテーションは、構成の変更によって有効になります。 コードに変更を加える必要はありません。

Node.js

// Import the `useAzureMonitor()` function from the `@azure/monitor-opentelemetry` package.
const { useAzureMonitor } = require("@azure/monitor-opentelemetry");

// Call the `useAzureMonitor()` function to configure OpenTelemetry to use Azure Monitor.
useAzureMonitor();

Python

# Import the `configure_azure_monitor()` function from the
# `azure.monitor.opentelemetry` package.
from azure.monitor.opentelemetry import configure_azure_monitor

# Import the tracing api from the `opentelemetry` package.
from opentelemetry import trace

# Configure OpenTelemetry to use Azure Monitor with the 
# APPLICATIONINSIGHTS_CONNECTION_STRING environment variable.
configure_azure_monitor()

Application Insights リソースから接続文字列をコピーします

この接続文字列は一意であり、Azure Monitor OpenTelemetry Distro が、収集したテレメトリを送信する場所を指定します。

ヒント

Application Insights リソースがまだない場合は、こちらのガイドに従って作成します。 既存のリソースを使用するのではなく、新たに作成することをお勧めします。

接続文字列をコピーするには:

1. Application Insights リソースの [概要] ペインにアクセスしてください。
2. 接続文字列を見つけます。
3. 接続文字列をポイントし、[クリップボードにコピー] アイコンを選択します。

お使いの環境で接続文字列を貼り付ける

接続文字列を貼り付けるには、次のオプションから選択します。

重要

コードを使用して接続文字列を設定するのは、ローカルの開発およびテストの環境に限ることをお勧めします。

運用環境では、環境変数または構成ファイル (Java のみ) を使用します。

• 環境変数を使用して設定する - "推奨"

  次のコマンドの <Your connection string> を、お使いの接続文字列に置き換えます。

  APPLICATIONINSIGHTS_CONNECTION_STRING=<Your connection string>
  

• 構成ファイルを使用して設定する - "Java のみ"

  次のコンテンツを使って、applicationinsights.json という名前の構成ファイルを作成し、applicationinsights-agent-.jar と同じディレクトリに配置します。

  {
    "connectionString": "<Your connection string>"
  }
  

  上記の JSON の <Your connection string> を、独自の一意の接続文字列に置き換えます。

• コードを使用して設定する - "ASP.NET Core、Node.js、Python のみ"

  コードを使用した接続文字列の設定の例については、接続文字列の構成に関する記事を参照してください。

Note

接続文字列を複数の場所に設定する場合、環境変数には次の順序で優先順位が付けられます。

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

データが流れていることを確認する

アプリケーションを実行し、Azure portal で Application Insights を開きます。 データが表示されるまでに数分かかる場合があります。

Application Insights がアプリケーションに対して有効になりました。 次の手順は省略可能であり、さらにカスタマイズできます。

重要

同じ Application Insights リソースにテレメトリを出力しているサービスが 2 つ以上ある場合は、アプリケーション マップ上で正しく表すために、クラウド ロール名を設定する必要があります。

Application Insights インストルメンテーションの使用時に、診断データが収集され、Microsoft に送信されます。 このデータは、Application Insights の実行と改善に役立ちます。 詳細については、「Azure Application Insights の Statsbeat」を参照してください。

サンプル アプリケーション

Azure Monitor OpenTelemetry サンプル アプリケーションは、サポートされているすべての言語で利用できます。

• ASP.NET Core サンプル アプリ
• NET サンプル アプリ
• Java サンプル アプリ
• Java GraalVM ネイティブ サンプル アプリ
• Node.js サンプル アプリ
• Python サンプル アプリ

次のステップ

ASP.NET Core

• Azure Monitor OpenTelemetry の追加と変更の詳細については、Azure Monitor OpenTelemetry の追加と変更に関するページを参照してください。
• OpenTelemetry ディストリビューションをさらに構成するには、「Azure Monitor OpenTelemetry の構成」を参照してください。
• ソースコードを確認するには、「Azure Monitor AspNetCore GitHub リポジトリ」を参照してください。
• NuGet パッケージをインストールしたり、更新プログラムを確認したり、リリース ノートを表示したりするには、「Azure Monitor AspNetCore NuGet パッケージ」のページを参照してください。
• Azure Monitor と OpenTelemetry について詳しく知るには、Azure Monitor のサンプル アプリケーションを参照してください。
• OpenTelemetry とそのコミュニティの詳細については、OpenTelemetry .NET GitHub リポジトリを参照してください。
• 使用エクスペリエンスを有効にするには、Web またはブラウザーのユーザー監視を有効にします。
• よく寄せられる質問、トラブルシューティング手順、サポート オプションを確認したり、OpenTelemetry フィードバックを提供したりするには、Azure Monitor Application Insights の OpenTelemetry のヘルプ、サポート、フィードバックに関する記事を参照してください。

.NET

• Azure Monitor OpenTelemetry の追加と変更の詳細については、Azure Monitor OpenTelemetry の追加と変更に関するページを参照してください。
• OpenTelemetry ディストリビューションをさらに構成するには、「Azure Monitor OpenTelemetry の構成」を参照してください。
• ソースコードを確認するには、Azure Monitor エクスポーター GitHub リポジトリを参照してください。
• NuGet パッケージをインストールしたり、更新プログラムを確認したり、リリース ノートを表示したりするには、Azure Monitor エクスポーター NuGet パッケージのページを参照してください。
• Azure Monitor と OpenTelemetry について詳しく知るには、Azure Monitor のサンプル アプリケーションを参照してください。
• OpenTelemetry とそのコミュニティの詳細については、OpenTelemetry .NET GitHub リポジトリを参照してください。
• 使用エクスペリエンスを有効にするには、Web またはブラウザーのユーザー監視を有効にします。
• よく寄せられる質問、トラブルシューティング手順、サポート オプションを確認したり、OpenTelemetry フィードバックを提供したりするには、Azure Monitor Application Insights の OpenTelemetry のヘルプ、サポート、フィードバックに関する記事を参照してください。

Java

• Azure Monitor OpenTelemetry の追加と変更の詳細については、Azure Monitor OpenTelemetry の追加と変更に関するページを参照してください。
• 「Java の自動インストルメンテーション構成オプション」を確認してください。
• Azure Monitor Java 自動インストルメンテーション GitHub リポジトリに関するページでソース コードを確認します。
• OpenTelemetry Java GitHub リポジトリに関するページで OpenTelemetry とそのコミュニティの詳細を確認します。
• Web またはブラウザーのユーザー監視の有効化に関する記事を参照して、使用エクスペリエンスを有効にします。
• GitHub のリリース ノートを確認します。
• よく寄せられる質問、トラブルシューティング手順、サポート オプションを確認したり、OpenTelemetry フィードバックを提供したりするには、Azure Monitor Application Insights の OpenTelemetry のヘルプ、サポート、フィードバックに関する記事を参照してください。

Java ネイティブ

• Azure Monitor OpenTelemetry の追加と変更の詳細については、Azure Monitor OpenTelemetry の追加と変更に関するページを参照してください。
• Spring Boot ネイティブ イメージ Java アプリケーションの Azure Monitor OpenTelemetry Distro と Azure 用 Quarkus OpenTelemetry Exporter のソース コードを確認します。
• OpenTelemetry Java GitHub リポジトリに関するページで OpenTelemetry とそのコミュニティの詳細を確認します。
• OpenTelemetry SpringBoot スターターに関するページで Spring Boot ネイティブ イメージ アプリケーションの他の機能を確認します
• Quarkus OpenTelemetry Exporter for Azure の Quarkus ネイティブ アプリケーションの機能について説明します。
• GitHub のリリース ノートを確認します。
• よく寄せられる質問、トラブルシューティング手順、サポート オプションを確認したり、OpenTelemetry フィードバックを提供したりするには、Azure Monitor Application Insights の OpenTelemetry のヘルプ、サポート、フィードバックに関する記事を参照してください。

Node.js

• Azure Monitor OpenTelemetry の追加と変更の詳細については、Azure Monitor OpenTelemetry の追加と変更に関するページを参照してください。
• ソース コードを確認する場合は、Azure Monitor AspNetCore GitHub リポジトリを参照してください。
• npm パッケージのインストールおよび更新プログラムの確認を行うには、@azure/monitor-opentelemetrynpm パッケージのページを参照してください。
• Azure Monitor Application Insights と OpenTelemetry について詳しく知るには、Azure Monitor のサンプル アプリケーションを参照してください。
• OpenTelemetry とそのコミュニティの詳細については、OpenTelemetry JavaScript GitHub リポジトリを参照してください。
• 使用エクスペリエンスを有効にするには、Web またはブラウザーのユーザー監視を有効にします。
• よく寄せられる質問、トラブルシューティング手順、サポート オプションを確認したり、OpenTelemetry フィードバックを提供したりするには、Azure Monitor Application Insights の OpenTelemetry のヘルプ、サポート、フィードバックに関する記事を参照してください。

Python

• Azure Monitor OpenTelemetry の追加と変更の詳細については、Azure Monitor OpenTelemetry の追加と変更に関するページを参照してください。
• Azure Monitor Distro GitHub リポジトリに関するページでソース コードやその他のドキュメントを参照してください。
• Azure Monitor Distro のサンプルに関するページでその他のサンプルとユース ケースを参照してください。
• GitHub の変更ログをご覧ください。
• Azure Monitor Distro PyPI パッケージのページで、PyPI パッケージをインストールして、更新プログラムを確認し、リリース ノートを参照してください。
• Azure Monitor のサンプル アプリケーションに関するページで、Azure Monitor Application Insights と OpenTelemetry について理解を深めてください。
• OpenTelemetry Python GitHub リポジトリに関するページで、OpenTelemetry とそのコミュニティの詳細を参照してください。
• OpenTelemetry Contributor Python GitHub リポジトリに関するページで使用可能な OpenTelemetry インストルメンテーションとコンポーネントを確認してください。
• Web またはブラウザーのユーザー監視を有効にして、使用エクスペリエンスを有効にします。
• よく寄せられる質問、トラブルシューティング手順、サポート オプションを確認したり、OpenTelemetry フィードバックを提供したりするには、Azure Monitor Application Insights の OpenTelemetry のヘルプ、サポート、フィードバックに関する記事を参照してください。