このページは Apigee と Apigee ハイブリッドに適用されます。
Apigee Edge ドキュメントを表示する
Advanced API Security の通知を使用すると、セキュリティ スコアの変更や API の不正使用の検出インシデントなどの API セキュリティに関連するイベントに対してアラートを作成できます。アラートは、Cloud Monitoring を使用して作成します。アラートがトリガーされると、テキスト、メール、その他のチャネルで通知を送信するようにアラートを構成できます。アラートの作成の詳細については、指標しきい値のアラート ポリシーを作成するをご覧ください。
必要なロール
Cloud Monitoring でアラートと通知チャンネルを設定するには、次のロールが割り当てられている必要があります。
roles/monitoring.alertPolicyEditor
roles/monitoring.notificationChannelEditor
制限事項
アラートには次の制限が適用されます。
- アラート ポリシーの最大数は、すべての Apigee サブスクリプション レベルで 500 です。
- 指標データは 6 週間保存されます。
- 指標しきい値条件で評価される最大期間は 23 時間 30 分です。
- アラートのトリガーとなるイベントが発生してから、アラートが作成されて通知が送信されるまでに、最大 4 分かかることがあります。
アラートの上限の一覧については、アラートの上限をご覧ください。
次のセクションでは、アラートの作成方法を示す例を紹介します。
例: プロキシ セキュリティ スコアが低下した場合のアラートを作成する
この例では、プロキシ セキュリティ スコアが指定されたしきい値を下回った場合にアラートを作成します。アラートを作成する手順は以下のとおりです。
Google Cloud コンソールで [アラート ポリシーを作成] ページを開きます。
- [指標を選択] をクリックします。
- [アクティブなリソースと指標のみを表示] をオフにします。
注: 組織に最近の API トラフィック データが存在しない場合は、このオプションを選択しない限り、次のステップの指標は表示されません。
- 次のように指標を選択します。
- [Apigee API Security Profile Environment Association] を選択します。
- 右側に表示されたペインで [セキュリティ] を選択します。
- 右側の次のペインで、[Security score of Apigee API proxy] を選択します。
- [適用] をクリックします。
- (省略可)アラートのデータを(指定された環境などに)制限するには、次のようにフィルタを作成します。
- [フィルタの追加] > [新しいフィルタ] で [フィルタ] フィールドをクリックし、フィルタリングするリソースラベル(env など)を選択します。
- [コンパレータ] フィールドで比較演算子(= など)を選択します。
- [値] フィールドで、リソースラベル(環境名など)の値を選択します。
このフィルタでは、フィルタ条件に合格したデータによってのみアラートがトリガーされます。使用可能なフィルタのリストについては、フィルタをご覧ください。
- [Transform data] の [ローリング ウィンドウ関数] フィールドで、[合計] を選択します。
- [次へ] をクリックします。
- [Configure alert trigger] ペインで、次のように設定します。
- [組合せ条件タイプ] で [しきい値] を選択します。
- [Alert trigger] で [任意の時系列の違反] を選択します。
- [しきい値の位置] で [しきい値を下回っています] を選択します。
- [しきい値] フィールドに、アラートをトリガーするしきい値(600 など)を入力します。
- [次へ] をクリックします。
- [通知の構成] フィールドで [通知チャンネル] フィールドをクリックして、通知チャンネル(テキスト メッセージ、メールなど)を選択します。チャンネルを構成していない場合は、[Manage Notification Channels] をクリックしてチャネルを追加します。
- [OK] をクリックします。
- [ドキュメント] フィールドに、通知とともに配信するテキスト(アラートをトリガーした内容の説明など)を入力します。たとえば、「セキュリティ スコアが 600 を下回っています」と入力します。
- [Name the alert policy] で、アラート ポリシーの名前を入力します。
- [次へ] をクリックして、アラート ポリシーの詳細を確認します。
- 問題がなければ、[ポリシーを作成] をクリックしてアラート ポリシーを作成します。
例: 検出ルールで検出された不正トラフィックが増加した場合のアラートを作成する
この例では、不正トラフィックが検出されたリクエストの数が、単一の検出ルールに指定されたしきい値を超えた場合にアラートを作成する方法を示します。アラートを作成する手順は以下のとおりです。
Google Cloud コンソールで [アラート ポリシーを作成] ページを開きます。
- [指標を選択] をクリックします。
- [アクティブなリソースと指標のみを表示] をオフにします。
注: 組織に最近の API トラフィック データが存在しない場合は、このオプションを選択しない限り、次のステップの指標は表示されません。
- 次のように指標を選択します。
- [Apigee API Security Detection Rule] を選択します。
- 右側に表示されたペインで [セキュリティ] を選択します。
- 右側の次のペインで [Apigee API Security detected request count by rule] を選択します。
- [適用] をクリックします。
- (省略可)アラートのデータを(指定された環境などに)制限するには、次のようにフィルタを作成します。
- [フィルタの追加] > [新しいフィルタ] で [フィルタ] フィールドをクリックし、フィルタリングするリソースラベル(env など)を選択します。
- [コンパレータ] フィールドで比較演算子(= など)を選択します。
- [値] フィールドで、リソースラベル(環境名など)の値を選択します。
このフィルタでは、フィルタ条件を満たすデータ(環境内のデータなど)によってのみアラートがトリガーされます。使用可能なフィルタのリストについては、フィルタをご覧ください。
- [Transform data] の [ローリング ウィンドウ関数] フィールドで、[合計] を選択します。
- [次へ] をクリックします。
- [Configure alert trigger] ペインで、次のように設定します。
- [組合せ条件タイプ] で [しきい値] を選択します。
- [Alert trigger] で [任意の時系列の違反] を選択します。
- [しきい値の位置] で [しきい値より上] を選択します。
- [しきい値] フィールドに、アラートをトリガーするしきい値(100 など)を入力します。
- [次へ] をクリックします。
- [通知の構成] フィールドで [通知チャンネル] フィールドをクリックして、通知チャンネル(テキスト メッセージ、メールなど)を選択します。チャンネルを構成していない場合は、[Manage Notification Channels] をクリックしてチャネルを追加します。
- [OK] をクリックします。
- [ドキュメント] フィールドに、通知とともに配信するテキスト(アラートをトリガーした内容の説明など)を入力します。たとえば、「$(resource.label.env) で 100 を超えて検出された不正トラフィック」と入力します。ここでは、ラベル $(resource.label.env) を使用して、データによってアラートがトリガーされた環境を表示します。
- [Name the alert policy] で、アラート ポリシーの名前を入力します。
- [次へ] をクリックして、アラート ポリシーの詳細を確認します。
- 問題がなければ、[ポリシーを作成] をクリックしてアラート ポリシーを作成します。
セキュリティ通知の指標
次のテーブルに、セキュリティ通知の作成に使用できる指標を示します。
リソース | 指標 | 説明 | サポートされているフィルタ |
---|---|---|---|
Apigee 環境 | Apigee API Security のリクエスト数:apigee.googleapis.com/security/request_count |
最後のサンプル以降、Advanced API Security で処理された API リクエストの数。 | location、org、env、proxy |
Apigee 環境 | Apigee API Security で検出されたリクエスト数:apigee.googleapis.com/security/detected_request_count |
最後のサンプル以降、Advanced API Security の不正検出で検出された API リクエストの数。 | location、org、env、proxy |
Apigee API Security の検出ルール | ルールで検出された Apigee API Security のリクエスト数:apigee.googleapis.com/security/detected_request_count_by_rule |
最後のサンプル以降、Advanced API Security 不正検出によって検出され、検出ルール別にグループ化された API リクエストの数。 | location、org、env、proxy、detection_rule |
Apigee API Security インシデント | Apigee API Security インシデントのリクエスト数:apigee.googleapis.com/security/incident_request_count |
API Security インシデントの一部として検出された API リクエストの数。この値は 1 時間に 1 回測定されます。 | location、org、env、proxy |
Apigee API Security インシデント | 検出ルール別の Apigee API Security インシデント リクエスト数:apigee.googleapis.com/security/incident_request_count_by_rule |
検出ルールでグループ化された API Security インシデントの一部として検出された API リクエストの数。この値は 1 時間に 1 回測定されます。 | location、org、env、Incident_id、detection_rule |
Apigee API Security プロファイル環境の関連付け | Apigee API ソースのセキュリティ スコア:apigee.googleapis.com/security/source_score |
Advanced API Security ソースの評価に基づく Apigee API プロキシの現在のセキュリティ スコア。 この値は、少なくとも 3 時間に 1 回測定されます。 | location、org、env、profile |
Apigee API Security プロファイル環境の関連付け | Apigee API プロキシのセキュリティ スコア:apigee.googleapis.com/security/proxy_score |
Advanced API Security プロキシの評価に基づく Apigee API プロキシの現在のセキュリティ スコア。 この値は、少なくとも 3 時間に 1 回測定されます。 | location、org、env、profile、proxy |
Apigee API Security プロファイル環境の関連付け | Apigee API ターゲットのセキュリティ スコア:apigee.googleapis.com/security/target_score |
Advanced API Security ターゲットの評価に基づく Apigee API プロキシの現在のセキュリティ スコア。 この値は、少なくとも 3 時間に 1 回測定されます。 | location、org、env、profile、target_server |
Apigee API Security プロファイル環境の関連付け | Apigee 環境のセキュリティ スコア:apigee.googleapis.com/security/environment_score |
ソース、プロキシ、ターゲットに対する Advanced API Security の評価に基づく、Apigee 環境の現在のセキュリティ スコアの合計。 この値は、少なくとも 3 時間に 1 回測定されます。 | location、org、env、profile |
フィルタ
フィルタラベル | 説明 |
---|---|
location | リソースのロケーション: 常時グローバル。 |
org | Apigee 組織名 |
env | Apigee 環境名 |
profile | Apigee API Security プロファイル名 |
proxy | Apigee API プロキシ名 |
target_server | Apigee ターゲット サーバー名 |
detection_rule | Apigee API Security 検出ルール名 |