Настройте оповещения о пробках

Вы просматриваете документацию Apigee Edge .
Перейдите к документации Apigee X. информация

Используйте оповещение о трафике, чтобы выдавать уведомление, когда трафик для среды, прокси-сервера или региона изменяется на указанный процент в течение определенного диапазона времени.

Вы устанавливаете временной диапазон:

  • 1 час
  • 1 день
  • 7 дней
  • 15 дней (только API)
  • 30 дней (только API)

Оповещение работает путем сравнения трафика за текущий временной диапазон с трафиком за предыдущий временной диапазон. Например, вы указываете диапазон времени в один час. Затем предупреждение сравнивает трафик за последний час с трафиком за предыдущий час, чтобы вычислить процентное изменение трафика:

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

Положительное значение означает, что трафик увеличился, а отрицательное значение означает, что трафик уменьшился.

Затем вы устанавливаете пороговое значение, которое вызывает оповещение о трафике, как процентное увеличение или уменьшение трафика API за указанный период времени.

Прежде чем устанавливать этот процент, убедитесь, что он соответствует вашей обычной структуре трафика. Например, если ваш трафик API обычно колеблется в течение дня с почасовыми всплесками трафика до 100% в определенные часы пик, эти всплески являются нормальными и не должны вызывать оповещения. Однако если вы затем настроите оповещение на срабатывание при любом увеличении почасового трафика на 50 %, вы получите ненужные оповещения для обычного трафика.

Дополнительные сведения об оповещениях см. в разделе Настройка оповещений и уведомлений .

Добавляйте оповещения и уведомления о пробках

Чтобы добавить оповещения и уведомления о пробках:
  1. Нажмите «Анализ» > «Правила оповещений» в пользовательском интерфейсе Edge.
  2. Нажмите +Оповещение .
  3. Введите следующую общую информацию об оповещении:
    Поле Описание
    Имя оповещения Название оповещения. Используйте имя, которое описывает триггер и будет иметь для вас значение. Имя не может превышать 128 символов.
    Описание Описание оповещения.
    Тип оповещения Выберите Общий трафик . Дополнительную информацию см. в разделе О типах оповещений .
    Среда Выберите среду из раскрывающегося списка.
    Статус Переключите, чтобы включить или отключить оповещение.
  4. Определите пороговое значение и измерение для условия, которое вызовет оповещение.
    Поле условия Описание
    Порог

    Укажите, чтобы выдавать оповещение, когда трафик увеличился или уменьшился на определенный процент по сравнению с предыдущим интервалом времени.

    Установите увеличение в процентах на значение, большее или равное 0%. Установите уменьшение в процентах до значения, большего или равного 0%, и меньшего или равного 100%.

    Вы можете выбрать временной интервал:

    • 1 час
    • 1 день
    • 1 неделя
    Измерение

    Нажмите +Добавить измерение и укажите сведения об измерении, для которого нужно вернуть результаты, включая прокси-сервер API и регион.

    Установите конкретный размер, чтобы:

    • Прокси — выберите конкретный прокси или Все прокси. Прокси не поддерживает значение «Любой» . Вместо этого вы можете добавить отдельное оповещение для каждого интересующего вас прокси.
    • Регион — установите конкретный регион или все регионы. Регион не поддерживает значение «Любой» . Вместо этого вы можете добавить отдельное оповещение для каждого интересующего вас региона.
  5. Нажмите + Уведомление , чтобы добавить оповещение.
    Детали уведомления Описание
    Канал Выберите канал уведомлений, который вы хотите использовать, и укажите место назначения: электронная почта, Slack, PagerDuty или Webhook.
    Место назначения Укажите пункт назначения в зависимости от выбранного типа канала:
    • Электронная почта — адрес электронной почты, например joe@company.com
    • Slack — URL-адрес канала Slack, например https://hooks.slack.com/services/T00000000/B00000000/XXXXX
    • PagerDuty — код PagerDuty, например abcd1234efgh56789
    • Webhook — URL-адрес веб-перехватчика, например https://apigee.com/test-webhook

      Примечание . Для каждого уведомления можно указать только один пункт назначения. Чтобы указать несколько пунктов назначения для одного и того же типа канала, добавьте дополнительные уведомления.

  6. Чтобы добавить дополнительные уведомления, повторите предыдущий шаг.
  7. Если вы добавили уведомление, установите следующие поля:
    Поле Описание
    Пособие (Необязательно) Текстовое поле произвольной формы для предоставления краткого описания рекомендуемых действий по устранению предупреждений при их срабатывании. Вы также можете указать ссылку на свою внутреннюю вики-страницу или страницу сообщества, где вы ссылаетесь на лучшие практики. Информация в этом поле будет включена в уведомление. Содержимое этого поля не может превышать 1500 символов.
    Дроссель Частота отправки уведомлений. Выберите значение из раскрывающегося списка.
  8. Нажмите Сохранить .

Просмотр оповещений на панели событий.

Когда Edge обнаруживает состояние оповещения, он автоматически регистрирует это состояние на панели мониторинга «События» в пользовательском интерфейсе Edge. Список событий, отображаемый на панели событий, включает все оповещения, как фиксированные, так и сертифицированные.

Чтобы просмотреть оповещение:

  1. Нажмите «Анализ» > «События» в пользовательском интерфейсе Edge. Появится новая панель событий:

  2. Отфильтруйте панель событий по:

    • Среда
    • Область
    • Период времени
  3. Выберите строку на панели мониторинга событий, чтобы отобразить хранилище ключей, содержащее сертификат с истекающим сроком действия, для дальнейшего изучения предупреждения. На странице хранилища ключей вы можете загрузить новый сертификат и удалить сертификат с истекающим сроком действия.

Используйте API оповещений с оповещениями о дорожном движении

Большинство API-интерфейсов, которые вы используете для создания оповещений о дорожном движении и управления ими, такие же, как и для других типов оповещений:

Однако некоторые API имеют дополнительные свойства, используемые для поддержки предупреждений об аномалиях, в том числе:

Создайте или обновите оповещение о пробках

Используйте те же API для создания или обновления оповещений о трафике, что и для других типов оповещений. Тело вызова API для создания или обновления оповещения о трафике такое же, как и для других оповещений, со следующими изменениями:

  • Добавьте следующие новые свойства, чтобы указать, что предупреждение является предупреждением о дорожном движении:

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

    Значения по умолчанию для этих свойств:

    "alertType": "runtime"
"alertSubType": "fixed"
  • В элементе dimensions массива conditions :
    • Вы должны установить значения свойств 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 не поддерживается для предупреждений о дорожном движении.
В следующем примере показано, как настроить оповещение, которое срабатывает, когда трафик для организации и среды увеличивается на 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 см. в разделе Просмотр событий .

Получайте оповещения о пробках

По умолчанию API Get Alerts возвращает информацию обо всех определенных оповещениях. Этот API теперь принимает параметры запроса, позволяющие фильтровать результаты:

  • enabled — если true , указывает на возврат только включенных оповещений. Значение по умолчанию — false .
  • alertType — указывает тип возвращаемого оповещения. Допустимые значения: runtime , default и 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'

Установите $ACCESS_TOKEN свой токен доступа OAuth 2.0, как описано в разделе «Получение токена доступа OAuth 2.0» . Сведения о параметрах cURL, использованных в этом примере, см. в разделе Использование cURL .