データ API ビルダーで Azure Application Insights を使用する

Azure Application Insights は、要求、トレース、例外、およびパフォーマンス メトリックを自動的にキャプチャするアプリケーション パフォーマンス監視 (APM) サービスです。 データ API ビルダー (DAB) と統合すると、実行時の動作の監視、問題の診断、運用環境でのパフォーマンスの最適化に役立ちます。

[前提条件]

• 既存の DAB 構成ファイル。
• Azure Application Insights リソース。
• Application Insights 接続文字列。
• データ API ビルダー CLI。 CLI をインストールする

接続文字列を取得する

DAB を構成する前に、Azure から Application Insights 接続文字列を取得します。

Azure portal

1. Azure ポータルで Application Insights のリソースを参照します。
2. [ 概要 ] または [プロパティ] に移動します。
3. 接続文字列をコピーします (インストルメンテーション キーではありません)。

Azure CLI

az monitor app-insights component show \
  --app my-app-insights \
  --resource-group my-rg \
  --query connectionString -o tsv

az monitor app-insights component show ^
  --app my-app-insights ^
  --resource-group my-rg ^
  --query connectionString -o tsv

接続文字列の形式

InstrumentationKey=00000000-0000-0000-0000-000000000000;IngestionEndpoint=https://<region>.in.applicationinsights.azure.com/;LiveEndpoint=https://<region>.livediagnostics.monitor.azure.com/

Application Insights の構成

構成ファイルのapplication-insightsの下にruntime.telemetryセクションを追加します。

{
  "runtime": {
    "telemetry": {
      "application-insights": {
        "enabled": true,
        "connection-string": "@env('app-insights-connection-string')"
      }
    }
  }
}

この構成では、接続文字列に環境変数が使用されます。 .env ファイルで定義します。

app-insights-connection-string="InstrumentationKey=...;IngestionEndpoint=...;LiveEndpoint=..."

Command-line

dab add-telemetryを使用して Application Insights を構成します。

Application Insights を有効にする

dab add-telemetry \
  --app-insights-enabled true \
  --app-insights-conn-string "@env('app-insights-connection-string')"

dab add-telemetry ^
  --app-insights-enabled true ^
  --app-insights-conn-string "@env('app-insights-connection-string')"

Application Insights を無効にする

dab add-telemetry \
  --app-insights-enabled false

dab add-telemetry ^
  --app-insights-enabled false

DAB を実行する

構成ファイルを使用して DAB を起動します。

dab start

スタートアップ ログで確認を確認します。

Application Insights telemetry is enabled with connection string from config.

動作方法

Application Insights が有効になっている場合、DAB:

1. AddApplicationInsightsTelemetry()を使用して Application Insights SDK を登録します。
2. DAB 固有のプロパティを使用してすべてのテレメトリをエンリッチするカスタム テレメトリ初期化子を登録します。
3. config から接続文字列を使用して TelemetryClient を構成します。
4. ASP.NET Core ログと統合して、コンソール ログをトレースとしてキャプチャします。

データ フロー

DAB Application
    ↓
ILogger (ASP.NET Core)
    ↓
ApplicationInsightsLoggerProvider
    ↓
AppInsightsTelemetryInitializer (adds custom properties)
    ↓
TelemetryClient
    ↓
Application Insights (Azure)

キャプチャされる内容

テレメトリデータの強化

DAB は、カスタム プロパティを使用して、すべての Application Insights テレメトリを自動的に強化します。

これらのプロパティは、Application Insights で DAB 固有のテレメトリをフィルター処理して関連付けるのに役立ちます。

Azure でテレメトリのクエリを実行する

トレース (ログ)

traces
| where customDimensions["ProductName"] startswith "dab-"
| order by timestamp desc
| project timestamp, message, severityLevel

LogLevel マッピング:

Requests

requests
| where customDimensions["ProductName"] startswith "dab-"
| order by timestamp desc
| project timestamp, name, duration, resultCode, success

Exceptions

exceptions
| where customDimensions["ProductName"] startswith "dab-"
| order by timestamp desc
| project timestamp, type, outerMessage, details

DAB バージョンでフィルターする

traces
| where customDimensions["Component.Version"] == "1.2.3"
| project timestamp, message, severityLevel

低速の GraphQL クエリを検索する

requests
| where name contains "/graphql"
| where duration > 1000
| project timestamp, name, duration, resultCode
| order by duration desc

要求の成功率

requests
| where customDimensions["ProductName"] startswith "dab-"
| summarize 
    Total = count(),
    Success = countif(success == true),
    Failed = countif(success == false)
| extend SuccessRate = (Success * 100.0) / Total

最も低速なデータベース操作

dependencies
| where type == "SQL" or type == "Azure Cosmos DB"
| top 10 by duration desc
| project timestamp, name, duration, target, data

ライブ メトリック

ライブ メトリックは、 < 1 秒の待機時間でリアルタイムの監視を提供します。 Application Insights が構成されると、自動的に有効になります。

ライブ メトリックにアクセスする

1. Azure portal に Application Insights のリソースを開きます。
2. 左側のメニューの [ライブ メトリック] に移動します。
3. DAB アプリケーションを起動します。
4. 数秒でリアルタイム データが表示されます。

あなたが見るもの

サンプリングとデータリテンション

アダプティブ サンプリング

Application Insights SDK は、ボリュームが大きいときにテレメトリを自動的にサンプリングしてコストを削減し、レート制限内に留めます。 サンプリング レートは Application Insights UI に表示されます。

既定の動作:

• 低通信量: すべてのテレメトリが送信される (100%)
• トラフィックが多い: サンプリングによってボリュームが自動的に減少する
• 維持されている代表的なデータ

データの保持

リテンション期間を構成する: Application Insights → 使用状況と推定コスト → データ保有期間。

パフォーマンスに関する考慮事項

テレメトリのオーバーヘッド

Application Insights では、最小限のオーバーヘッドが追加されます。

• メモリ: トラフィックに応じて最大 10 ~ 50 MB
• CPU: <1% (通常の負荷)
• 待機時間: 要求あたりの < 1 ミリ秒 (非同期)

ベスト プラクティス

• 接続文字列には環境変数を使用します。
• 必要でない場合は、ローカル開発で無効にします。
• 運用環境のサンプリング レートを監視します。
• コストを管理するための適切なデータ保有期間を設定します。

開発中に無効にする

{
  "runtime": {
    "telemetry": {
      "application-insights": {
        "enabled": false
      }
    }
  }
}

エクスポートと視覚化

テレメトリは、Application Insights SDK を介してエクスポートされます。 SDK はデータを定期的にバッチ処理して送信します。

接続文字列とインストルメンテーション キー

接続文字列を使用する (推奨)

{
  "connection-string": "InstrumentationKey=...;IngestionEndpoint=https://eastus.in.applicationinsights.azure.com/"
}

メリット:

• リージョン固有のエンドポイント (待機時間の短縮)
• 主権クラウドをサポートします
• 将来に備えて (Microsoft が推奨するアプローチ)

レガシ インストルメンテーション キー

引き続きサポートされていますが、新しい実装には接続文字列をお勧めします。

{
  "connection-string": "InstrumentationKey=00000000-0000-0000-0000-000000000000"
}

トラブルシューティング

エラー: "Application Insights 接続文字列を null または空にすることはできません (有効な場合)

原因: enabled は true に設定されていますが、 connection-string が見つからないか空です。

解決策: Application Insights を有効にするときに有効な接続文字列を指定するか、 enabled を false に設定します。

{
  "runtime": {
    "telemetry": {
      "application-insights": {
        "enabled": true,
        "connection-string": "@env('app-insights-connection-string')"
      }
    }
  }
}

DAB は起動しますが、テレメトリは表示されません

スタートアップ ログで次のメッセージを確認します。

dab start --LogLevel Information

dab start --LogLevel Information

成功メッセージ:

Application Insights telemetry is enabled with connection string from config.

警告メッセージ:

Logs won't be sent to Application Insights because an Application Insights connection string is not available in the runtime config.

Application Insights are disabled.

エラー メッセージ:

Telemetry client is not initialized.

環境変数を確認する

echo $app-insights-connection-string

echo %app-insights-connection-string%

直接接続文字列を使用してテストする

(環境変数ではなく) 直接接続文字列を一時的に使用して、文字列が有効であることを確認します。

{
  "connection-string": "InstrumentationKey=...;IngestionEndpoint=..."
}

これが機能する場合、問題は環境変数の読み込みにあります。

関連コンテンツ

• Azure Log Analytics を使用する
• OpenTelemetry を使用する
• ログの詳細度をカスタマイズする
• Application Insights の概要
• ASP.NET Core 用 Application Insights