交通情報を設定

<ph type="x-smartling-placeholder"></ph> 現在、Apigee Edge のドキュメントが表示されています。
Apigee X のドキュメント。 詳細

交通アラートを使用して発生させる 環境、プロキシ、またはリージョンのトラフィックが指定した割合で変化したときの通知 確認できます。

期間を次のように設定します。

  • 1 時間
  • 1 日
  • 7 日
  • 15 日（API のみ）
  • 30 日（API のみ）

アラートは、現在の期間と前の期間のトラフィックを比較することで機能します。 たとえば、1 時間の期間を指定します。このアラートは、直近の 1 時間のトラフィックと これを前の 1 時間のトラフィックに対して実行し、トラフィックの変化率を計算します。

percentChange = ((currentTraffic - previousTraffic) / previousTraffic) * 100

正の値はトラフィックが増加し、負の値はトラフィックが減少したことを意味します。

次に、トラフィック アラートをトリガーするしきい値を API トラフィックの増減率で設定します。 表示されなくなります。

その割合を設定する前に、通常の割合と一致していることを確認してください パターンを認識できます。 たとえば、API トラフィックが 1 日を通して変動し、1 時間ごとのトラフィックが最大 100% 急増するような場合です。 このような急増は正常であり、アラートをトリガーする必要はありません。ただし、 次に、1 時間あたりのトラフィックが 50% 増加したときにトリガーされるようにアラートを構成します。 通常のトラフィックでは不要なアラートが届きます。

アラートの詳細については、アラートと通知を設定するをご覧ください。

交通情報と通知を追加する

交通情報のアラートと通知を追加するには： <ph type="x-smartling-placeholder">
    </ph>
  1. Edge UI で [Analyze] > [Alert Rules] をクリックします。
  2. [+Alert] をクリックします。
  3. アラートに関する次の一般情報を入力します。
    項目 説明
    アラート名 アラートの名前。トリガーを表すわかりやすい名前を付けます。 名前は 128 文字以内で指定してください。
    説明 アラートの説明。
    アラートの種類 [合計トラフィック] を選択します。詳しくは、 詳細については、アラートの種類についてをご覧ください。
    環境 プルダウン リストから環境を選択します。
    ステータス アラートを有効または無効に切り替えます。
  4. アラートをトリガーする条件のしきい値とディメンションを定義します。
    条件フィールド 説明
    しきい値

    トラフィックが増加したとき、または 減少した割合を表します。

    [増加率] の割合を 0% 以上の値に設定します。 [減少率] を 0% 以上の値に設定します。 100%以下とします

    次の間隔を選択できます。

    • 1 時間
    • 1 日
    • 1 週間
    ディメンション

    [+ ディメンションを追加] をクリックして、以下を含む結果を返すディメンションの詳細を指定します。 API プロキシとリージョンです

    特定のディメンションを次のように設定します。

    • Proxy - 特定のプロキシ、または [All] のプロキシに設定します。 Proxy は "Any" の値をサポートしていません。代わりに 目的のプロキシごとに個別のアラートを追加できます。
    • Region - 特定のリージョンまたは [All] のリージョンに設定します。 Region は「Any」の値をサポートしていません。代わりに 関心のある地域ごとにアラートを追加できます
  5. [+ Notification] をクリックして、アラート通知を追加します。
    通知の詳細 説明
    チャネル 使用する通知チャネルを選択し、送信先を指定します（メール、Slack、PagerDuty、または Webhook）。
    発信先 選択したチャネルタイプに基づいて宛先を指定します。 <ph type="x-smartling-placeholder">
      </ph>
    • メール - メールアドレス（joe@company.com など）
    • Slack - Slack チャンネル URL（https://hooks.slack.com/services/T00000000/B00000000/XXXXX など）
    • PagerDuty - PagerDuty コード（abcd1234efgh56789 など）
    • Webhook - Webhook URL（https://apigee.com/test-webhook など）

      注: 通知ごとに指定できる宛先は 1 つのみです。 同じチャネルタイプに複数の送信先を指定するには、通知を追加します。
  6. さらに通知を追加するには、前の手順を繰り返します。
  7. 通知を追加した場合は、以下の項目を設定します。
    項目 説明
    ハンドブック （省略可）推奨される対応に関する簡単な説明を入力する自由形式のテキスト フィールド 解決する方法も説明します社内の Wiki や URL へのリンクも指定できます。 ベスト プラクティスを参照できます。このフィールドの情報は できます。このフィールドの内容は 1,500 文字以内で指定してください。
    Throttle 通知を送信する頻度。プルダウンから値を選択します。
  8. [保存] をクリックします。

[Events] ダッシュボードでアラートを表示する

Edge はアラート条件を検出すると、その条件を自動的に [Events] ダッシュボード。[Events] ダッシュボードに表示されるイベントのリスト 固定アラートと認定アラートの両方を含む

アラートを表示するには:

  1. Edge UI で [分析] > [イベント] をクリックします。新しいイベント ダッシュボードが表示されます。

  2. [Events] ダッシュボードは次の項目でフィルタできます。

    • 環境
    • 地域
    • 期間
  3. イベント ダッシュボードで行を選択して、有効期限が近い証明書を含むキーストアを表示し、 詳しく調査する必要があります[Keystore] ページで新しい証明書をアップロードしたり、既存の証明書を 証明書も作成できます。

トラフィック アラートでアラート API を使用する

交通情報の作成と管理に使用する API のほとんどは、使用する API と同じです。 統合できます。

ただし、一部の API には異常アラートをサポートする次のような追加のプロパティがあります。

交通情報を作成、更新する

同じ API を使用して作成 または更新 作成できます 交通情報アラートを作成または更新するための API 呼び出しの本文は、 以下のように変更します。

  • 次の新しいプロパティを追加して、運行情報であることを指定します。

    "alertType": "runtime"
"alertSubType": "trafficfixed"

    これらのプロパティのデフォルト値は次のとおりです。

    "alertType": "runtime"
"alertSubType": "fixed"
  • conditions 配列の dimensions 要素で、次のようにします。 <ph type="x-smartling-placeholder">
      </ph>
    • org、env、proxy、 および region プロパティ。これらのプロパティのみがサポートされています。 proxy と region を ALL に設定できます。
    • traffic プロパティの値を total に設定する必要があります。

  • conditions 配列内:

    • metrics プロパティの値は trafficChange にする必要があります。
    • comparator プロパティは increasedBy または decreasedBy に設定する必要があります。
    • threshold プロパティには、トラフィックの増減率を示す正の値が含まれます 値 1.0 は 100% を表します。increasedBy の値 0.0（0%）以上である必要があります。decreasedBy の場合、値は次のようにする必要があります。 0.0（0%）以上 1.0（100%）以下です。
    • durationSeconds プロパティは次のいずれかの値に設定する必要があります。 3600（1 時間）、86400（1 日）、604800（7 日）、 1296000（15 日間）、2592000（30 日間）
  • 交通情報アラートでは、reportEnabled プロパティはサポートされていません。
で確認できます。 次の例は、トラフィックの 30% がトラフィックを 組織と環境が 1 時間で 50% 増加したとします。 アラートがトリガーされると、指定された PagerDuty コードに通知が送信されます。 
curl 'https://apimonitoring.enterprise.apigee.com/alerts' \
  -X POST \
  -H 'Accept: application/json, text/plain, */*' -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -d '{
     "organization":"myorg",
     "name":"My Traffic Alert",
     "description":"My traffic alert",
     "environment":"prod",
     "enabled":true,
     "alertType":"runtime",
     "alertSubType":"trafficfixed",
     "conditions":[
     {
        "description":"",
        "dimensions": {
            "org":"nyorg",
            "env":"prod",
            "proxy":"ALL",
            "region":"ALL",
            "traffic":"total"
        },
        "metric": "trafficChange",
        "threshold": 0.5,
        "durationSeconds": 3600,
        "comparator": "increasedBy"
     }
     ],
     "notifications":[{ "channel":"pagerduty", "destination":"abcd1234efgh56789"}],
     "playbook":"http://acme.com/myplaybook.html",
     "throttleIntervalSeconds":3600,
     "reportEnabled":true
}'

次の説明に沿って、$ACCESS_TOKEN を OAuth 2.0 アクセス トークンに設定します。 OAuth 2.0 アクセス トークンを取得します。 この例で使用されている cURL オプションの詳細については、cURL を使用するをご覧ください。

この API の使用の詳細については、イベントを表示するをご覧ください。

交通情報を受け取る

デフォルトでは、Get Alerts API は定義済みのすべてのアラートに関する情報を返します。 この API でクエリ パラメータを取得して、結果をフィルタできるようになりました。

  • enabled - true が有効なアラートのみを返すように指定する場合。デフォルト値は false です。
  • alertType - 返されるアラートの種類を指定します。指定できる値は、runtime、デフォルト、cert です。
  • alertSubType - 返されるアラートのサブタイプを指定します。 デフォルト値は未設定です。つまり、すべてのアラート サブタイプが返されます。

たとえば、次の API 呼び出しを使用して、myorg という名前の組織の有効化アラートのみを返します。

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
'https://apimonitoring.enterprise.apigee.com/alerts?org=myorg&enabled=true'

次の呼び出しでは、有効と無効の両方の交通情報のみが返されます。

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
'https://apimonitoring.enterprise.apigee.com/alerts?org=myorg&alertType=runtime&alertSubType=trafficfixed'

OAuth 2.0 アクセス トークンの取得の説明に従って、$ACCESS_TOKEN を OAuth 2.0 アクセス トークンに設定します。この例で使用されている cURL オプションの詳細については、cURL を使用するをご覧ください。