appinsights-instrumentation

AppInsights のインストルメンテーション

このスキルは、Web アプリのテレメトリデータを Azure App Insights に送信し、アプリの正常性をより適切に可観測にすることを可能にします。

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

ユーザーが自身の Web アプリのテレメトリを有効にしたい場合に、このスキルを使用します。

前提条件

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

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

ガイドライン

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

ユーザーがテレメトリサポートを追加しようとしているアプリケーションの (プログラミング言語、アプリケーションフレームワーク、ホスティング) の組み合わせを特定します。これにより、アプリケーションをどのようにインストルメント化できるかが決まります。ソースコードを読んで、推測してください。不明な点はユーザーに確認してください。アプリケーションがどこでホストされているか (例: 個人のコンピューター上、コードとしての Azure App Service 内、コンテナーとしての Azure App Service 内、Azure Container App 内など) を必ずユーザーに尋ねてください。

可能であれば自動インストルメントを優先する

アプリが Azure App Service でホストされている C# ASP.NET Core アプリの場合は、AUTO ガイド を使用して、ユーザーがアプリを自動インストルメント化できるように支援します。

手動でインストルメントする

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 ガイド を参照してください。
• アプリが Node.js アプリの場合は、JavaScript/TypeScript コードを変更する方法について NODEJS ガイド を参照してください。
• アプリが Python アプリの場合は、Python コードを変更する方法について PYTHON ガイド を参照してください。