アラートの概念の確認

API アラートは、次の問題のいずれかを示すアラームです。

  • API 要求がポリシーに違反している。

  • API で受信した要求が期間内の指定された数を超えている。

  • API が指定された HTTP エラーコードを返す。

  • API 応答時間が一定の時間を超えている。

Runtime Manager のアラートは、API アラートとは性質が異なります。Runtime Manager は、たとえば CPU 使用量、セキュアなデータゲートウェイの稼働/停止、デプロイメントの成功/失敗などにフラグを付けます。一方、API アラートは、API 要求または応答に関連しています。

次のアラートタイプのいずれかを API に追加できます。

  • ポリシー違反

    API を管理する 1 つ以上のポリシーで違反が発生する。

  • 要求数

    ユーザが指定された期間で許可されている回数を超えて API にアクセスを要求する。

  • 応答コード

    API が要求を受信したときに、400、401、403、404、408、500、502、503 のいずれかの HTTP コードを返す。

  • Response Time (応答時間)

    API の応答時間が指定された期間を超えている。

要求数アラートの条件は、レート制限ポリシーを使用するポリシーアラートに似ています。要求数の期間オプションの有効なエントリ範囲は 1 ~ 999999999 です。これらの指定された期間は、データのバーストによって発生する問題を防止するために、絶対時間 (分) 範囲ではなく、スライディングウィンドウとして実装されます。

API Manager で API インスタンスにアラートを追加して、API アラートを作成し、設定します。

アラート通知

API Manager は、条件の状態が良好 (good) から不良 (bad) に、または不良から良好に変化すると、アラートを起動します。条件が同じ状態のままであれば、新しいアラートは起動されません。新規作成されたアラートの初期状態は未定義なので、最初に発生した不良状態を見逃す場合があります。

アラートが起動すると、API Manager はあなたと (設定している場合は) 他のユーザにメール通知を送信します。

アラートを設定するときに、アラートに関するメール通知を受信できるビジネスグループ内のユーザを選択します。通知には、重要度レベルで指定されたようにアラートをトリガするイベントに関する情報が含まれます。ユーザは 2 つのメールを受信します。

  • 1 つは、アラートについて説明するメールです。次に例を示します。

    Your API, CesarDemoAPI - Basic:151 (Environment: "NewOne"), has received greater than 2 requests within 1 consecutive periods of 1 minutes.

  • もう 1 つは、アラートがいつ解決されるかを通知するメールです。

    Your API Version, jsonplaceholderapi - 1.0.development, is no longer in an alert state. The number of policy violations was not greater than 1 in the last 1 consecutive periods of 1 minutes.

アラートが起動した後、API Manager は 2 つの通知メールの最初のセットを送信し、次のアラート期間が始まるまでアラートのリスンを停止します。この方法で反復する通知メールが防止されます。

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub