このページの内容は Apigee に適用されます。Apigee ハイブリッドには適用されません。
Apigee Edge のドキュメントを表示する
このドキュメントでは、Apigee で使用される Cloud External Key Manager(Cloud EKM)の健全性をモニタリングする方法と、Cloud Logging を使用して Cloud EKM 関連の問題のアラートを構成する方法について説明します。
Apigee は CMEK に Cloud EKM を利用する場合があります。ネットワークの問題により Cloud EKM が使用できなくなった場合、または鍵が無効になっているか、アクセスできない場合、暗号化に依存する Apigee サービスが影響を受ける可能性があります。
Cloud Logging での Cloud EKM の問題のモニタリング
Apigee で Cloud EKM に関する問題(拒否、鍵の無効化、課金の無効化、鍵にアクセスできないなど)が発生すると、Cloud Logging にログエントリが生成されます。これらのログはログ エクスプローラで表示できます。また、このようなイベントの通知を受け取るようにログベースのアラートを構成できます。
ログエントリには、問題が発生している組織とインスタンスの詳細が含まれますが、セキュリティ上の理由から鍵名は省略されています。
ログ エクスプローラで Cloud EKM 関連のログエントリを検索する手順は次のとおりです。
- Google Cloud コンソールの [ログ エクスプローラ] ページに移動します。
- クエリエディタ フィールドに次のクエリを入力し、[クエリを実行] をクリックします。
Apigee EKM key health issue detected
- Cloud EKM の問題が発生した場合、クエリ結果にはイベントの詳細を示すログエントリが表示されます。
Cloud EKM の問題に関するログベースのアラートを構成する
Apigee が Cloud EKM 関連のエラーをログに記録したときに通知されるように、ログベースのアラート ポリシーを作成できます。これらのアラートは、Cloud EKM の問題を事前に特定して対処するのに役立ちます。
Cloud EKM エラー メッセージ文字列に基づいてログベースのアラートを構成するには、Cloud Logging ドキュメントの ログベースのアラート ポリシーを構成するをご覧ください。
アラートを作成するときは、 Cloud Logging で Cloud EKM の問題をモニタリングするで説明されているものと同じクエリフィルタを使用して、特定の Cloud EKM ログエントリを照合します。
アラートの制限と復旧
Cloud EKM のヘルス アラートを構成して対応する際は、次の制限事項に注意してください。
- 繰り返しアラート: 鍵にアクセスできない状態が続くと、Apigee は約 1 時間に 1 回ログエントリを生成します。ログベースのアラートを構成すると、根本的な問題が解決されるまで、この頻度で通知が届きます。
- 復元通知なし: Cloud EKM が再び到達可能になったときに、Apigee はログエントリを生成したり、通知を送信したりしません。ログベースのアラートは、アラート ポリシーの自動クローズ構成に基づいて、Apigee がエラーログ エントリの生成を停止した後に自動的に解決されます。
- 復元の確認: 復元ログエントリは生成されないため、API プロキシのデプロイなど、鍵を必要とするオペレーションを実行して、Cloud EKM に再度アクセスできることを確認します。
トラブルシューティングの制限事項
Apigee のロギングは、Cloud EKM 接続または鍵のステータスに問題があることを示します。ただし、Cloud EKM 自体の詳細なトラブルシューティング(ネットワーク接続の問題や外部鍵マネージャー側の問題の診断など)は、Apigee モニタリングの対象外です。Cloud EKM の問題に関するアラートを受け取った場合は、Cloud EKM サービスの健全性と構成を調査する必要があります。