Korzystanie z narzędzia śledzenia

Wyświetlasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X.
info

Czym jest narzędzie do śledzenia?

Śledzenie to narzędzie do rozwiązywania problemów i monitorowania serwerów proxy interfejsów API działających w Apigee Edge. Narzędzie do śledzenia umożliwia sprawdzenie szczegółów każdego kroku w przepływie proxy interfejsu API.

Obejrzyj ten film, aby zapoznać się z narzędziem do śledzenia.

Jak korzystać z funkcji śledzenia

Trace jest łatwy w użyciu. Rozpoczynasz sesję logu, a następnie wywołujesz interfejs API na platformie Edge i odczytujesz wyniki.

  1. Otwórz stronę serwerów proxy interfejsów API zgodnie z opisem poniżej.

    Edge

    Aby uzyskać dostęp do strony serwerów proxy interfejsu API za pomocą interfejsu Edge:

    1. Zaloguj się na apigee.com/edge.
    2. Na pasku nawigacyjnym po lewej stronie kliknij Develop > API Proxies (Programowanie > Serwery proxy interfejsu API).

    Nowy interfejs Edge (chmura prywatna)

    Aby uzyskać dostęp do strony serwerów proxy interfejsu API za pomocą nowego interfejsu Edge:

    1. Zaloguj się w nowym interfejsie Edge pod adresem http://host:3001/edge, gdzie host to adres IP lub nazwa DNS hosta, na którym działa nowy interfejs Edge.
    2. Na pasku nawigacyjnym po lewej stronie kliknij Develop > API Proxies (Programowanie > Serwery proxy interfejsu API).
  2. Wybierz proxy interfejsu API na stronie Proxy interfejsów API.
  3. Upewnij się, że interfejs API, który chcesz śledzić, jest wdrożony.
  4. Kliknij Śledzenie, aby przejść do widoku narzędzia do śledzenia.
  5. W menu Wdrożenie do śledzenia wybierz środowisko wdrożenia i wersję serwera proxy, które chcesz śledzić.
  6. Kliknij Start Trace Session (Rozpocznij sesję śledzenia). Gdy sesja śledzenia jest aktywna, serwer proxy interfejsu API rejestruje szczegóły każdego kroku w potoku przetwarzania. Podczas sesji śledzenia wiadomości i dane kontekstowe są przechwytywane z ruchu na żywo.

  7. Jeśli przez serwer proxy nie przepływa żaden ruch na żywo, po prostu wyślij żądanie do interfejsu API. Do wysłania żądania możesz użyć dowolnego narzędzia, np. curl, Postman lub innego, które znasz. Możesz też wysłać żądanie bezpośrednio z narzędzia do śledzenia. Wystarczy wpisać adres URL i kliknąć Wyślij. Uwaga: za pomocą narzędzia do śledzenia możesz wysłać tylko żądanie GET, ale nie żądanie POST.

    Uwaga: 1 sesja śledzenia może obsługiwać 10 transakcji żądania/odpowiedzi na procesor komunikatów przez wybrany serwer proxy interfejsu API. W chmurze Edge z 2 procesorami komunikatów obsługującymi ruch obsługiwanych jest 20 transakcji żądania/odpowiedzi. Sesja śledzenia zatrzymuje się automatycznie po 10 minutach, jeśli nie zatrzymasz jej ręcznie.
  8. Gdy przechwycisz wystarczającą liczbę żądań, kliknij Zatrzymaj sesję śledzenia.
  9. W menu po lewej stronie wyświetli się lista przechwyconych transakcji żądania/odpowiedzi. Kliknij dowolną transakcję, aby wyświetlić szczegółowe wyniki.

Jak odczytać logi śledzenia

Narzędzie do śledzenia składa się z 2 głównych części: mapy transakcji i szczegółów fazy:

  • Mapa transakcji używa ikon do oznaczania każdego istotnego kroku, który występuje podczas transakcji serwera proxy interfejsu API, w tym wykonywania zasad, kroków warunkowych i przejść. Najedź kursorem na dowolną ikonę, aby wyświetlić podsumowanie. Kroki przepływu żądań są widoczne u góry mapy transakcji, a kroki przepływu odpowiedzi – u dołu.
  • Sekcja szczegółów fazy narzędzia zawiera informacje o wewnętrznym przetwarzaniu serwera proxy, w tym o ustawionych lub odczytanych zmiennych, nagłówkach żądań i nagłówkach odpowiedzi oraz wiele innych. Kliknij dowolną ikonę, aby wyświetlić szczegóły fazy dla danego kroku.

Oto przykładowa mapa narzędzia do śledzenia z oznaczonymi głównymi segmentami przetwarzania serwera proxy:

Mapa transakcji narzędzia do śledzenia

Legenda mapy transakcji

W tabeli poniżej opisano znaczenie ikon, które zobaczysz na mapie transakcji. Te ikony oznaczają poszczególne istotne etapy przetwarzania w przepływie proxy.

Ikony mapy transakcji

Aplikacja kliencka, która wysyła żądanie do punktu końcowego ProxyEndpoint serwera proxy interfejsu API.
Kółka oznaczają przejściowe punkty końcowe w przepływie serwera proxy. Są one obecne, gdy żądanie przychodzi od klienta, gdy żądanie trafia do celu, gdy odpowiedź wraca z celu i gdy odpowiedź wraca do klienta.

Wysokie słupki wskazują początek segmentu przepływu w przepływie serwera proxy interfejsu API. Segmenty przepływu to: żądanie ProxyEndpoint, żądanie TargetEndpoint, odpowiedź TargetEndpoint i odpowiedź ProxyEndpoint. Segment obejmuje PreFlow, przepływy warunkowe i PostFlow.

Więcej informacji znajdziesz w artykule o konfigurowaniu przepływów.

Wskazuje, że działania Analytics miały miejsce w tle.

Przepływ warunkowy, który przyjmuje wartość „true”. Wprowadzenie do przepływów warunkowych znajdziesz w artykule Konfigurowanie przepływów.

Pamiętaj, że niektóre warunki są generowane przez Edge. Oto przykład wyrażenia, którego Edge używa do sprawdzenia, czy w punkcie końcowym serwera proxy wystąpił błąd:

((error.state equals PROXY_REQ_FLOW) or (error.state equals PROXY_RESP_FLOW))

Przepływ warunkowy, który przyjmuje wartość „false”. Wprowadzenie do przepływów warunkowych znajdziesz w artykule Konfigurowanie przepływów.

Pamiętaj, że niektóre warunki są generowane przez Edge. Na przykład poniżej znajduje się wyrażenie, którego Edge używa do sprawdzenia, czy w TargetEndpoint wystąpił błąd:

(((error.state equals TARGET_REQ_FLOW) or (error.state equals TARGET_RESP_FLOW)) or ((error.state equals REQ_SENT) or (error.state equals RESP_START)))

Zasady. Każdy typ zasady ma unikalną ikonę. Ten jest przeznaczony dla zasady AssignMessage. Te ikony pokazują, czy zasady są wykonywane we właściwej kolejności i czy ich wykonanie się powiodło. Możesz kliknąć ikonę zasady, aby zobaczyć wyniki jej wykonania i sprawdzić, czy są zgodne z oczekiwaniami. Możesz na przykład sprawdzić, czy wiadomość została prawidłowo przekształcona lub czy jest przechowywana w pamięci podręcznej.

Prawidłowo działające zasady są wyraźnie oznaczone znacznikami wyboru. W przypadku błędu na ikonie pojawi się czerwony wykrzyknik.

Wskazówka: zwróć uwagę na etykietkę lub oś czasu, aby sprawdzić, czy któraś zasada nie trwa dłużej, niż oczekiwano.

Pojawia się, gdy celem backendu jest aplikacja Node.js. Zobacz Omówienie Node.js w Apigee Edge.
Cel w backendzie wywoływany przez serwer proxy interfejsu API.
Oś czasu pokazuje, ile czasu (w milisekundach) zajęło przetwarzanie. Porównanie segmentów czasu, który upłynął, pomaga wyizolować zasady, których wykonanie trwa najdłużej i które spowalniają wywołania interfejsu API.
Epsilon oznacza przedział czasu krótszy niż milisekunda.

Wyłączono. Pojawia się na ikonie zasady, gdy zasada jest wyłączona. Zasadę można wyłączyć za pomocą publicznego interfejsu API. Zobacz Dokumentację konfiguracji serwera proxy interfejsu API.

Błąd. Pojawia się na ikonie zasady, gdy warunek kroku zasady ma wartość false (patrz Zmienne przepływu i warunki), lub na ikonie zasady RaiseFault, gdy zasada RaiseFault jest wykonywana.
Pominięto. Pojawia się na ikonie zasady, gdy zasada nie została wykonana, ponieważ warunek kroku został oceniony jako fałszywy. Więcej informacji znajdziesz w artykule Zmienne i warunki przepływu.

Omówienie szczegółów fazy

Sekcja Szczegóły fazy narzędzia zawiera wiele informacji o stanie serwera proxy na każdym etapie przetwarzania. Oto niektóre informacje podane w sekcji Szczegóły fazy. Kliknij dowolną ikonę w narzędziu do śledzenia, aby wyświetlić szczegóły wybranego kroku, lub użyj przycisków Dalej/Wstecz, aby przechodzić między krokami.

Szczegóły fazy Opis
Punkt końcowy proxy Wskazuje, który przepływ ProxyEndpoint został wybrany do wykonania. Serwer proxy interfejsu API może mieć wiele nazwanych punktów końcowych serwera proxy.
Zmienne

Zawiera listę zmiennych przepływu, które zostały odczytane i którym przypisano wartość przez zasadę. Zobacz też Zarządzanie stanem serwera proxy za pomocą zmiennych przepływu.

Uwaga:

  • Znak równości (=) wskazuje wartość przypisaną do zmiennej.
  • Przekreślony znak równości (≠) oznacza, że zmiennej nie można przypisać wartości, ponieważ jest ona tylko do odczytu lub wystąpił błąd podczas wykonywania zasady.
  • Puste pole oznacza, że wartość zmiennej została odczytana.
Nagłówki żądań Wyświetla listę nagłówków żądań HTTP.
Treść żądania Wyświetla treść żądania HTTP.
Właściwości Właściwości reprezentują stan wewnętrzny serwera proxy interfejsu API. Domyślnie nie są one wyświetlane.
Docelowy punkt końcowy Wskazuje, który element TargetEndpoint został wybrany do wykonania.
Nagłówki odpowiedzi Wyświetla listę nagłówków odpowiedzi HTTP.
Treść odpowiedzi Wyświetla treść odpowiedzi HTTP.
PostClientFlow Wyświetla informacje o PostClientFlow, który jest wykonywany po zwróceniu żądania do aplikacji klienckiej. Do PostClientFlow można dołączyć tylko zasady MessageLogging. PostClientFlow jest obecnie używany głównie do pomiaru przedziału czasu między sygnaturami czasowymi rozpoczęcia i zakończenia wiadomości z odpowiedzią.

Ulepszanie przechwytywania wiadomości za pomocą filtrów

Możesz filtrować żądania wyświetlane w narzędziu do śledzenia, określając wartości nagłówka lub parametru zapytania. Filtry umożliwiają kierowanie na konkretne połączenia, które mogą powodować problemy. Możesz na przykład skupić się na żądaniach, które zawierają określone treści, lub na żądaniach pochodzących od określonych partnerów lub aplikacji. Możesz filtrować według:

  • Nagłówki HTTP – ogranicz śledzenie tylko do wywołań zawierających określony nagłówek. To dobry sposób na rozwiązywanie problemów. Możesz wysłać nagłówek do dewelopera aplikacji i poprosić go o uwzględnienie go w wywołaniu, które powoduje problemy. Następnie Apigee Edge będzie rejestrować tylko wywołania z tym konkretnym nagłówkiem, aby umożliwić Ci sprawdzenie wyników.
  • Parametry zapytania – nagrywane będą tylko połączenia z określoną wartością parametru.

Co musisz wiedzieć o funkcji filtrowania

  • Po określeniu parametrów filtra w polach filtra musisz ponownie uruchomić sesję Trace.
  • Parametry filtra są połączone operatorem ORAZ. Aby dopasowanie się powiodło, w żądaniu muszą być obecne wszystkie określone pary nazwa/wartość zapytania lub nagłówka.
  • Narzędzie Filtry nie obsługuje dopasowywania wzorców.
  • W parametrach i wartościach filtrów wielkość liter ma znaczenie.

Jak utworzyć filtr logów czasu

  1. Jeśli sesja śledzenia jest uruchomiona, zatrzymaj ją, klikając Zatrzymaj sesję śledzenia.
  2. Kliknij Filtry w lewym górnym rogu narzędzia do śledzenia, aby rozwinąć pole Filtry.

    W narzędziu do śledzenia etykieta paska bocznego Filtry jest zakreślona.
  3. W polu Filtry określ parametr zapytania lub wartości nagłówka, według których chcesz filtrować. W tym przykładzie określamy 2 parametry zapytania, według których chcemy filtrować. Aby dopasowanie się powiodło, w żądaniu muszą być obecne oba parametry.

    W narzędziu do śledzenia w sekcji Filtry, w sekcji Parametr zapytania, ustawione są 2 przykładowe nazwy i wartości.
  4. Rozpocznij sesję śledzenia.
  5. wywoływać interfejsy API, Tylko żądania, które zawierają wszystkie określone nagłówki lub parametry zapytania, dają prawidłowe dopasowanie.

W sekcji Transakcje wyświetlają się 4 wyniki, które pasują do 2 wstępnie ustawionych parametrów zapytania.

W powyższym przykładzie to wywołanie interfejsu API pojawi się w Trace:

http://docs-test.apigee.net/cats?name=Penny&breed=Calico

Nie spowoduje to jednak:

http://docs-test.apigee.net/cats?name=Penny

Debugowanie za pomocą Trace

Narzędzie do śledzenia pozwala zobaczyć wiele wewnętrznych szczegółów dotyczących serwera proxy interfejsu API. Na przykład:

  • Możesz szybko sprawdzić, które zasady są wykonywane prawidłowo, a które nie.
  • Załóżmy, że na jednym z paneli Analytics zauważysz, że jeden z Twoich interfejsów API ma nietypowy spadek wydajności. Teraz możesz użyć Trace, aby zidentyfikować, gdzie występuje wąskie gardło. Ślad podaje czas (w milisekundach) potrzebny na wykonanie każdego kroku przetwarzania. Jeśli zauważysz, że jeden z etapów trwa zbyt długo, możesz podjąć działania naprawcze.
  • Przeglądając szczegóły fazy, możesz sprawdzić nagłówki wysyłane do backendu, wyświetlić zmienne ustawione przez zasady itd.
  • Weryfikując ścieżkę podstawową, możesz upewnić się, że zasada kieruje wiadomość na właściwy serwer.

Wybieranie opcji widoku

Wybierz opcje widoku sesji logu czasu.

Opcja Opis
Pokaż wyłączone zasady Wyświetl wyłączone zasady. Zasadę można wyłączyć za pomocą publicznego interfejsu API. Zobacz dokumentację konfiguracji serwera proxy interfejsu API.
Pokaż pominięte fazy Pokaż wszystkie pominięte fazy. Pominięta faza występuje, gdy zasada nie została wykonana, ponieważ warunek kroku został oceniony jako fałszywy. Więcej informacji znajdziesz w artykule Zmienne i warunki przepływu.
Pokaż wszystkie informacje o przepływach Reprezentują przejścia w segmencie przepływu.
Automatycznie porównaj wybraną fazę Porównuje wybraną fazę z poprzednią. Wyłącz tę opcję, aby zobaczyć tylko wybraną fazę.
Pokaż zmienne Pokaż lub ukryj zmienne, które zostały odczytane lub którym przypisano wartość.
Wyświetlanie właściwości Właściwości reprezentują stan wewnętrzny serwera proxy interfejsu API. (domyślnie ukryte).

Pobieranie wyników śledzenia

Możesz pobrać plik XML z nieprzetworzonymi wynikami śledzenia, aby wyświetlać i przeszukiwać je offline w edytorze tekstu. Plik zawiera pełne szczegóły sesji nasłuchiwania, w tym zawartość wszystkich nagłówków, zmiennych i zasad.

Aby pobrać, kliknij Pobierz sesję logów czasu.

Wyświetlanie żądań jako curl

Po prześledzeniu wywołania interfejsu API do serwera docelowego możesz wyświetlić żądanie jako polecenie curl. Jest to szczególnie przydatne podczas debugowania z kilku powodów:

  • Serwer proxy interfejsu API może zmodyfikować żądanie, dlatego warto sprawdzić, czym różni się żądanie wysłane z serwera proxy do serwera docelowego od pierwotnego żądania. Polecenie curl reprezentuje zmodyfikowane żądanie.
  • W przypadku większych ładunków wiadomości curl umożliwia wyświetlanie nagłówków HTTP i treści wiadomości w jednym miejscu. (Obecnie obowiązuje limit około 1000 znaków. Wskazówki, jak ominąć ten limit, znajdziesz w tym poście na karcie Społeczność).

Ze względów bezpieczeństwa funkcja curl maskuje nagłówek autoryzacji HTTP.

Aby zobaczyć żądania jako curl po przejściu wywołania interfejsu API w narzędziu Trace, wybierz etap „Żądanie wysłane do serwera docelowego” na diagramie mapy transakcji, a następnie kliknij przycisk Pokaż curl w kolumnie „Żądanie wysłane do serwera docelowego” w okienku szczegółów fazy.

Adnotacje na obrazie wskazują przycisk Pokaż polecenie curl i jedno z kółek na diagramie mapy transakcji.

Korzystanie z funkcji śledzenia przez zespół pomocy Apigee

Domyślnie Apigee Edge pozwala zespołowi pomocy Apigee używać narzędzia śledzenia na serwerach proxy interfejsu API, aby zapewniać wsparcie. W każdej chwili możesz wyłączyć tę opcję. Wyłączenie tej opcji może jednak ograniczyć możliwość zapewniania pomocy przez Apigee.

Aby wyłączyć narzędzie śledzenia Apigee przez zespół pomocy Apigee:

  1. Zaloguj się na https://apigee.com/edge.
  2. Na pasku nawigacyjnym po lewej stronie kliknij Administracja > Prywatność i bezpieczeństwo.
  3. Kliknij przełącznik Włącz pomoc Apigee dla śledzenia, aby wyłączyć korzystanie z narzędzia Trace przez zespół pomocy Apigee.