Wywoływanie elementu webhook przy użyciu klasycznego alertu dotyczącego metryk w usłudze Azure Monitor

  • Artykuł

Ostrzeżenie

W tym artykule opisano sposób używania starszych alertów dotyczących metryk klasycznych. Usługa Azure Monitor obsługuje teraz alerty metryk niemal w czasie rzeczywistym i nowe środowisko alertów. Alerty klasyczne są wycofyzowane dla użytkowników chmury publicznej. Alerty klasyczne dla chmury Azure Government i platformy Microsoft Azure obsługiwanej przez firmę 21Vianet zostaną wycofane 29 lutego 2024 r.

Za pomocą elementów webhook można kierować powiadomienie o alertach platformy Azure do innych systemów na potrzeby przetwarzania końcowego lub akcji niestandardowych. Możesz użyć elementu webhook w alercie, aby skierować go do usług, które wysyłają wiadomości SMS, rejestrować usterki, powiadamiać zespół za pośrednictwem czatu lub usług obsługi wiadomości lub w przypadku różnych innych akcji.

W tym artykule opisano sposób ustawiania elementu webhook w alercie metryk platformy Azure. Pokazano również, jak wygląda ładunek żądania HTTP POST do elementu webhook. Aby uzyskać informacje o konfiguracji i schemacie alertu dziennika aktywności platformy Azure (alert dotyczący zdarzeń), zobacz Wywoływanie elementu webhook w alercie dziennika aktywności platformy Azure.

Alerty platformy Azure używają protokołu HTTP POST do wysyłania zawartości alertu w formacie JSON do identyfikatora URI elementu webhook podanego podczas tworzenia alertu. Schemat jest zdefiniowany w dalszej części tego artykułu. Identyfikator URI musi być prawidłowym punktem końcowym HTTP lub HTTPS. Platforma Azure publikuje jeden wpis na żądanie po aktywowaniu alertu.

Konfigurowanie elementów webhook za pośrednictwem Azure Portal

Aby dodać lub zaktualizować identyfikator URI elementu webhook, w Azure Portal przejdź do pozycji Tworzenie/aktualizowanie alertów.

Dodawanie okienka reguły alertu

Alert można również skonfigurować do publikowania w identyfikatorze URI elementu webhook przy użyciu poleceń cmdlet Azure PowerShell, międzyplatformowego interfejsu wiersza polecenia lub interfejsów API REST usługi Azure Monitor.

Uwierzytelnianie elementu webhook

Element webhook może uwierzytelniać się przy użyciu autoryzacji opartej na tokenach. Identyfikator URI elementu webhook jest zapisywany przy użyciu identyfikatora tokenu. Na przykład: https://mysamplealert/webcallback?tokenid=sometokenid&someparameter=somevalue

Schemat ładunku

Operacja POST zawiera następujący ładunek JSON i schemat dla wszystkich alertów opartych na metryce:

{
    "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"
    }
}
Pole Obowiązkowy Stały zestaw wartości Uwagi
status Y Aktywowano, rozwiązano problem Stan alertu na podstawie ustawionych warunków.
kontekst Y Kontekst alertu.
sygnatura czasowa Y Czas wyzwolenia alertu.
identyfikator Y Każda reguła alertu ma unikatowy identyfikator.
name Y Nazwa alertu.
description (opis) Y Opis alertu.
conditionType Y Metryka, zdarzenie Obsługiwane są dwa typy alertów: metryka i zdarzenie. Alerty metryk są oparte na warunku metryki. Alerty zdarzeń są oparte na zdarzeniu w dzienniku aktywności. Użyj tej wartości, aby sprawdzić, czy alert jest oparty na metryce, czy na zdarzeniu.
Warunek Y Określone pola do sprawdzenia na podstawie wartości conditionType .
metricName W przypadku alertów dotyczących metryk Nazwa metryki definiującej, co monitoruje reguła.
metricUnit W przypadku alertów dotyczących metryk Bajty, BytesPerSecond, Count, CountPerSecond, Percent, Seconds Jednostka dozwolona w metryce. Zobacz dozwolone wartości.
metricValue W przypadku alertów dotyczących metryk Rzeczywista wartość metryki, która spowodowała alert.
Próg W przypadku alertów dotyczących metryk Wartość progowa, przy której jest aktywowany alert.
windowSize W przypadku alertów dotyczących metryk Okres używany do monitorowania aktywności alertów na podstawie progu. Wartość musi należeć do przedziału od 5 minut do 1 dnia. Wartość musi być w formacie czasu trwania ISO 8601.
timeAggregation W przypadku alertów dotyczących metryk Average, Last, Maximum, Minimum, None, Total Sposób łączenia zebranych danych w czasie. Wartość domyślna to Średnia. Zobacz dozwolone wartości.
operator W przypadku alertów dotyczących metryk Operator używany do porównywania bieżących danych metryk z ustawionym progiem.
subscriptionId Y Identyfikator subskrypcji platformy Azure.
resourceGroupName Y Nazwa grupy zasobów dla zasobu, którego dotyczy problem.
resourceName Y Nazwa zasobu, którego dotyczy problem.
resourceType Y Typ zasobu, którego dotyczy problem.
resourceId Y Identyfikator zasobu, którego dotyczy problem.
resourceRegion Y Region lub lokalizacja zasobu, którego dotyczy problem.
portalLink Y Bezpośredni link do strony podsumowania zasobów portalu.
properties N Opcjonalne Zestaw par klucz/wartość, które zawierają szczegółowe informacje o zdarzeniu. Na przykład Dictionary<String, String>. Pole właściwości jest opcjonalne. W niestandardowym przepływie pracy interfejsu użytkownika lub aplikacji logiki użytkownicy mogą wprowadzać pary klucz/wartość, które można przekazać za pośrednictwem ładunku. Alternatywnym sposobem przekazywania właściwości niestandardowych z powrotem do elementu webhook jest sam identyfikator URI elementu webhook (jako parametry zapytania).

Uwaga

Pole właściwości można ustawić tylko przy użyciu interfejsów API REST usługi Azure Monitor.

Następne kroki