appinsights-instrumentation

AppInsights 計装ガイド

このスキルでは、Azure Application Insights を使用してウェブアプリを計装するためのガイダンスと参考資料を提供します。

⛔ コンポーネントを追加しますか？

ユーザーがアプリに App Insights を追加したい場合は、代わりに azure-prepare を呼び出してください。 このスキルが提供するのは参考資料です。実際の変更は azure-prepare が調整します。

このスキルを使用する場面

• ユーザーが計装の方法（ガイダンス、パターン、例）を尋ねている
• ユーザーが SDK のセットアップ手順を必要としている
• azure-prepare が調査フェーズでこのスキルを呼び出している
• ユーザーが App Insights の概念を理解したい

代わりに azure-prepare を使用する場面

• ユーザーが「アプリにテレメトリを追加して」と依頼している
• ユーザーが「App Insights を追加して」と依頼している
• ユーザーがプロジェクトを変更したい
• コンポーネントの変更や追加を求める依頼全般

前提条件

ワークスペース内のアプリは、次のいずれかである必要があります。

• Azure でホストされている ASP.NET Core アプリ
• Azure Container App
• Azure でホストされている Node.js アプリ
• Azure でホストされている Python アプリ

ガイドライン

コンテキスト情報を収集する

ユーザーがテレメトリ対応を追加しようとしているアプリについて、（プログラミング言語、アプリケーションフレームワーク、ホスティング）の組み合わせを確認します。これによって、アプリの計装方法が決まります。ソースコードを読み、妥当な推測を行います。不明な点はユーザーに確認します。アプリのホスティング先（例：個人のコンピューター、コードとして Azure App Service、コンテナーとして Azure App Service、Azure Container App など）は、必ずユーザーに尋ねてください。

可能であれば自動計装を優先する

Azure App Service でホストされている C# ASP.NET Core アプリの場合は、AUTO guide を使用して、アプリを自動計装する方法をユーザーに案内します。

手動で計装する

AppInsights リソースを作成し、アプリのコードを更新して、アプリを手動で計装します。

AppInsights リソースを作成する

環境に合った次のいずれかの方法を使用します。

• 既存の Bicep テンプレートに AppInsights を追加します。追加する内容については、examples/appinsights.bicep を参照してください。ワークスペースに既存の Bicep テンプレートファイルがある場合は、これが最適な方法です。
• Azure CLI を使用します。App Insights リソースを作成するために実行する Azure CLI コマンドについては、scripts/appinsights.ps1 を参照してください。

どちらの方法を選んでも、リソース管理を容易にする、適切なリソースグループに App Insights リソースを作成するようユーザーに推奨してください。有力な候補は、Azure でホストされているアプリのリソースを含む、同じリソースグループです。

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

• ASP.NET Core アプリの場合は、C# コードの変更方法について ASPNETCORE guide を参照してください。
• Node.js アプリの場合は、JavaScript／TypeScript コードの変更方法について NODEJS guide を参照してください。
• Python アプリの場合は、Python コードの変更方法について PYTHON guide を参照してください。

SDK クイックリファレンス

• OpenTelemetry Distro：Python | TypeScript
• OpenTelemetry Exporter：Python | Java

プラットフォーム別ガイド

• Container Apps：可観測性ガイド