接続モードでの Flex Gateway のメッセージログの設定

API Manager の API インスタンスにメッセージログポリシーを適用すると、API Manager 内で Flex Gateway によって管理される API の基本的なログ (インバウンド/アウトバウンドコールおよびヘッダーなど) を表示できます。API インスタンスのログは、メッセージログポリシーを設定して適用した場合にのみ発生します。

API Manager で要求総数、ポリシー違反総数、総エラー数、平均応答時間などのメトリクスを表示するには、「Flex Gateway API の重要なメトリクスの表示」を参照してください。

メッセージログの制限と機能

Unresolved include directive in modules/ROOT/pages/flex-conn-message-log.adoc - include::reuse::partial$billing/pricing.adoc[]

ポリシーを使用して設定された各 API インスタンスでは、基本的なログに次の内容が報告されます。

  • インバウンドおよびアウトバウンド API コール、およびパケットコンテンツ

  • 要求内のヘッダーおよびその他の情報

API Manager でメッセージログを表示するには、次の権限のいずれかが必要です。

  • API Manager Environment Administrator (API Manager 環境システム管理者)

  • API Manager Deploy API Proxies (API Manager API プロキシのデプロイ)

  • General Organization Administration (一般組織のシステム管理者)

Anypoint Platform で使用可能な権限を参照してください。

始める前に

Flex Gateway のメッセージログを設定する前に、次のタスクを完了します。

接続モードでメッセージログを設定する

  1. API Manager の [API Administration (API 管理)] で、API インスタンスの名前を選択します。

  2. [Policies (ポリシー)]​ をクリックします。

  3. [+ Add policy (+ ポリシーを追加)]​ をクリックします。

  4. [Troubleshooting (トラブルシューティング)]​ カテゴリで、​[Message Logging (メッセージログ)]​ をクリックします。

  5. [Next (次へ)]​ をクリックします。

  6. [+ Add (+ 追加)]​ をクリックします。

  7. [Configuration Name (設定名)]​ に名前を入力します (API をコールする前の情報メッセージなど)。

  8. 表示する情報を選択する DataWeave 式を入力します。

    たとえば、​#[attributes.header['id']]​ はメッセージのヘッダーから ID を抽出します。詳細は、Flex Gateway ポリシーでの DataWeave のサポートを参照してください。

  9. ログメッセージを絞り込む場合は、DataWeave 式を入力します。

    たとえば、​#[attributes.headers['id']==1]​ はヘッダーの ID が 1 のログメッセージを表示します。

  10. ログにプレフィックスを付ける場合は、​[Category (カテゴリ)]​ に入力します。

  11. 重要度レベルを入力します。

    入力できるレベルは 1 つのみです。各重要度レベルとレベルの階層の説明については、​「メッセージログの重要度レベル」​を参照してください。

  12. API がコールされた後のメッセージが必要な場合は、​[After Calling API (API のコール後)]​ を選択します。

  13. 設定をさらに追加する場合は、​[+ Add (+ 追加)]​ をクリックします。

  14. [Save (保存)]​ をクリックします。

    その後、API インスタンスの ​[Message Log (メッセージログ)]​ オプションが表示されます。

    検索項目を使用して、時間とログの重要度 (INFO (情報)、ERROR (エラー)、WARN (警告)、DEBUG (デバッグ)) に基づいて特定のログを検索します。これらのログをダウンロードして、さらに分析できます。

メッセージログの重要度レベル

API インスタンスのメッセージログポリシーを設定するときに、重要度レベルを割り当てることができます。ログレポートの各重要度レベルには、特定の情報セットが含まれます。

ログレポートには、選択した重要度レベルと階層の下位のレベルが含まれます。

たとえば、[DEBUG (デバッグ)] を選択した場合、ログレポートには [DEBUG (デバッグ)] 重要度レベルに加えて、[INFO (情報)]、[WARN (警告)]、[ERROR (エラー)] の重要度レベルが含まれます。ただし、[ERROR (エラー)] を選択した場合、ログレポートにはエラーメッセージのみが含まれます。次の表で、各重要度レベルのログに含まれる情報の種別について説明します。

ログの重要度レベル 説明

DEBUG

アプリケーション開発者が使用するトレース情報。

INFO

アプリケーションの進行状況を強調する情報メッセージ。

WARN

潜在的な問題を示す、有害な可能性がある状況。

ERROR

通常のプログラムの実行は妨げられ、アプリケーションの実行は継続できる可能性があるイベント。