Azure Functions のログサンプリング

質問

Azure Functions のログが欠落しています。解消方法を教えてください。

回答

Azure Functions では既定でアダプティブ ログサンプリングが有効化 されているため、ログ データが Application Insights へ送られる場合にサンプリングされて送られるためログが欠落する場合があります。これはご利用のプランなどにはよらず、host.json の設定に従います。

サンプリング設定

host.json に設定されている箇所は下記の samplingSettings の isEnabled 項目になります。

{
    "version": "2.0",
    "logging": {
      "applicationInsights": {
        "samplingSettings": {
          "isEnabled": true,
          "excludedTypes": "Request"
        }
      }
    }
}

何をもってサンプリングが発生するかの仕組みについてはアダプティブ サンプリングに解説があります。送信するテレメトリデータの件数と、host.json に設定した MaxTelemetryItemsPerSecond の値によって調整される動作となります。

サンプリング発生時のトラブルシューティング

サンプリングが起きた場合には下記のように一部のログが欠落して Application Insights で確認できます。 今回サンプルで利用したアプリケーションでは、0 から 999 までをカウントしてログに出力しています。operation_Id は 1 回の処理単位を表しますが、operation_Id 1627e2c8572fb4dc334ca8320843ea8d の場合には Current Number: 342 以降のログが出力されておりません。operation_Id 5a495d1e4f1d173ff532943de6e85b7d の場合には Current Number: 473 以前のログが出力されておりません。

また、ログ サンプリングが発生した際には Application Insights に記録されるログの itemCount 列が 1 よりも大きな値を持ちます。itemCount は、そのレコードがもつべきであったログの数を示すためです。Log Analytics での要求に解説があります。前述している Aplication Insights の出力結果を例にすると本来 68 件のログがあったものの、現在確認できている Current Number: 473 のログ 1 件のみが出力されていると判断いただくことができます。この場合、Application Insights に送られなかった 67 件のログを後から確認いただくことはできません。

ログ サンプリングが発生した場合の確認と対処方法

サンプリング発生有無の確認のために、次のクエリを Application Insights で実行いただくとサンプリングの発生有無を参照できます。時間の粒度を調整いただいたり、グラフを描画いただくとより細かい単位でサンプリングのレートが把握できます。サンプリングが動作しているかどうかを把握する

//クエリ例1
union requests,dependencies,pageViews,browserTimings,exceptions,traces
| where timestamp > ago(1d)
| summarize RetainedPercentage = 100/avg(itemCount) by bin(timestamp, 1h), itemType

//クエリ例2
union requests,dependencies,pageViews,browserTimings,exceptions,traces
| where timestamp >= datetime("2023-03-01 07:09")
| summarize RetainedPercentage = 100/avg(itemCount) by bin(timestamp, 1sec), itemType
| render timechart 

クエリ例2 の実行結果では下記のようなグラフが描画されます。request は host.json にて excludedTypes(サンプリングをしない対象) に設定しているためサンプリングされていません。traces はピーク時は全体の約 1% のログのみが記録されていることがわかります。

サンプリング動作の解消のためには host.json にてサンプリングを無効化し、再デプロイを実施いただくもしくは App Service のアプリケーション設定から host.json のオーバーライドをする必要があります。

{
    "version": "2.0",
    "logging": {
      "applicationInsights": {
        "samplingSettings": {
          "isEnabled": false,
          "excludedTypes": "Request"
        }
      }
    }
}

また、現在のサンプリングの設定有無を確認するには、host.json の確認とともに traces テーブルにて起動時のコンフィグレーションを確認いただくこともできます。Azure Functions では、起動時に host.json の読み込みを行い、各種オプションの反映内容のログを出力します。ApplicationInsightsLoggerOptions が対象となっており、黄ハイライト部分は、サンプリングが有効化されていることを表します。SamplingSettings の要素があることが確認でき、host.json でサンプリングを有効化しているのみであれば、既定の値が読み込まれています。緑ハイライト部分は、サンプリングが無効化されいていることを表します。

traces 
| where message startswith "ApplicationInsightsLoggerOptions"
| order by timestamp asc

以上が Azure Functions におけるログ サンプリングの解説となります。Azure Functions を作成したけど、ログが出力されないなどトラブルシューティングにお役に立てば幸いです。

---

2023 年 04 月 24 日時点の内容となります。
本記事の内容は予告なく変更される場合がございますので予めご了承ください。