Typowy schemat alertu standandaryzuje użycie powiadomień o alertach usługi Azure Monitor. W przeszłości dziennik aktywności, metryka i alerty przeszukiwania dzienników miały własne szablony wiadomości e-mail i schematy elementów webhook. Wspólny schemat alertu zawiera jeden ustandaryzowany schemat dla wszystkich powiadomień o alertach.
Użycie ustandaryzowanego schematu pomaga zminimalizować liczbę integracji, co upraszcza proces zarządzania i konserwacji integracji. Wspólny schemat umożliwia bogatsze środowisko użycia alertów zarówno w witrynie Azure Portal, jak i w aplikacji mobilnej platformy Azure.
Wspólny schemat alertów zapewnia spójną strukturę dla następujących elementów:
Szablony wiadomości e-mail: użyj szczegółowego szablonu wiadomości e-mail, aby szybko zdiagnozować problemy. Osadzone linki do wystąpienia alertu w portalu i do zasobu, którego dotyczy problem, zapewniają szybkie przejście do procesu korygowania.
Struktura JSON: użyj spójnej struktury JSON do kompilowania integracji dla wszystkich typów alertów przy użyciu:
Azure Logic Apps
Azure Functions
Element runbook usługi Azure Automation
Uwaga
Alerty generowane przez szczegółowe informacje o maszynie wirtualnej nie obsługują wspólnego schematu.
Alerty wykrywania inteligentnego domyślnie używają wspólnego schematu. Nie musisz włączać wspólnego schematu dla alertów wykrywania inteligentnego.
Struktura wspólnego schematu
Wspólny schemat zawiera informacje o zasobie, którego dotyczy problem, oraz przyczynę alertu w poniższych sekcjach:
Podstawowe informacje: pola ustandaryzowane, używane przez wszystkie typy alertów, które opisują zasób, na który ma wpływ alert i typowe metadane alertu, takie jak ważność lub opis.
Jeśli chcesz kierować wystąpienia alertów do określonych zespołów na podstawie kryteriów, takich jak grupa zasobów, możesz użyć pól w sekcji Podstawy, aby zapewnić logikę routingu dla wszystkich typów alertów . Zespoły, które otrzymają powiadomienie o alercie, mogą następnie używać pól kontekstu do badania.
Kontekst alertu: pola, które różnią się w zależności od typu alertu. Pola kontekstu alertu opisują przyczynę alertu. Na przykład alert metryki będzie zawierać pola, takie jak nazwa metryki i wartość metryki w kontekście alertu. Alert dziennika aktywności zawiera informacje o zdarzeniu, które wygenerowało alert.
Właściwości niestandardowe: dodatkowe informacje, które nie są domyślnie uwzględnione w ładunku alertu, mogą być uwzględniane w ładunku alertu przy użyciu właściwości niestandardowych. Właściwości niestandardowe to para Key:Value , która może zawierać wszelkie informacje skonfigurowane w regule alertu.
Nazwa reguły alertu, która wygenerowała wystąpienie alertu.
Ważność
Ważność alertu. Możliwe wartości to Sev0, Sev1, Sev2, Sev3 lub Sev4.
signalType
Określa sygnał, na którym zdefiniowano regułę alertu. Możliwe wartości to Metryka, Dziennik lub Dziennik aktywności.
monitorCondition
Gdy alert zostanie wyzwolony, stan monitora alertu zostanie ustawiony na wyzwolony. Jeśli podstawowy warunek, który spowodował wyczyszczenie alertu, warunek monitora jest ustawiony na Rozwiązane.
monitoringService
Usługa monitorowania lub rozwiązanie, które wygenerowało alert. Usługa monitorowania określa, które pola znajdują się w kontekście alertu.
alertTargetIDs
Lista identyfikatorów usługi Azure Resource Manager, których dotyczy element docelowy alertu. W przypadku alertu przeszukiwania dzienników zdefiniowanego w obszarze roboczym usługi Log Analytics lub wystąpieniu usługi Application Insights jest to odpowiedni obszar roboczy lub aplikacja.
configurationItems
Lista zasobów, których dotyczy alert. W niektórych przypadkach elementy konfiguracji mogą różnić się od elementów docelowych alertów. Na przykład w alertach przeszukiwania dzienników lub dziennika zdefiniowanych w obszarze roboczym usługi Log Analytics elementy konfiguracji są rzeczywistymi zasobami wysyłającymi dane, a nie obszarem roboczym.
W interfejsie API alertów przeszukiwania dzienników (reguły zaplanowanego zapytania) v2021-08-01 configurationItem wartości są pobierane z jawnie zdefiniowanych wymiarów w tym priorytecie: _ResourceId, , ResourceIdResource, Computer.
We wcześniejszych wersjach interfejsu API configurationItem alertów wyszukiwania dzienników wartości są pobierane niejawnie z wyników o następującym priorytecie: _ResourceId, , ResourceIdResource, Computer.
W systemach configurationItems ITSM pole służy do korelowania alertów z zasobami w bazie danych zarządzania konfiguracją.
originAlertId
Identyfikator wystąpienia alertu wygenerowany przez usługę monitorowania.
firedDateTime
Data i godzina uruchomienia wystąpienia alertu w uniwersalnym czasie koordynowanym (UTC).
resolvedDateTime
Data i godzina ustawienia warunku monitora wystąpienia alertu na wartość Rozwiązano w formacie UTC. Obecnie dotyczy tylko alertów dotyczących metryk.
opis
Opis, zgodnie z definicją w regule alertu.
alertRuleID
Identyfikator reguły alertu, która wygenerowała wystąpienie alertu.
resourceType
Typ zasobu, którego dotyczy alert.
resourceGroupName
Nazwa grupy zasobów dla zasobu, na który ma to wpływ.
essentialsVersion
Numer wersji sekcji podstaw.
alertContextVersion
Numer alertContext wersji sekcji.
investigationLink
Link do zbadania alertu w usłudze Azure Monitor. Obecnie wymagana jest ograniczona rejestracja w wersji zapoznawczej.
Pola kontekstu alertu dla alertów dotyczących metryk
Pole
opis
właściwości
(Opcjonalnie). Kolekcja właściwości zdefiniowanych przez klienta.
conditionType
Typ warunku wybranego dla reguły alertu: - próg statyczny - próg dynamiczny - webtest
condition
windowSize
Okres analizowany przez regułę alertu.
allOf
Wskazuje, że wszystkie warunki zdefiniowane w regule alertu muszą zostać spełnione, aby wyzwolić alert.
alertSensitivity
W regule alertu z progiem dynamicznym wskazuje, jak wrażliwa jest reguła lub ile wartość może odbiegać od górnego lub niższego progu.
failPeriods
W regule alertu z progiem dynamicznym liczba okresów oceny, które nie spełniają progu alertu, który wyzwoli alert. Możesz na przykład wskazać, że alert jest wyzwalany, gdy 3 z ostatnich pięciu okresów oceny nie mieści się w progach alertów.
numberOfEvaluationPeriods
Całkowita liczba ocen.
minFailingPeriodsToAlert
Minimalna liczba ocen, które nie spełniają warunków reguły alertu.
ignoreDataBefore
(Opcjonalnie). W regule alertu z progiem dynamicznym data, z której jest obliczany próg. Użyj tej wartości, aby wskazać, że reguła nie powinna obliczać progu dynamicznego przy użyciu danych sprzed określonej daty.
metricName
Nazwa metryki monitorowanej przez regułę alertu.
metricNamespace
Przestrzeń nazw metryki monitorowana przez regułę alertu.
operator
Operator logiczny reguły alertu.
threshold
Próg zdefiniowany w regule alertu. W przypadku reguły alertu z progiem dynamicznym ta wartość to obliczony próg.
timeAggregation
Typ agregacji reguły alertu.
wymiary
Wymiar metryki, który wyzwolił alert.
name
Nazwa wymiaru.
wartość
Wartość wymiaru.
metricValue
Wartość metryki w momencie naruszenia progu.
webTestName
Jeśli typ warunku to webtest, nazwa testu internetowego.
windowStartTime
Godzina rozpoczęcia okna oceny, w którym został wyzwolony alert.
windowEndTime
Godzina zakończenia okna oceny, w którym został wyzwolony alert.
Przykładowy alert metryki z progiem statycznym, gdy monitorService = Platform
Pola kontekstu alertu dla alertów przeszukiwania dzienników
Uwaga
Po włączeniu wspólnego schematu pola w ładunku są resetowane do typowych pól schematu. W związku z tym alerty przeszukiwania dzienników mają następujące ograniczenia dotyczące wspólnego schematu:
Wspólny schemat nie jest obsługiwany w przypadku alertów przeszukiwania dzienników przy użyciu elementów webhook z niestandardowym tematem wiadomości e-mail i/lub ładunkiem JSON, ponieważ wspólny schemat zastępuje konfiguracje niestandardowe.
Alerty korzystające ze wspólnego schematu mają górny limit rozmiaru 256 KB na alert. Jeśli ładunek alertów przeszukiwania dzienników zawiera wyniki wyszukiwania, które powodują przekroczenie maksymalnego rozmiaru alertu, wyniki wyszukiwania nie są osadzone w ładunku alertów przeszukiwania dzienników. Możesz sprawdzić, czy ładunek zawiera wyniki wyszukiwania z flagą IncludedSearchResults . Użyj LinkToFilteredSearchResultsAPI polecenia lub LinkToSearchResultsAPI , aby uzyskać dostęp do wyników zapytania za pomocą interfejsu API usługi Log Analytics, jeśli wyniki wyszukiwania nie są uwzględnione.
Pole
opis
Zapytanie wyszukiwania
Zapytanie zdefiniowane w regule alertu.
SearchIntervalStartTimeUtc
Godzina rozpoczęcia okna oceny, w którym alert został wyzwolony w formacie UTC.
SearchIntervalEndTimeUtc
Godzina zakończenia okna oceny, w którym alert został wyzwolony w formacie UTC.
ResultCount
Liczba rekordów zwracanych przez zapytanie. W przypadku reguł pomiaru metryk liczba lub rekordy pasujące do określonej kombinacji wymiarów.
LinkToSearchResults
Link do wyników wyszukiwania.
LinkToFilteredSearchResultsUI
W przypadku reguł pomiaru metryk link do wyników wyszukiwania po ich przefiltrowania według kombinacji wymiarów.
LinkToSearchResultsAPI
Link do wyników zapytania przy użyciu interfejsu API usługi Log Analytics.
LinkToFilteredSearchResultsAPI
W przypadku reguł pomiaru metryk link do wyników wyszukiwania przy użyciu interfejsu API usługi Log Analytics po ich przefiltrowaniu według kombinacji wymiarów.
SearchIntervalDurationMin
Łączna liczba minut w interwale wyszukiwania.
SearchIntervalInMin
Łączna liczba minut w interwale wyszukiwania.
Threshold
Próg zdefiniowany w regule alertu.
Operator
Operator zdefiniowany w regule alertu.
ApplicationID
Identyfikator usługi Application Insights, na którym został wyzwolony alert.
Wymiary
W przypadku reguł pomiaru metryk wymiary metryki, na których został wyzwolony alert.
name
Nazwa wymiaru.
wartość
Wartość wymiaru.
SearchResults
Kompletne wyniki wyszukiwania.
table
Tabela wyników w wynikach wyszukiwania.
name
Nazwa tabeli w wynikach wyszukiwania.
kolumny
Kolumny w tabeli.
name
Nazwa kolumny.
type
Typ kolumny.
wiersze
Wiersze w tabeli.
Źródła danych
Źródła danych, w których został wyzwolony alert.
resourceID
Identyfikator zasobu, którego dotyczy alert.
Tabele
Wersje robocze tabel odpowiedzi zawarte w zapytaniu.
IncludedSearchResults
Flaga wskazująca, czy ładunek powinien zawierać wyniki.
AlertType
Typ alertu: - Pomiar metryki - Liczba wyników
Przykładowy alert przeszukiwania dzienników podczas monitorowaniaService = Log Analytics
Przykładowy alert przeszukiwania dzienników, gdy monitorService = Log Alerts V2
Uwaga
Reguły alertów przeszukiwania dzienników z interfejsu API w wersji 2020-05-01 używają tego typu ładunku, który obsługuje tylko wspólny schemat. Wyniki wyszukiwania nie są osadzone w ładunku alertów przeszukiwania dzienników podczas korzystania z tej wersji. Użyj wymiarów , aby zapewnić kontekst wyzwalanych alertów. Możesz również użyć LinkToFilteredSearchResultsAPI funkcji lub LinkToSearchResultsAPI uzyskać dostęp do wyników zapytań za pomocą interfejsu API usługi Log Analytics. Jeśli musisz osadzić wyniki, użyj aplikacji logiki z podanymi linkami, aby wygenerować niestandardowy ładunek.
Jeśli reguła alertu, która wygenerowała alert, zawiera grupy akcji, właściwości niestandardowe mogą zawierać dodatkowe informacje o alercie. Sekcja właściwości niestandardowych zawiera obiekty "key: value", które są dodawane do powiadomień elementu webhook.
Jeśli właściwości niestandardowe nie są ustawione w regule alertu, pole ma wartość null.
Włączanie wspólnego schematu alertów
Użyj grup akcji w witrynie Azure Portal lub użyj interfejsu API REST, aby włączyć wspólny schemat alertów. Schematy są definiowane na poziomie akcji. Na przykład należy oddzielnie włączyć schemat dla akcji poczty e-mail i akcji elementu webhook.
Włączanie wspólnego schematu w witrynie Azure Portal
Otwórz dowolną istniejącą akcję lub nową akcję w grupie akcji.
Wybierz pozycję Tak , aby włączyć wspólny schemat alertu.
Włączanie wspólnego schematu przy użyciu interfejsu API REST
Ustaw flagę "useCommonAlertSchema", aby true włączyć wspólny schemat
Ustaw flagę "useCommonAlertSchema", aby używać false nietypowego schematu dla wiadomości e-mail, elementu webhook, usługi Logic Apps, usługi Azure Functions lub akcji elementu Runbook usługi Automation.
Przykładowe wywołanie interfejsu API REST do używania wspólnego schematu
Dołącz do serii meetup, aby tworzyć skalowalne rozwiązania sztucznej inteligencji oparte na rzeczywistych przypadkach użycia z innymi deweloperami i ekspertami.
W tym module dowiesz się, jak alerty monitorowania platformy Azure proaktywnie powiadamiają, gdy dane usługi Azure Monitor wskazują, że może wystąpić problem z infrastrukturą lub aplikacjami, zanim problem stanie się jednym z użytkowników.