Cloud Logging から消失した Apigee ログのトラブルシューティング

現在、Apigee と Apigee ハイブリッドのドキュメントを表示しています。
このトピックに対応する Apigee Edge のドキュメントはありません。

症状

一般的なユースケースとして、Apigee API ログの Cloud Logging への送信があります。これは通常、MessageLogging ポリシーまたは ServiceCallout ポリシーを使用して行われます。いずれの場合も、Apigee では Cloud Logging API を使用してログを書き込みます。

場合によっては、Cloud Logging に Apigee API のログが表示されないことがあります。

エラーメッセージ

エラーメッセージは表示されません。

考えられる原因

原因	説明	トラブルシューティング手順の適用対象
Cloud Logging API が有効になっていない	Apigee 組織の Google Cloud プロジェクトで Cloud Logging API が有効になっていることを確認します。	Apigee と Apigee ハイブリッド
プロキシサービスアカウントが正しく構成されていない	デプロイ時（Apigee）またはランタイム構成（Apigee ハイブリッド）で使用されるサービスアカウントが削除されたか、正しく構成されていない可能性があります。	Apigee と Apigee ハイブリッド
ポリシー構成のプロジェクト名が正しくない	ポリシー構成のプロジェクト名が、Apigee 組織に関連付けられているプロジェクト名と同じではありません。	Apigee と Apigee ハイブリッド
ランタイムサービスアカウントにロールまたは権限がない	Apigee ハイブリッドの場合は、ランタイムサービスアカウントにサービスアカウントトークン作成者のロールがあることを確認します。これは Google 認証を使用するために必要です。	Apigee ハイブリッド
ログエントリのサイズが Cloud Logging の上限を超過	Cloud Logging のエントリサイズは 256 KB に制限されています。この上限は変更できません。	Apigee と Apigee ハイブリッド

原因: Cloud Logging API が有効になっていない

診断

Cloud Logging API が有効になっていることを確認します。Google Cloud コンソールで有効な API とサービスを一覧表示する方法については、有効なサービスを一覧表示するをご覧ください。

解決策

Cloud Logging API が有効になっていない場合は、サービスの有効化の手順で有効にします。API が有効になるまで数分かかることがあります。

Cloud Logging API が有効になっていないために Cloud Logging でログが表示されない問題を解決できない場合は、診断情報の収集が必要な場合をご覧ください。

原因: プロキシサービスアカウントが正しく構成されていない

診断

Apigee

サービスアカウント名を見つける。

Apigee UI を使用する。
1. [Develop] > [API Proxies] をクリックし、プロキシ名をクリックする。例: TurboBooks
2. [Deployments] に、[Service Account] の名前が表示される。

Apigee API の使用:

次の Apigee API 呼び出しを発行します。

curl -H "Authorization: Bearer $(gcloud auth print-access-token)" "https://apigee.googleapis.com/v1/organizations/ORG_NAME/environments/ENV_NAME/apis/PROXY_NAME/revisions/REVISION_NUMBER/deployments"

次のように置き換えます。

ORG_NAME: 組織の名前。例: apigee-example-org
ENV_NAME: 環境の名前。例: myenv
PROXY_NAME: プロキシの名前。例: TurboBooks
REVISION_NUMBER: リビジョン番号。例: 4

次に例を示します。

curl -H "Authorization: Bearer $(gcloud auth print-access-token)" "https://apigee.googleapis.com/v1/organizations/apigee-example-org/environments/myenv/apis/TurboBooks/revisions/4/deployments"

次のようなバージョン名が返されます。

{
  "environment": "myenv",
  "apiProxy": "TurboBooks",
  "revision": "4",
  "deployStartTime": "1687408163394",
  "state": "READY",
  "instances": [
    {
      "instance": "apiginstance",
      "deployedRevisions": [
        {
          "revision": "4",
          "percentage": 100
        }
    .
    .
    .
    .
  "serviceAccount": "projects/-/serviceAccounts/envsa-79@apigee-example-org.iam.gserviceaccount.com"
}

ここで、serviceAccount は API プロキシに関連付けられたサービスアカウントです。

このプロキシサービスアカウントについて、以下を確認します。
1. このサービスアカウントは、Apigee 組織の作成に使用したものと同じ Google Cloud プロジェクトに属している必要があります。例: apigee-example-org.
2. プロキシをデプロイするユーザーには、このサービスアカウントに対する iam.serviceAccounts.actAs 権限が付与されています。
  - ロールのリストについては、サービスアカウントのロールをご覧ください。
  - 特定のユーザーのロールを表示する方法については、現在のアクセス権を表示するをご覧ください。
3. プロキシサービスアカウントには、Cloud Logging サービスを呼び出すために必要な権限が付与されます。
  - ロールのリストについては、Logging のロールをご覧ください。
  - プロキシサービスアカウントの権限を表示する方法については、現在のアクセス権を表示するをご覧ください。

Apigee ハイブリッド

Apigee ハイブリッドでは、Apigee に記載された手順に加えて、overrides.yaml ファイルを開いて、各環境で Google 認証に必要なサービスアカウントが指定されていることを確認します。次に例を示します。

envs:
  - name: "ENVIRONMENT_NAME"
    serviceAccountPaths:
      runtime: "KEY_FILE_PATH"

次のように置き換えます。

ENVIRONMENT_NAME: 環境の名前。例: myenv
KEY_FILE_PATH: ランタイムサービスアカウントキーファイルのパス。通常は、インストール時のサービスアカウントを作成するでサービスアカウントを作成しています。

解決策

サービスアカウントが Apigee 組織の作成に使用した Google Cloud プロジェクトにない場合は、同じ Google Cloud プロジェクトでサービスアカウントを作成して使用する必要があります。これは Google 認証の使用でも説明されています。
プロキシをデプロイするユーザーに、このサービスアカウントに対する iam.serviceAccounts.actAs 権限が付与されていない場合は、単一のロールを付与するをご覧ください。
プロキシサービスアカウントに Cloud Logging サービスの呼び出しに必要な権限がない場合は、単一のロールを付与するをご覧ください。

このドキュメントの手順で、Apigee と Apigee ハイブリッドのプロキシサービスアカウントが正しく構成されないという問題が解決されない場合は、診断情報の収集が必要な場合をご覧ください。

ポリシー構成のプロジェクト名が正しくない

診断

MessageLogging ポリシーを使用して、Cloud Logging にログを送信する場合:

Apigee UI で、[Develop] > [API Proxies] > [API proxy name] > [Develop] タブをクリックします。
[Code] ペインで、<CloudLogging> 要素を見つけます。
<LogName> の値が正しいプロジェクト名であることを確認します。
```
<CloudLogging>
  <LogName>projects/PROJECT_ID/logs/LOG_ID</LogName>
</CloudLogging>
```
次のように置き換えます。
- PROJECT_ID: Google Cloud プロジェクト ID。例: apigee-example-org
- LOG_ID: Cloud Logging のログ ID。例: apigee-logs

解決策

<LogName> 要素の値が正しい値でない場合は、正しい値に更新します。

このドキュメントの手順で問題が解決しない場合は、診断情報の収集が必要な場合をご覧ください。

原因: ランタイムサービスアカウントにロール / 権限がない

診断

ランタイムがプロキシサービスアカウントの権限を借用できることを確認します。

次の gcloud コマンドを実行して、ランタイムサービスアカウントにプロキシサービスアカウントに対する iam.serviceAccountTokenCreator ロールがあるかどうかを確認します。

gcloud iam service-accounts get-iam-policy PROXY_SA_NAME@PROJECT_ID.iam.gserviceaccount.com

次のように置き換えます。

PROXY_SA_NAME: プロキシサービスアカウントの名前。例: envsa-79
PROJECT_ID: Google Cloud プロジェクト ID。例: apigee-example-org

次のようなバージョン名が返されます。

- members:
  - serviceAccount:RUNTIME_SA_NAME@PROJECT_ID.iam.gserviceaccount.com
  role: roles/iam.serviceAccountTokenCreator

次のように置き換えます。

RUNTIME_SA_NAME: ランタイムサービスアカウントの ID。例: apigee-runtime

次に例を示します。

gcloud iam service-accounts get-iam-policy envsa-79@apigee-example-org.iam.gserviceaccount.com
  bindings:
  - members:
    - user:222larabrown@gmail.com
    role: roles/iam.serviceAccountAdmin
  - members:
    - serviceAccount:apigee-runtime@apigee-example-org.iam.gserviceaccount.com
    role: roles/iam.serviceAccountTokenCreator
  - members:
    - user:222larabrown@gmail.com
    role: roles/iam.serviceAccountUser
  etag: BwX-shcrL3o=
  version: 1

出力に iam.serviceAccountTokenCreator ロールと想定されたメンバーが表示されない場合は、解決策の手順に沿って正しいロールを付与します。

解決策

次の gcloud コマンドを実行して、ランタイムサービスアカウントにプロキシサービスアカウントの iam.serviceAccountTokenCreator ロールを付与します。

gcloud iam service-accounts add-iam-policy-binding \
PROXY_SA_NAME@PROJECT_ID.iam.gserviceaccount.com \
--member=serviceAccount:RUNTIME_SA_NAME@PROJECT_ID.iam.gserviceaccount.com \
--role=roles/iam.serviceAccountTokenCreator

次のように置き換えます。

PROXY_SA_NAME: プロキシサービスアカウントの名前。例: envsa-79
PROJECT_ID: Google Cloud プロジェクト ID。例: apigee-example-org
RUNTIME_SA_NAME: ランタイムサービスアカウントの ID。例: apigee-runtime

このドキュメントの手順で問題が解決しない場合は、診断情報の収集が必要な場合をご覧ください。

原因: ログエントリのサイズが、ロギングで許可された上限を超えている

診断

このドキュメントで説明されている他の原因に問題がないことを確認した後、Cloud Logging で一部のログが表示されない場合、Apigee から送信されるログエントリのサイズが、Cloud Logging のログサイズエントリのハードリミットである 256 KB を超えている可能性があります。詳細については、Logging の使用量上限をご覧ください。

解決策

これは Cloud Logging で設定された構成不能な上限であり、現時点でわかっている唯一の回避策は、Apigee から送信されたログエントリのサイズを 256 KB 未満に保つことです。この上限を超える可能性があるペイロードをログしている場合は、このペイロードをログに記録しないか、上限に達すると一部のトランザクションがログに記録されないことを理解してください。

このドキュメントの手順で問題が解決しない場合は、診断情報の収集が必要な場合をご覧ください。

診断情報の収集が必要な場合

上記の手順でも問題が解決しない場合は、次の診断情報を収集して Google Cloud カスタマーケアに連絡してください。

Apigee 組織
問題が生じている環境と API プロキシ。
ダウンロードしたデバッグセッション（ここで上記のすべての情報が提供されます）。
Cloud Logging にログを送信する API プロキシ内の特定のポリシー名。
Apigee ハイブリッドの場合: overrides.yaml ファイル。

Cloud Logging から消失した Apigee ログのトラブルシューティング

症状

エラー メッセージ

考えられる原因

原因: Cloud Logging API が有効になっていない

診断

解決策

原因: プロキシ サービス アカウントが正しく構成されていない

診断

Apigee

Apigee ハイブリッド

解決策

ポリシー構成のプロジェクト名が正しくない

診断

解決策

原因: ランタイム サービス アカウントにロール / 権限がない

診断

解決策

原因: ログエントリのサイズが、ロギングで許可された上限を超えている

診断

解決策

診断情報の収集が必要な場合

エラーメッセージ

原因: プロキシサービスアカウントが正しく構成されていない

原因: ランタイムサービスアカウントにロール / 権限がない