このページは Apigee と Apigee ハイブリッドに適用されます。
Apigee Edge のドキュメントを表示する。
Debug は、Apigee で動作している API プロキシのトラブルシューティングとモニタリングを行うためのツールです。Debug ツールを使用すると、API プロキシのフローの各ステップの詳細を調べることができます。Apigee を使用すると、API プロキシのリクエストとレスポンスのフロー全体のデバッグデータを収集できます。これには、ポリシー実行時に適用されるすべてのリクエストとレスポンスのパラメータが含まれます。この情報は、API プロキシの開発とデプロイでデバッグやトラブルシューティングを行う際に重要になります。
データの収集と送信をデバッグする
Apigee ゲートウェイ ノードは、デバッグ セッション データを収集して、内部でキャッシュに保存してから、そのデータを Cloud のコントロール プレーンに送信します。そこから、オペレーターが分析できるように、デバッグ セッション UI と共有されます。
デバッグ マスキングを使用する場合、Apigee はデバッグデータをコントロール プレーンに送信する前に、ゲートウェイ ノードでマスキングを実行します。
Debug の使用
Debug の使用で説明されているように、UI または API から Debug ツールを使用して、デバッグ セッションの作成と管理を行います。また、Offline Debug の使用で説明されているように、デバッグ セッションをダウンロードして、オフラインで表示と分析を行うこともできます。
Apigee サポートでの Debug の使用
デバッグ セッションをトリガーできるのはお客様だけですが、Apigee サポートがサポートケースの過程で削除されていない過去のデバッグ セッションにアクセスして、プロキシ固有の問題のトラブルシューティングを行う場合があります。
次の点にご注意ください。
- Apigee サポートには、デバッグデータに対して読み取り専用権限があります。
- Apigee サポートは、問題に関する情報をキャプチャするため、お客様にデバッグの実行を依頼する場合があります。また、キャプチャしたデバッグ情報を確認するため、お客様にデバッグ セッション ID またはデバッグ セッションへのリンクの提供を求める場合があります。保存されたデバッグ セッションの有効期間は 24 時間です。デバッグ セッションをダウンロードして、サポートで登録したケースに関連付けてオフラインで参照できるようにすることをおすすめします。
Apigee ハイブリッド ユーザーの場合
Apigee ハイブリッドを使用している場合は、以降のセクションをご覧ください。
Debug のアーキテクチャ
新しいデバッグ セッションを作成するプロセスを次に示します。
デバッグデータは管理プレーンに最大で 24 時間保持されます。
Apigee ハイブリッドの要件
このセクションでは、Apigee ハイブリッド ユーザー向けの重要な情報を示します。
データ所在地のサポート
- 新しく作成した Apigee ハイブリッド v1.13.1 組織でデータ所在地が有効になっている場合は、Apigee ハイブリッドでのデータ所在地の使用の手順に沿って操作します。
- すべての Synchronizer ノードの時計が UTC に設定されて同期されている必要があります。
以前のバージョンの Apigee ハイブリッドでは、データ所在地がサポートされていません。
その他の要件
apigee-udca
サービス アカウントが構成されている必要があります。構成のオーバーライドを指定するをご覧ください。- すべての Synchronizer ノードの時計が UTC に設定されて同期されている必要があります。