Azure Functions での実行の監視
Azure Functions には、関数の実行を監視する Azure Application Insights との統合機能が組み込まれています。 この記事では、Azure Functions を監視するために Azure によって提供されている監視機能の概要について説明します。
Application Insights を使用すると、ログ、パフォーマンス、およびエラー データを収集できます。 パフォーマンスの異常が自動的に検出されるほか、強力な分析ツールが特徴となっていて、より簡単に、問題を診断したり、関数がどのように使用されているかを理解したりすることができます。 これらのツールは、お使いの関数のパフォーマンスと使いやすさの継続的改善に役立つように設計されています。 ローカル関数アプリ プロジェクトの開発中に Application Insights を使用することもできます。 詳細については、「Application Insights とは何か」を参照してください。
Application Insights インストルメンテーションは Azure Functions に組み込まれているため、Function App を Application Insights リソースに接続するためには、有効なインストルメンテーション キーが必要です。 インストルメンテーション キーは、Azure 内にFunction App のリソースを作成するときに、アプリケーション設定に追加されます。 Function App にまだこのキーがない場合は、手動で設定できます。
また、Azure Monitor を使用して関数アプリ自体を監視することもできます。 詳細は、「Azure Monitor を使用した Azure Functions の監視」をご覧ください。
Application Insights の価格と制限
Azure Functions との Application Insights の統合は、無料で試すことができます。これは、1 日に無料で処理されるデータ量に制限があることが特徴となっています。
開発中に Application Insights を有効にする場合は、テスト中にこの制限に達する可能性があります。 1 日あたりの上限に近づいた場合は、ポータルと電子メール通知でお知らせします。 これらのアラートに気が付かず、上限に達してしまった場合は、新しいログが Application Insights クエリに表示されません。 不要なトラブルシューティングに時間を費やさずにすむように、上限には気を付けてください。 詳細については、「Application Insights の課金」をご覧ください。
重要
Application Insights には、負荷がピークのときに、完了した実行に関して利用統計情報が生成されすぎないようにするサンプリング機能があります。 サンプリングは、既定で有効になっています。 データがないと思われる場合は、特定の監視シナリオに合わせてサンプリング設定を調整するだけで済みます。 詳細については、「サンプリングを構成する」を参照してください。
Application Insights の統合
一般に、Function App を作成するときに Application Insights インスタンスを作成します。 この場合、統合に必要なインストルメンテーション キーは、APPINSIGHTS_INSTRUMENTATIONKEY という名前のアプリケーション設定として既に設定されています。 何らかの理由でFunction App にインストルメンテーション キーが設定されていない場合は、Application Insights の統合を有効にする必要があります。
重要
Azure Government などのソブリン クラウドでは、インストルメンテーション キーではなく、Application Insights 接続文字列 (APPLICATIONINSIGHTS_CONNECTION_STRING) を使用する必要があります。 詳細については、「APPLICATIONINSIGHTS_CONNECTION_STRING」リファレンスを参照してください。
次の表は、関数アプリの監視に使用できる Application Insights のサポートされている機能の詳細を示しています。
| Azure Functions ランタイム バージョン | 1.x | 2.x 以降 |
|---|---|---|
| 自動収集の対象 | ||
| • 要求 | ✓ | ✓ |
| • 例外 | ✓ | ✓ |
| • パフォーマンス カウンター | ✓ | ✓ |
| • 依存関係 | ||
| — HTTP | ✓ | |
| — Service Bus | ✓ | |
| — Event Hubs | ✓ | |
| — SQL* | ✓ | |
| サポートされる機能 | ||
| • QuickPulse/LiveMetrics | はい | はい |
| — セキュリティで保護されたコントロール チャネル | はい | |
| • サンプリング | はい | はい |
| • ハートビート | はい | |
| 相関関係 | ||
| • Service Bus | はい | |
| • Event Hubs | はい | |
| 構成可否 | ||
| •完全に構成可能 | はい |
* SQL クエリ文字列テキストのコレクションを有効にするには、「SQL クエリコレクションを有効にする」を参照してください。
利用統計情報の収集
Application Insights の統合が有効になっていると、利用統計情報は、接続されている Application Insights インスタンスに送信されます。 このデータには、Functions ホストによって生成されたログ、関数コードから書き込まれたトレース、およびパフォーマンス データが含まれています。
Note
関数と Functions ホストからのデータに加えて、Functions スケール コントローラーからデータを収集することもできます。
ログのレベルとカテゴリ
アプリケーション コードからのトレースを記述するときには、トレースにログ レベルを割り当てる必要があります。 ログ レベルにより、トレースから収集されるデータの量を制限する手段が得られます。
"ログ レベル" がすべてのログに割り当てられます。 値は、相対的な重要度を示す整数です。
| LogLevel | コード | 説明 |
|---|---|---|
| Trace | 0 | 最も詳細なメッセージを含むログ。 これらのメッセージには、機密性の高いアプリケーション データが含まれる場合があります。 これらのメッセージは既定で無効になっているため、運用環境では有効にしないでください。 |
| デバッグ | 1 | 開発時に対話型調査に使用されるログ。 これらのログには、主にデバッグに役立つ情報が含まれており、長期的な値は含まれていません。 |
| Information | 2 | アプリケーションの一般的なフローを追跡するログ。 これらのログには長期的な値を含める必要があります。 |
| 警告 | 3 | アプリケーション フロー内の異常なイベントまたは予期しないイベントを強調するが、それ以外ではアプリケーションの実行を停止することはないログ。 |
| エラー | 4 | エラーが発生したために現在の実行フローが停止したことを強調するログ。 これらのエラーは、アプリケーション全体の障害ではなく、現在のアクティビティの失敗を示している必要があります。 |
| Critical | 5 | 回復不可能なアプリケーションまたはシステムのクラッシュや、早急に対処する必要がある重大な障害について説明するログ。 |
| なし | 6 | 指定したカテゴリのログ記録を無効にします。 |
host.json ファイルの構成により、関数アプリから Application Insights に送信されるログの量が決まります。
ログ レベルの詳細については、「ログ レベルを構成する」を参照してください。
ログに記録された項目をカテゴリに割り当てることで、Function App 内の特定のソースから生成されるテレメトリをより詳細に制御できます。 カテゴリを使用すると、収集されたデータに対する分析を実行しやすくなります。 関数コードから書き込まれるトレースは、関数名に基づいて個々のカテゴリに割り当てられます。 カテゴリの詳細については、「カテゴリを構成する」を参照してください。
カスタム利用統計情報
C#、JavaScript、および Python では、Application Insights SDK を使用してカスタム利用統計情報を書き込むことができます。
依存関係
Functions のバージョン 2.x 以降では、特定のクライアント SDK を使用するバインディングの依存関係に関するデータが、Application Insights によって自動的に収集されます。 分離ワーカー プロセスで実行されている C# アプリでは、Application Insights の分散トレースと依存関係の追跡は現在サポートされていません。 Application Insights では、以下の依存関係に関するデータを収集します。
- Azure Cosmos DB
- Azure Event Hubs
- Azure Service Bus
- Azure Storage サービス (Blob、Queue、Table)
SqlClient を使用する HTTP 要求とデータベース呼び出しもキャプチャされます。 Application Insights によってサポートされる依存関係の完全な一覧については、自動追跡される依存関係に関するページを参照してください。
Application Insights では、収集された依存関係データの "アプリケーション マップ" が生成されます。 次に、Queue storage の出力バインドがある HTTP トリガー関数のアプリケーション マップの例を示します。
依存関係は、Information レベルで記述されます。 Warning 以上でフィルター処理すると、依存関係データは表示されなくなります。 また、依存関係の自動収集は、非ユーザー スコープで行われます。 依存関係データをキャプチャするには、ホストで、レベルが少なくともユーザー スコープ (Function.<YOUR_FUNCTION_NAME>.User) 外部の Information に設定されているようにします。
依存関係データの自動収集に加えて、言語固有の Application Insights SDK の 1 つを使用して、カスタム依存関係情報をログに書き込むこともできます。 カスタム依存関係を記述する方法の例については、次の言語固有の例のいずれかを参照してください。
パフォーマンス カウンター
Linux で実行する場合、パフォーマンス カウンターの自動収集はサポートされません。
ログへの書き込み
ログに書き込む方法と、使用する API は、Function App プロジェクトの言語によって異なります。
関数からのログの書き込みの詳細については、お使いの言語の開発者ガイドを参照してください。
データを分析する
既定では、関数アプリから収集されたデータは、Application Insights に格納されます。 Azure portal では、Application Insights によって、テレメトリ データの広範囲にわたるセットの視覚化が提供されます。 エラー ログ、クエリ イベント、メトリックの詳細を表示できます。 収集したデータを表示してクエリを実行する方法の基本的な例など、詳細については、「Application Insights で Azure Functions のテレメトリを分析する」を参照してください。
ストリーミング ログ
アプリケーションの開発中、Azure 内での実行時にログに書き込まれている内容をほぼリアルタイムで確認する必要が生じることがよくあります。
関数の実行によって生成中のログ データのストリームを表示する方法は 2 つあります。
組み込みのログ ストリーミング: App Service プラットフォームでは、アプリケーション ログ ファイルのストリームを表示できます。 このストリームは、ローカル開発中に関数をデバッグするときや、ポータルで [テスト] タブを使用するときに表示される出力と同等です。 すべてのログベース情報が表示されます。 詳しくは、ログのストリーミングに関する記事をご覧ください。 このストリーミング方法でサポートされるインスタンスは 1 つだけです。従量課金プランの Linux 上で実行されているアプリでは、この方法を使用できません。
Live Metrics Stream: Function App が Application Insights に接続されているときには、Live Metrics Stream を使用して、Azure portal でログ データやその他のメトリックをほぼリアルタイムで表示できます。 この方法は、複数のインスタンス上または従量課金プランの Linux 上で実行されている関数を監視する場合に使用します。 このメソッドでは、サンプリングされたデータが使用されます。
ログ ストリームは、ポータル内とほとんどのローカル開発環境内の両方で表示できます。 ログ ストリームを有効にする方法については、「Azure Functions でストリーミング実行ログを有効にする」を参照してください。
診断ログ
Application Insights を使用すると、利用統計情報を長期的ストレージまたはその他の分析サービスにエクスポートできます。
関数も Azure Monitor と統合されるため、診断設定を使用しても、Azure Monitor ログを含むさまざまな送信先に利用統計情報を送信できます。 詳細については、「Azure Monitor ログを使用した Azure Functions の監視」を参照してください。
スケール コントローラー ログ
Azure Functions スケール コントローラーは、アプリが実行されている Azure Functions ホストのインスタンスを監視します。 このコントローラーは、現在のパフォーマンスに基づいて、インスタンスを追加または削除するタイミングを決定します。 スケール コントローラーから Application Insights にログを出力させることで、Function App のためにスケール コントローラーで下されている決定をより詳細に理解できます。 生成されたログを、別のサービスによる分析のために BLOB ストレージに格納することもできます。
この機能を有効にするには、SCALE_CONTROLLER_LOGGING_ENABLED という名前のアプリケーション設定を、ご利用の関数アプリの設定に追加します。 詳細については、「スケール コントローラー ログを構成する」を参照してください。
Azure Monitor のメトリック
Application Insights によって収集されるログベースの利用統計情報に加えて、Azure Monitor メトリックから、関数アプリがどのように実行されているかに関するデータも取得できます。 詳細は、「Azure Monitor を使用した監視」をご覧ください。
レポートに関する問題
Functions での Application Insights 統合に関する問題をレポートしたり、提案や要求を行ったりするには、GitHub で問題を作成します。
次のステップ
詳細については、次のリソースを参照してください。