Debug の概要

Apigee X のドキュメントを表示中。
Apigee Edge のドキュメントを表示する。

Debug は、Apigee で動作している API プロキシのトラブルシューティングとモニタリングを行うためのツールです。Debug ツールを使用すると、API プロキシのフローの各ステップの詳細を調べることができます。Apigee を使用すると、API プロキシのリクエストとレスポンスのフロー全体のデバッグデータを収集できます。これには、ポリシー実行時に適用されるすべてのリクエストとレスポンスのパラメータが含まれます。この情報は、API プロキシの開発とデプロイでデバッグやトラブルシューティングを行う際に重要になります。

Debug の使用

Debug の使用で説明されているように、UI または API から Debug ツールを使用して、デバッグ セッションの作成と管理を行います。また、Offline Debug の使用で説明されているように、デバッグ セッションをダウンロードして、オフラインで表示と分析を行うこともできます。

Apigee サポートでの Debug の使用

デバッグ セッションをトリガーできるのはお客様だけですが、Apigee のサポートはサポートケースの過程で削除されていない過去のデバッグ セッションにアクセスして、プロキシ固有の問題のトラブルシューティングを行うことができます。

次の点にご注意ください。

  • Apigee サポートには、デバッグ データに対する読み取り専用権限があります。
  • Apigee サポートは、問題に関する情報をキャプチャするためにデバッグを実行するように要求する場合があります。また、サポートがキャプチャしたデバッグを確認できるように、デバッグ セッション ID またはデバッグ セッションへのリンクを提供するように要求する場合があります。保存されたデバッグ セッションは 24 時間しか有効ではないため、デバッグ セッションをダウンロードし、サポートで開いたケースにアタッチしてオフラインで表示できるようにすることをお勧めします。

Apigee ハイブリッド ユーザーの場合

Apigee ハイブリッドを使用している場合は、以降のセクションをご覧ください。

Debug のアーキテクチャ

新しいデバッグ セッションを作成するプロセスを次に示します。

デバッグ セッションの開始リクエストの概要図:
    1.UI または API を使用して、デバッグ セッションの開始リクエストを送信します。2. 管理プレーンが、Pub/Sub モデルを使用してランタイム プレーンにデバッグ セッション作成リクエストを発行します。3. Synchronizer がデバッグ セッション通知に登録され、作成リクエストを Message Processor に送信します。4. MP がデバッグデータを収集し、データ収集 Pod にストリーミングします。5. fluentd が直ちに Pod のファイル システムにデバッグデータを書き込みます。6. UDCA が Pod のデータシステムで新しいデータファイルをポーリングします。7. 新しいデータファイルが検出されると、UDCA が UAP サービスにファイルをアップロードします。8. その後、Apigee ハイブリッド UI や Apigee API などの Apigee サービスを介してデータにアクセスできます。

デバッグデータは管理プレーンに最大で 24 時間保持されます。

前提条件

Apigee ハイブリッドで Debug を使用するには、次の構成を行う必要があります。

サービス アカウント:

  • apigee-synchronizer(ロール: Apigee Synchronizer 管理者)
  • apigee-udca(ロール: Apigee Analytics エージェント)

ハイブリッド v1.3 の詳細については、次のプラットフォームサービス アカウントを作成するをご覧ください。

Synchronizer: