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

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

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

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

  • 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 .