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

この記事では、OpenTelemetry ベースのデータ収集を有効にして、Azure Monitor Application Insights 内のエクスペリエンスを強化するように構成する方法について説明します。 "Azure Monitor OpenTelemetry Distro" をインストールする方法について説明します。Distro は、アプリケーションとその依存関係全体でトレース、メトリック、ログ、例外を 自動的に収集 します。 OpenTelemetry を使用したデータ収集の詳細については、データ収集の基本に関する記事、または OpenTelemetry に関する FAQ を参照してください。

OpenTelemetry のリリースの状態

OpenTelemetry オファリングは、.NET、Node.js、Python、Java アプリケーションで使用できます。

Language	リリースの状態
ASP.NET Core	⚠️ 2
.NET (エクスポーター)	✅1
Java	✅1
Node.js	✅1
Python	✅1

脚注

• ✅ 1: OpenTelemetry は、正式なサポートを受けるすべてのお客様が利用できます。
• ⚠️ 2: OpenTelemetry はパブリック プレビューとして利用できます。 Microsoft Azure プレビューの使用条件に関する補足

注意

機能別のリリースの状態については、「よく寄せられる質問」を参照してください。 ASP.NET Core ディストリビューションでは、GA の前に追加の安定性テストを行っています。 ASP.NET Core アプリケーションで完全にサポートされている OpenTelemetry ソリューションが必要な場合は、.NET エクスポーターを使用できます。

はじめに

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

前提条件

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

ASP.NET Core

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

.NET

• 正式にサポートされているバージョンの .NET Core または .NET Framework (少なくとも .NET Framework 4.6.2) を使用するアプリケーション

Java

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

Node.js

Note

サポート対象外の表のプロパティに依存している場合は、ディストリビューションを使用します。移行ガイドは近日中に提供されます。 そうでない場合は、App Insights shim を使用するのがベータ版でなくなったときの最も簡単な方法です。

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

Python

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

ヒント

OTel Community SDK/API は、依存関係として自動的に読み込まれるため、Azure Monitor OTel ディストリビューションで使用することはお勧めしません。

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

ASP.NET Core

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

dotnet add package --prerelease Azure.Monitor.OpenTelemetry.AspNetCore 

.NET

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

dotnet add package Azure.Monitor.OpenTelemetry.Exporter 

Java

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

警告

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

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

Azure Monitor Application Insights を有効にする

Azure Monitor Application Insights を有効にするには、アプリケーションに若干の変更を加え、「接続文字列」を設定します。接続文字列は、ユーザーに固有の Distro が収集するテレメトリを送信する場所をアプリケーションに通知します。

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

ASP.NET Core

アプリケーション スタートアップに UseAzureMonitor() を追加します。 .NET のバージョンに応じて、これは startup.cs または program.cs クラスのいずれかになります。

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

// Create a new WebApplicationBuilder instance.
var builder = WebApplication.CreateBuilder(args);

// Add the OpenTelemetry NuGet package to the application's services and configure OpenTelemetry to use Azure Monitor.
builder.Services.AddOpenTelemetry().UseAzureMonitor();

// Build the application.
var app = builder.Build();

// Run the application.
app.Run();

.NET

アプリケーション起動時の各 OpenTelemetry シグナルに Azure Monitor エクスポーターを追加します。 .NET のバージョンに応じて、これは startup.cs または program.cs クラスのいずれかになります。

// 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.
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.
var metricsProvider = Sdk.CreateMeterProviderBuilder()
    .AddAzureMonitorMetricExporter();

// Create a new logger factory.
// It is important to keep the LoggerFactory instance active throughout the process lifetime.
var loggerFactory = LoggerFactory.Create(builder =>
{
    builder.AddOpenTelemetry(options =>
    {
        options.AddAzureMonitorLogExporter();
    });
});

Note

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

Java

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

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

ヒント

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

ヒント

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

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 specified connection
# string.
configure_azure_monitor(
    connection_string="<Your Connection String>",
)

# Get a tracer for the current module.
tracer = trace.get_tracer(__name__)

# Start a new span with the name "hello". This also sets this created span as the current span in this context. This span will be exported to Azure Monitor as part of the trace.
with tracer.start_as_current_span("hello"):
    print("Hello, World!")

# Wait for export to take place in the background.
input()

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

ヒント

まだお持ちでない場合、 Application Insights リソースを作成する絶好のタイミングです。 ここでは、新しい Application Insights リソースを作成し、既存のものを使用することをお勧めします。

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

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

環境に接続文字列を貼り付ける

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

A. 環境変数を使用して設定する (推奨)

次のコマンドの <Your Connection String> を、独自の一意の接続文字列に置き換えます。

APPLICATIONINSIGHTS_CONNECTION_STRING=<Your Connection String>

B. 構成ファイルを使用して設定する - Java のみ (推奨)

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

{
  "connectionString": "<Your Connection String>"
}

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

C. コードを使用して設定 - 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」を参照してください。

トラブルシューティング

ASP.NET Core

動作していませんか? ASP.NET Core のトラブルシューティング ページをご確認ください。

.NET

動作していませんか? .NET のトラブルシューティング ページをご確認ください。

Java

動作していませんか? Java のトラブルシューティング ページをご確認ください。

Node.js

動作していませんか? Node.js のトラブルシューティング ページをご確認ください。

Python

動作していませんか? Python のトラブルシューティング ページをご確認ください。

サポート

選択した言語のタブを選択して、サポート オプションを検出します。

ASP.NET Core

• Azure サポートの問題については、Azure サポート チケットを開いてください。
• OpenTelemetry の問題については、OpenTelemetry .NET コミュニティに直接問い合わせてください。
• Azure Monitor Exporter に関連する未解決の問題の一覧については、GitHub のイシュー ページを参照してください。

.NET

• Azure サポートの問題については、Azure サポート チケットを開いてください。
• OpenTelemetry の問題については、OpenTelemetry .NET コミュニティに直接問い合わせてください。
• Azure Monitor Exporter に関連する未解決の問題の一覧については、GitHub のイシュー ページを参照してください。

Java

• Azure サポートの問題については、Azure サポート チケットを開いてください。
• トラブルシューティングの方法は、「トラブルシューティングの手順」をご覧ください。
• OpenTelemetry の問題については、OpenTelemetry コミュニティに直接問い合わせてください。
• Azure Monitor Java Auto-Instrumentation に関連する未解決の問題の一覧については、「GitHub のイシュー ページ」を参照してください。

Node.js

• Azure サポートの問題については、Azure サポート チケットを開いてください。
• OpenTelemetry の問題については、OpenTelemetry JavaScript コミュニティに直接問い合わせてください。
• Azure Monitor Exporter に関連する未解決の問題の一覧については、GitHub のイシュー ページを参照してください。

Python

• Azure サポートの問題については、Azure サポート チケットを開いてください。
• OpenTelemetry の問題については、OpenTelemetry Python コミュニティに直接問い合わせてください。
• Azure Monitor Distro に関連する未解決の問題の一覧については、GitHub のイシュー ページを参照してください。

OpenTelemetry のフィードバック

フィードバックを提供するには:

• OpenTelemetry コミュニティのカスタマー フィードバック アンケートに記入してください。
• Microsoft の OpenTelemetry 早期導入者コミュニティに参加して、お客様自身のことをお知らせください。
• Microsoft Tech Community で他の Azure Monitor ユーザーと交流してください。
• Azure フィードバック フォーラムで機能に関する要求を行ってください。

次のステップ

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 またはブラウザーのユーザー監視を有効にします。

.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 またはブラウザーのユーザー監視を有効にします。

Java

• Azure Monitor OpenTelemetry の追加と変更の詳細については、Azure Monitor OpenTelemetry の追加と変更に関するページを参照してください。
• 「Java の自動インストルメンテーション構成オプション」を確認してください。
• ソース コードを確認するには、「Azure Monitor Java 自動インストルメンテーション GitHub リポジトリ」をご覧ください。
• OpenTelemetry とそのコミュニティの詳細については、OpenTelemetry Java GitHub リポジトリを参照してください。
• 使用エクスペリエンスを有効にするには、Web またはブラウザーのユーザー監視を有効にするをご覧ください。
• GitHub のリリース ノートを表示します。

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 またはブラウザーのユーザー監視を有効にします。

Python

• Azure Monitor OpenTelemetry の追加と変更の詳細については、Azure Monitor OpenTelemetry の追加と変更に関するページを参照してください。
• ソース コードやその他のドキュメントについては、「Azure Monitor Distro GitHub リポジトリ」を参照してください。
• その他のサンプルとユース ケースについては、「Azure Monitor Distro のサンプル」を参照してください。
• GitHub のリリース ノートを表示します。
• PyPI パッケージをインストールしたり、更新プログラムを確認したり、リリース ノートを表示したりするには、Azure Monitor Distro PyPI パッケージのページを参照してください。
• Azure Monitor Application Insights と OpenTelemetry について詳しく知るには、Azure Monitor のサンプル アプリケーションを参照してください。
• OpenTelemetry とそのコミュニティの詳細については、OpenTelemetry Python GitHub リポジトリを参照してください。
• 使用可能な OpenTelemetry インストルメンテーションとコンポーネントを確認するには、「OpenTelemetry Contributor Python GitHub リポジトリ」を参照してください。
• 使用エクスペリエンスを有効にするには、Web またはブラウザーのユーザー監視を有効にします。