Samouczek: Monitorowanie opublikowanych interfejsów API

  • Artykuł

DOTYCZY: Wszystkie warstwy usługi API Management

Dzięki usłudze Azure Monitor możesz wykonywać wizualizacje i zapytania, ustalać trasy, archiwizować i podejmować działania dotyczące metryk lub dzienników pochodzących z usługi Azure API Management.

Z tego samouczka dowiesz się, jak wykonywać następujące czynności:

  • Wyświetlanie metryk interfejsu API
  • Konfigurowanie reguły alertu
  • Wyświetlanie dzienników aktywności
  • Włączanie i wyświetlanie dzienników zasobów

Uwaga

Usługa API Management obsługuje szereg dodatkowych narzędzi do obserwowania interfejsów API, w tym wbudowanych analiz i integracji z usługą Application Szczegółowe informacje. Dowiedz się więcej

Wymagania wstępne

Wyświetlanie metryk interfejsów API

Usługa API Management emituje metryki co minutę, zapewniając niemal wgląd w stan i kondycję interfejsów API w czasie rzeczywistym. Poniżej przedstawiono dwie najczęściej używane metryki. Aby uzyskać listę wszystkich dostępnych metryk, zobacz obsługiwane metryki.

  • Pojemność — ułatwia podejmowanie decyzji dotyczących uaktualniania/obniżania usług API Management. Metryka jest emitowana na minutę i odzwierciedla szacowaną pojemność bramy w czasie raportowania. Wartość metryki należy do zakresu od 0 do 100 i jest obliczana w oparciu o zasoby bramy, takie jak wykorzystanie procesora i pamięci.
  • Żądania — ułatwia analizowanie ruchu interfejsu API przechodzącego przez usługi API Management. Metryka jest emitowana na minutę i raportuje liczbę żądań bramy z wymiarami. Filtruj żądania według kodów odpowiedzi, lokalizacji, nazwy hosta i błędów.

Ważne

Następujące metryki zostały wycofane z maja 2019 r. i zostaną wycofane w sierpniu 2023 r.: Łączna liczba żądań bramy, pomyślne żądania bramy, żądania nieautoryzowanej bramy, żądania bramy zakończone niepowodzeniem, inne żądania bramy. Przeprowadź migrację do metryki Żądania, która zapewnia równoważne funkcje.

Zrzut ekranu przedstawiający metryki w usłudze API Management — omówienie

Aby uzyskać dostęp do metryk:

  1. W witrynie Azure Portal przejdź do wystąpienia usługi API Management. Na stronie Przegląd na karcie Monitorowanie przejrzyj kluczowe metryki dla interfejsów API.

  2. Aby szczegółowo zbadać metryki, wybierz pozycję Metryki z menu po lewej stronie.

    Zrzut ekranu przedstawiający element Metryki w menu Monitorowanie w portalu.

  3. Z listy rozwijanej wybierz interesujące Cię metryki. Na przykład Żądania.

  4. Wykres przedstawia łączną liczbę wywołań interfejsu API. Dostosuj zakres czasu, aby skoncentrować się na okresach zainteresowania.

  5. Wykres można filtrować przy użyciu wymiarów metryki Żądania . Na przykład wybierz pozycję Dodaj filtr, wybierz pozycję Kategoria kodu odpowiedzi zaplecza, wprowadź 500 jako wartość. Wykres przedstawia liczbę żądań zakończonych niepowodzeniem w zapleczu interfejsu API.

Konfigurowanie reguły alertu

Alerty można otrzymywać na podstawie metryk i dzienników aktywności. W usłudze Azure Monitor skonfiguruj regułę alertu, aby wykonać akcję po wyzwoleniu. Typowe akcje obejmują:

  • Wysyłanie powiadomienia e-mail
  • Wywołanie elementu webhook
  • Wywołanie aplikacji logiki platformy Azure

Aby skonfigurować przykładową regułę alertu na podstawie metryki żądania:

  1. W witrynie Azure Portal przejdź do wystąpienia usługi API Management.

  2. Wybierz pozycję Alerty z menu po lewej stronie.

    Zrzut ekranu przedstawiający opcję Alerty w menu Monitorowanie w portalu.

  3. Wybierz pozycję + Utwórz>regułę alertu.

  4. W oknie Wybieranie sygnału na karcie Warunek:

    1. W polu Typ sygnału wybierz pozycję Metryki.
    2. W polu Nazwa sygnału wybierz pozycję Żądania.
    3. W obszarze Logika alertu określ wartość progową, czyli liczbę wystąpień, po których powinien zostać wyzwolony alert.
    4. W obszarze Podziel według wymiarów w polu Nazwa wymiaru wybierz pozycję Kategoria kodu odpowiedzi bramy.
    5. W obszarze Wartości wymiarów wybierz pozycję 4xx, w przypadku błędów klienta, takich jak nieautoryzowane lub nieprawidłowe żądania. Jeśli wartość wymiaru nie jest wyświetlana, wybierz pozycję Dodaj wartość niestandardową i wprowadź wartość 4xx.
    6. W obszarze Kiedy należy ocenić, zaakceptuj ustawienia domyślne lub wybierz inne ustawienia, aby skonfigurować częstotliwość uruchamiania reguły. Wybierz Dalej.

    Zrzut ekranu przedstawiający konfigurowanie logiki alertów w portalu.

  5. Na karcie Akcje wybierz lub utwórz co najmniej jedną grupę akcji, aby powiadomić użytkowników o alercie i podjąć akcję. Na przykład utwórz nową grupę akcji, aby wysłać wiadomość e-mail z powiadomieniem na admin@contoso.comadres . Aby uzyskać szczegółowe instrukcje, zobacz Tworzenie grup akcji i zarządzanie nimi w witrynie Azure Portal.

    Zrzut ekranu przedstawiający konfigurowanie powiadomień dla nowej grupy akcji w portalu.

  6. Na karcie Szczegóły reguły tworzenia alertu wprowadź nazwę i opis reguły alertu i wybierz poziom ważności.

  7. Opcjonalnie skonfiguruj pozostałe ustawienia. Następnie na karcie Przeglądanie i tworzenie wybierz pozycję Utwórz.

  8. Teraz przetestuj regułę alertu, wywołując interfejs API konferencji bez klucza interfejsu API. Na przykład:

    curl GET https://apim-hello-world.azure-api.net/conference/speakers HTTP/1.1

    Alert jest wyzwalany na podstawie okresu oceny i będzie wysyłać wiadomość e-mail na admin@contoso.comadres .

    Alerty są również wyświetlane na stronie Alerty dla wystąpienia usługi API Management.

    Zrzut ekranu przedstawiający alerty w portalu.

Dzienniki aktywności

Dzienniki aktywności zapewniają wgląd w operacje w usługach API Management. Korzystając z tych dzienników, można określić rodzaj, użytkownika i czas każdej operacji zapisu (PUT, POST, DELETE) wykonanej względem usług API Management.

Uwaga

Dzienniki aktywności nie obejmują operacji odczytu (GET) ani operacji wykonywanych w witrynie Azure Portal albo przy użyciu oryginalnych interfejsów API zarządzania.

Dostęp do dzienników aktywności można uzyskać w usłudze API Management, a dostęp do wszystkich zasobów platformy Azure — w usłudze Azure Monitor.

Zrzut ekranu przedstawiający dziennik aktywności w portalu.

Aby wyświetlić dziennik aktywności:

  1. W witrynie Azure Portal przejdź do wystąpienia usługi API Management.

  2. Wybierz pozycję Dziennik aktywności.

    Zrzut ekranu przedstawiający element dziennika aktywności w menu Monitorowanie w portalu.

  3. Wybierz żądany zakres filtrowania, a następnie pozycję Zastosuj.

Dzienniki zasobów

Dzienniki zasobów (dzienniki usługi Azure Monitor) zawierają szczegółowe informacje o operacjach i błędach usługi API Management, które są ważne dla celów inspekcji i rozwiązywania problemów. Po włączeniu za pomocą ustawienia diagnostycznego dzienniki zbierają informacje o żądaniach interfejsu API, które są odbierane i przetwarzane przez bramę usługi API Management.

Uwaga

Warstwa Zużycie nie obsługuje zbierania dzienników zasobów.

Aby skonfigurować dzienniki zasobów:

  1. W witrynie Azure Portal przejdź do wystąpienia usługi API Management.

  2. Wybierz pozycję Ustawienia diagnostyczne.

    Zrzut ekranu przedstawiający element Ustawień diagnostycznych w menu Monitorowanie w portalu.

  3. Wybierz pozycję + Dodaj ustawienie diagnostyczne.

  4. Wybierz dzienniki lub metryki, które chcesz zebrać.

    Istnieje kilka opcji wysyłania dzienników i metryk. Na przykład archiwizowanie dzienników zasobów wraz z metrykami na koncie magazynu, przesyłanie strumieniowe ich do centrum zdarzeń lub wysyłanie ich do obszaru roboczego usługi Log Analytics.

    Napiwek

    Jeśli wybierzesz obszar roboczy usługi Log Analytics, możesz zapisać dane w tabeli ApiManagementGatewayLogs specyficznej dla zasobu lub przechowywać je w ogólnej tabeli AzureDiagnostics. Zalecamy użycie tabeli specyficznej dla zasobów dla lokalizacji docelowych dziennika, które ją obsługują. Dowiedz się więcej

  5. Po skonfigurowaniu szczegółów dla miejsca docelowego dziennika lub miejsc docelowych wybierz pozycję Zapisz.

Uwaga

Dodanie obiektu ustawienia diagnostycznego może spowodować niepowodzenie, jeśli właściwość MinApiVersion usługi API Management jest ustawiona na dowolną wersję interfejsu API wyższą niż 2022-09-01-preview.

Aby uzyskać więcej informacji, zobacz Create diagnostic settings to send platform logs and metrics to different destinations (Tworzenie ustawień diagnostycznych w celu wysyłania dzienników i metryk platformy do różnych miejsc docelowych).

Wyświetlanie danych diagnostycznych w usłudze Azure Monitor

Jeśli włączysz zbieranie dzienników lub metryk w obszarze roboczym usługi Log Analytics, wyświetlenie danych w usłudze Azure Monitor może potrwać kilka minut.

Aby wyświetlić dane:

  1. W witrynie Azure Portal przejdź do wystąpienia usługi API Management.

  2. Wybierz pozycję Dzienniki z menu po lewej stronie.

    Zrzut ekranu przedstawiający element Dzienniki w menu Monitorowanie w portalu.

  3. Uruchom zapytania, aby wyświetlić dane. Podano kilka przykładowych zapytań lub uruchom własne. Na przykład następujące zapytanie pobiera najnowsze 24 godziny danych z tabeli ApiManagementGatewayLogs:

    ApiManagementGatewayLogs
| where TimeGenerated > ago(1d)

    Zrzut ekranu przedstawiający wykonywanie zapytań względem tabeli ApiManagementGatewayLogs w portalu.

Aby uzyskać więcej informacji na temat używania dzienników zasobów dla usługi API Management, zobacz:

Modyfikowanie ustawień rejestrowania interfejsu API

Domyślnie podczas tworzenia ustawienia diagnostycznego umożliwiającego zbieranie dzienników zasobów rejestrowanie jest włączone dla wszystkich interfejsów API z ustawieniami domyślnymi. Możesz dostosować ustawienia rejestrowania dla wszystkich interfejsów API lub zastąpić je dla poszczególnych interfejsów API. Na przykład dostosuj częstotliwość próbkowania lub szczegółowość danych lub wyłącz rejestrowanie niektórych interfejsów API.

Aby uzyskać szczegółowe informacje na temat ustawień rejestrowania, zobacz Dokumentacja ustawień rejestrowania diagnostycznego.

Aby skonfigurować ustawienia rejestrowania dla wszystkich interfejsów API:

  1. W menu po lewej stronie wystąpienia usługi API Management wybierz pozycję Interfejsy API Wszystkie interfejsy> API.
  2. Wybierz kartę Ustawienia na górnym pasku.
  3. Przewiń w dół do sekcji Dzienniki diagnostyczne i wybierz kartę Azure Monitor .
  4. Przejrzyj ustawienia i w razie potrzeby wprowadź zmiany. Wybierz pozycję Zapisz.

Aby skonfigurować ustawienia rejestrowania dla określonego interfejsu API:

  1. W menu po lewej stronie wystąpienia usługi API Management wybierz pozycję Interfejsy API, a następnie nazwę interfejsu API.
  2. Wybierz kartę Ustawienia na górnym pasku.
  3. Przewiń w dół do sekcji Dzienniki diagnostyczne i wybierz kartę Azure Monitor .
  4. Przejrzyj ustawienia i w razie potrzeby wprowadź zmiany. Wybierz pozycję Zapisz.

Następne kroki

W tym samouczku zawarto informacje na temat wykonywania następujących czynności:

  • Wyświetlanie metryk interfejsu API
  • Konfigurowanie reguły alertu
  • Wyświetlanie dzienników aktywności
  • Włączanie i wyświetlanie dzienników zasobów

Przejdź do następnego samouczka:

Śledzenie wywołań