Apigee Integration ログ

Apigee Integration では、統合が実行されるたびに実行ログメッセージが生成されます。ログ メッセージには、統合の各ステップのステータスの特定や、失敗した統合、タスク、イベントのトラブルシューティングに役立つ情報が含まれています。

統合の実行ログを表示する

実行ログのページを表示するには、次の手順に沿って操作します。

  1. Google Cloud コンソールで [Application Integration] ページに移動します。

    [Application Integration] に移動

  2. ナビゲーション メニューの [ログ] をクリックします。または、ナビゲーション メニューの [統合] をクリックし、どの統合のログを表示するかを選択します。次に、実行ログのアイコンを示す画像 [View logs locally] をクリックします。実行ログのページが表示されます。
  3. [Region] リストからリージョンを選択して、統合のリージョン固有の実行ログを表示します。refresh [Refresh Logs] をクリックして、現在のログリストを再読み込みすることもできます。

    次の画像は、Apigee Integration の実行ログのページの例を示しています。

    Apigee Integration の実行ログのページを示す画像 Apigee Integration の実行ログのページを示す画像

    実行ログ メッセージごとに次の属性が表示されます。

    • Integration name: 統合の名前。
    • Execution ID: 統合の実行ごとに生成される一意の識別子。
    • Status: 統合実行のステータス。
      • Succeeded: 統合が正常に実行されたことを示します。
      • Failed: 統合の実行が失敗したことを示します。
      • Canceled: 統合実行がユーザーによってキャンセルされたことを示します。
      • On hold: 統合実行が一時停止し、イベントまたはアクションの完了を待機していることを示します。
    • Start time: 統合の実行が開始した時点のタイムスタンプ。
    • Duration: 統合の実行にかかった時間。
    • Integration Version: 実行された統合のバージョン。
    • Trigger ID: トリガーの ID 値。

  4. [Filter] フィールドにフィルタを追加します。統合名、実行 ID、日時の範囲、実行ステータス、変数のタイプ、変数の名前または値などの条件に基づいて、ログをフィルタリングできます。

実行のログを表示する

実行ログのサイズが 300 MB を超えている場合は、Apigee Integration から Response too large error エラーがスローされ、ログは実行ログのページに読み込まれません。その場合は、次の手順で実行のログを表示します。

  1. 実行ログを表示する実行 ID を取得するために、projects.locations.integrations.executions.list メソッドを使用する GET リクエストを作成し、snapshotMetadataWithoutParams パラメータを TRUE に設定します。
    curl -v -X -G GET
        -H "Content-Type: application/json"
        -H "Authorization: Bearer $(gcloud auth print-access-token)"
        -d 'snapshotMetadataWithoutParams=true'
        'https://integrations.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/integrations/INTEGRATION_NAME/executions'
    

    複数の実行 ID がレスポンスで返されます。ログを表示したい実行 ID をコピーします。

  2. その実行 ID の実行ログを取得するために、projects.locations.integrations.executions.list メソッドを使用する POST リクエストを作成し、前のステップでコピーした実行 ID でのフィルタを指定します。
    curl -v -X -G GET
        -H "Content-Type: application/json"
        -H "Authorization: Bearer $(gcloud auth print-access-token)"
        -d 'filter=execution_id="EXECUTION_ID"'
        'https://integrations.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/integrations/INTEGRATION_NAME/executions'
    

    レスポンスの ExecutionDetails フィールドでログの詳細を確認します。

    別の方法として、Google Cloud コンソールで実行ログを実行 ID でフィルタすることもできます。

ログを使用して統合エラーのトラブルシューティングを行う

実行ログ メッセージは、統合実行の失敗時のトラブルシューティングを行う際の重要なリソースになる場合があります。

たとえば、特定の期間内で統合の実行が失敗した場合は、失敗をトラブルシューティングするために、次の手順でログにアクセスし、フィルタします。

  1. [Integrations] リストからトラブルシューティングする統合を検索または選択し、クリックして統合エディタを開きます。
  2. 統合エディタのツールバーで [Logs] をクリックしてログ メッセージを表示します。
  3. [Add a filter] をクリックして、使用可能なフィルタのリストを表示します。
  4. [Integration name] を選択します。
  5. 統合名を入力して [Apply] をクリックします。
  6. [Add a filter] をクリックして、使用可能なフィルタのリストを表示します。
  7. [Execution status] を選択して、ステータス リストを表示します。
  8. [FAILED] チェックボックスをオンにして、[Apply] をクリックすると、失敗した統合が表示されます。
  9. [Add a filter] をクリックして、使用可能なフィルタのリストを表示します。
  10. [Date/time range] を選択し、希望する期間を入力してエラーを確認します。たとえば、次のように入力します。
    • From Date: 2020-12-16 を選択します。
    • From Time: 04:00:00 PM を選択します。
    • To Date: 2019-12-16 を選択します。
    • To Time: 05:00:00 PM を選択します。
    • デフォルトでは、複数のフィルタが AND 条件で結合されています。
    • [Apply] をクリックします。

フィルタリングされた期間内に統合が失敗した場合は、実行ログのページにログ メッセージのリストが表示されます。各ログ メッセージは、特定の統合実行の失敗に対応しています。

ログを使用してスタック トレースの例外を表示する

例外のリストを表示するには、任意のログ メッセージをクリックします。各例外メッセージのリンクをクリックすると、例外の完全なスタック トレースが表示されます。

展開されたログの例外エラーを示す画像 展開されたログの例外エラーを示す画像

ログを使用してコネクタの障害のトラブルシューティングとトレースを行う

実行ログ メッセージを使用すると、失敗したコネクタタスクのトラブルシューティングやトレースを行うことができます。失敗したコネクタタスクのログデータは、Cloud Logging に保存され、ログ エクスプローラで表示できます。

Apigee Integration から失敗したコネクタタスクのログデータにアクセスするには、次の操作を行います。

  1. 目的の統合の実行ログのページに移動します。
  2. 失敗した実行のログ メッセージを開き、失敗したコネクタタスクを含む行にスタック トレースを実行します。
  3. [Status] 列で [Failed] をクリックします。

    失敗したコネクタタスクのログを示す画像 失敗したコネクタタスクのログを示す画像

  4. Apigee Integration では、失敗したコネクタタスクに必要なクエリが自動的に実行され、[ログ エクスプローラ] ページが開き、詳細な実行ログデータが表示されます。

失敗したコネクタタスクのログデータを手動で取得するには、ログ エクスプローラのクエリページで次のクエリを実行します。ログ エクスプローラの使用方法について詳しくは、ログ エクスプローラのインターフェースをご覧ください。

クエリ形式

resource.type="connectors.googleapis.com/Connection"
jsonPayload.integration_connectors_trace_id="EXECUTION_ID_EXECUTION_TASK_ID_EXECUTION_ATTEMPT_NUMBER"

resource.type="connectors.googleapis.com/Connection"
jsonPayload.integration_connectors_trace_id="9db51e4b-7d57-473d-931f-cc27b282dfad_1_2"