Udostępnij za pośrednictwem

Uzyskiwanie analizy interfejsu API w usłudze Azure API Management

  • Artykuł

DOTYCZY: Developer | Podstawowa | Podstawowa wersja 2 | Standardowa | Standardowa, wersja 2 | Premium | Premium, wersja 2

Usługa Azure API Management udostępnia analizę interfejsów API, dzięki czemu można analizować ich użycie i wydajność. Użyj analizy na potrzeby monitorowania wysokiego poziomu i rozwiązywania problemów z interfejsami API. Aby zapoznać się z innymi funkcjami monitorowania, w tym metrykami niemal w czasie rzeczywistym i dziennikami zasobów na potrzeby diagnostyki i inspekcji, zobacz Samouczek: monitorowanie opublikowanych interfejsów API.

Zrzut ekranu przedstawiający analizę interfejsu API w portalu.

Uwaga

Obecnie ta funkcja nie jest dostępna w obszarach roboczych.

Informacje o analizie interfejsu API

  • Usługa API Management udostępnia analizę przy użyciu pulpitu nawigacyjnego opartego na usłudze Azure Monitor. Pulpit nawigacyjny agreguje dane w obszarze roboczym usługi Azure Log Analytics.

  • W klasycznych warstwach usługi API Management wystąpienie usługi API Management obejmuje również starszą wbudowaną analizę w witrynie Azure Portal, a dostęp do danych analitycznych można uzyskać przy użyciu interfejsu API REST usługi API Management. Bardzo podobne dane są wyświetlane na pulpicie nawigacyjnym opartym na usłudze Azure Monitor i wbudowanej analizie.

Ważne

  • Pulpit nawigacyjny oparty na usłudze Azure Monitor jest zalecanym sposobem uzyskiwania dostępu do danych analitycznych.
  • Wbudowana analiza (klasyczna) nie jest dostępna w warstwach 2.

Dzięki analizie interfejsu API przeanalizuj użycie i wydajność interfejsów API w wystąpieniu usługi API Management w kilku wymiarach, w tym:

  • Czas
  • Obszar geograficzny
  • Interfejsy API
  • Operacje interfejsu API
  • Produkty
  • Subskrypcje
  • Użytkownicy
  • Żądania

Uwaga

  • Analiza interfejsu API udostępnia dane dotyczące żądań, w tym niepomyślnie i nieautoryzowanych żądań.
  • Wartości geograficzne są przybliżone na podstawie mapowania adresów IP.
  • Może wystąpić opóźnienie dostępności danych analitycznych.

Pulpit nawigacyjny oparty na usłudze Azure Monitor

Aby korzystać z pulpitu nawigacyjnego opartego na usłudze Azure Monitor, musisz mieć obszar roboczy usługi Log Analytics jako źródło danych dla dzienników bramy usługi API Management.

Jeśli musisz je skonfigurować, poniżej przedstawiono krótkie kroki wysyłania dzienników bramy do obszaru roboczego usługi Log Analytics. Aby uzyskać więcej informacji, zobacz Samouczek: monitorowanie opublikowanych interfejsów API. Jest to jednorazowa konfiguracja.

  1. W witrynie Azure Portal przejdź do wystąpienia usługi API Management.
  2. W menu po lewej stronie w obszarze Monitorowanie wybierz pozycję Ustawienia> diagnostyczne+ Dodaj ustawienie diagnostyczne.
  3. Wprowadź opisową nazwę ustawienia diagnostycznego.
  4. W obszarze Dzienniki wybierz pozycję Dzienniki powiązane z bramą ApiManagement Gateway.
  5. W obszarze Szczegóły miejsca docelowego wybierz pozycję Wyślij do usługi Log Analytics i wybierz obszar roboczy usługi Log Analytics w tej samej lub innej subskrypcji. Jeśli musisz utworzyć obszar roboczy, zobacz Tworzenie obszaru roboczego usługi Log Analytics.
  6. Upewnij się, że jako tabelę docelową wybrano pozycję Określony zasób.
  7. Wybierz pozycję Zapisz.

Ważne

Rozpoczęcie odbierania danych w nowym obszarze roboczym usługi Log Analytics może potrwać do 2 godzin. Istniejący obszar roboczy powinien zacząć odbierać dane w ciągu około 15 minut.

Uzyskiwanie dostępu do pulpitu nawigacyjnego

Po skonfigurowaniu obszaru roboczego usługi Log Analytics uzyskaj dostęp do pulpitu nawigacyjnego opartego na usłudze Azure Monitor, aby analizować użycie i wydajność interfejsów API.

  1. W witrynie Azure Portal przejdź do wystąpienia usługi API Management.
  2. W menu po lewej stronie w obszarze Monitorowanie wybierz pozycję Analiza. Zostanie otwarty pulpit nawigacyjny analizy.
  3. Wybierz zakres czasu dla danych.
  4. Wybierz kategorię raportu dla danych analitycznych, takich jak Oś czasu, Geografia itd.

Starsza wbudowana analiza

W niektórych warstwach usługi API Management wbudowana analiza (nazywana również starszą analizą lub klasyczną analizą) jest również dostępna w witrynie Azure Portal, a dostęp do danych analitycznych można uzyskać przy użyciu interfejsu API REST usługi API Management.

Wbudowana analiza — portal

Aby uzyskać dostęp do wbudowanej (klasycznej) analizy w witrynie Azure Portal:

  1. W witrynie Azure Portal przejdź do wystąpienia usługi API Management.
  2. W menu po lewej stronie w obszarze Monitorowanie wybierz pozycję Analiza (wersja klasyczna).
  3. Wybierz zakres czasu dla danych lub wprowadź niestandardowy zakres czasu.
  4. Wybierz kategorię raportu dla danych analitycznych, takich jak Oś czasu, Geografia itd.
  5. Opcjonalnie przefiltruj raport według co najmniej jednej innej kategorii.

Analiza — interfejs API REST

Operacje raporty w interfejsie API REST usługi API Management umożliwiają pobieranie i filtrowanie danych analitycznych dla wystąpienia usługi API Management.

Dostępne operacje zwracają rekordy raportów według interfejsu API, lokalizacji geograficznej, operacji interfejsu API, produktu, żądania, subskrypcji, czasu lub użytkownika.

Powiązana zawartość