Вызов веб-перехватчика с помощью классического оповещения метрики в Azure Monitor

  • Статья

Предупреждение

В этой статье объясняется, как использовать более ранние классические оповещения метрик. Azure Monitor теперь поддерживает оповещения метрик практически в реальном времени и новый интерфейс оповещений. Поддержка классических оповещений для пользователей общедоступного облака будет прекращена. Классические оповещения для Azure для государственных организаций облака и Microsoft Azure под управлением 21Vianet будут прекращены 29 февраля 2024 г.

С помощью веб-перехватчика можно направлять уведомления об оповещениях Azure в другие системы для постобработки или выполнения настраиваемых действий. Веб-перехватчик можно использовать, чтобы направить оповещение к службам, которые отправляют SMS-сообщения, ведут журналы об ошибках, уведомляют членов команды в чате или службах обмена сообщениями либо выполняют другие действия.

В этой статье описываются способы настройки веб-перехватчика для оповещения метрики Azure. В ней также показывается, как выглядят полезные данные HTTP POST для веб-перехватчика. Дополнительные сведения о настройке и схеме для оповещений журнала действий Azure см. в статье Вызов веб-перехватчика для оповещений журнала действий Azure.

Оповещения Azure с помощью запроса HTTP POST помещают содержимое оповещения в формате JSON в универсальный код ресурса (URI) веб-перехватчика, указанный при создании оповещения. Схема определена далее в этой статье. Этот URI должен быть допустимой конечной точкой HTTP или HTTPS. При активации оповещений Azure размещает одну запись для каждого запроса.

Настройка веб-перехватчика на портале Azure

Чтобы добавить или обновить универсальный код ресурса (URI) веб-перехватчика на портале Azure, перейдите в раздел создания и обновления оповещений.

Добавление панели правил генерации оповещений

Вы также можете настроить оповещение так, чтобы при его активации в URI веб-перехватчика добавлялись соответствующие сведения. Для этого можно использовать командлеты Azure PowerShell, кроссплатформенный интерфейс командной строки или REST API Azure Monitor.

Аутентификация веб-перехватчика

Для веб-перехватчика может использоваться аутентификация на основе маркеров. Универсальный код ресурса (URI) веб-перехватчика сохраняется вместе с идентификатором маркера. Например: https://mysamplealert/webcallback?tokenid=sometokenid&someparameter=somevalue

Схема полезных данных

Операция POST содержит следующие полезные данные и схему JSON для всех оповещений, связанных с метриками.

{
    "status": "Activated",
    "context": {
        "timestamp": "2015-08-14T22:26:41.9975398Z",
        "id": "/subscriptions/s1/resourceGroups/useast/providers/microsoft.insights/alertrules/ruleName1",
        "name": "ruleName1",
        "description": "some description",
        "conditionType": "Metric",
        "condition": {
            "metricName": "Requests",
            "metricUnit": "Count",
            "metricValue": "10",
            "threshold": "10",
            "windowSize": "15",
            "timeAggregation": "Average",
            "operator": "GreaterThanOrEqual"
        },
        "subscriptionId": "s1",
        "resourceGroupName": "useast",
        "resourceName": "mysite1",
        "resourceType": "microsoft.foo/sites",
        "resourceId": "/subscriptions/s1/resourceGroups/useast/providers/microsoft.foo/sites/mysite1",
        "resourceRegion": "centralus",
        "portalLink": "https://portal.azure.com/#resource/subscriptions/s1/resourceGroups/useast/providers/microsoft.foo/sites/mysite1"
    },
    "properties": {
        "key1": "value1",
        "key2": "value2"
    }
}
Поле Обязательный Фиксированный набор значений Примечания
status Да Activated, Resolved Состояние оповещения на основе заданных условий.
контекст Да Контекст оповещения.
TIMESTAMP Да Время активации оповещения
идентификатор Да Каждое правило оповещения имеет уникальный идентификатор.
name Да Имя предупреждения.
description Да Описание оповещения.
conditionType Да Metric, Event Поддерживаются два типа оповещений: метрики и события. Оповещения метрики основаны на условии метрики. Оповещения событий основаны на событиях в журнале действий. Таким образом, это значение позволяет узнать тип оповещения — метрики или события.
condition Да Специальные поля для проверки с учетом параметра conditionType.
metricName Для оповещений на основе метрик Имя метрики, определяющей, что контролирует метрика.
metricUnit Для оповещений на основе метрик Bytes, BytesPerSecond, Count, CountPerSecond, Percent, Seconds Допустимая метрикой единица Список допустимых значений см. См. допустимые значения.
metricValue Для оповещений на основе метрик Фактическое значение метрики, которая вызвала оповещение.
threshold Для оповещений на основе метрик Пороговое значение, при котором активируется оповещение.
windowSize Для оповещений на основе метрик Период времени, используемый для отслеживания активности оповещения по пороговому значению. Значение должно составлять от 5 минут до 24 часов. Значение должно быть в формате длительности ISO 8601.
timeAggregation Для оповещений на основе метрик Average, Last, Maximum, Minimum, None, Total Порядок объединения данных, собранных за определенный период. Значение по умолчанию — Average (Среднее). См. допустимые значения.
оператор Для оповещений на основе метрик Оператор, используемый для сравнения текущих данных метрик с заданным пороговым значением.
subscriptionId Да Идентификатор подписки Azure.
имя_группы_ресурсов Да Имя группы ресурсов для затронутого ресурса.
resourceName Да Имя затронутого ресурса.
тип_ресурса Да Тип ресурса затронутого ресурса.
resourceId Да Идентификатор ресурса затронутого ресурса.
resourceRegion Да Регион или расположение затронутого ресурса.
portalLink Да Прямая ссылка на страницу сводки по ресурсу на портале.
properties Нет Необязательно Набор пар "ключ — значение", содержащих подробные сведения о событии. Например, Dictionary<String, String>. Поле свойства не является обязательным. В настраиваемом пользовательском интерфейсе или в рабочем процессе на основе приложения логики пользователи могут вводить пары "ключ — значение" для передачи в виде полезных сведений. Еще один способ передачи пользовательских свойств в веб-перехватчик — через сам универсальный код ресурса (URI) веб-перехватчика (в виде параметров запросов).

Примечание

Значение в поле свойства можно задать только с помощью REST API Azure Monitor.

Дальнейшие действия