Sprawdzone metody obsługi zgłoszeń do zespołu pomocy Google Cloud Apigee

Przeglądasz dokumentację Apigee Edge.
Przejdź do Dokumentacja Apigee X. informacje.

Przeglądasz dokumentację Apigee X.
Wyświetl Dokumentacja Apigee Edge.

Podanie szczegółowych i wymaganych informacji w zgłoszeniu do zespołu pomocy ułatwia zespół pomocy Google Cloud Apigee, który szybko i sprawnie Ci odpowie. Gdy zespół pomocy W tym przypadku brakuje istotnych szczegółów, dlatego musimy poprosić o więcej informacji, co może wiązać się w obie strony. Zajmie to więcej czasu i może spowodować opóźnienia w rozwiązaniu problemów. Z tego przewodnika po sprawdzonych metodach dowiesz się, jakich informacji potrzebujesz do rozwiązywania problemów technicznych zgłoszenia do zespołu pomocy.

Opisywanie problemu.

Problem powinien zawierać informacje wyjaśniające szczegółowo, co się stało, a co było oraz kiedy i w jaki sposób miało to miejsce. Dobre zgłoszenie do zespołu pomocy Apigee: zawierają następujące kluczowe informacje o każdej usłudze Apigee:

Najważniejsze informacje Opis Apigee Edge dla chmury publicznej Apigee Edge dla Private Cloud
Usługa Konkretna usługa Apigee, w której obserwowany problem, w tym wersja odpowiednie informacje.
  • Wersja
Szczegóły problemu Jasny i szczegółowy opis problemu wraz z pełnym opisem pojawi się jakiś komunikat o błędzie.
  • Komunikat o błędzie
  • Wynik działania narzędzia śledzenia
  • Kroki umożliwiające odtworzenie problemu
  • Kompletne żądanie lub polecenie interfejsu API
  • Komunikat o błędzie
  • Wynik działania narzędzia śledzenia
  • Kroki umożliwiające odtworzenie problemu
  • Kompletne żądanie lub polecenie interfejsu API
  • Dzienniki diagnostyczne komponentów
Godzina Dokładna sygnatura czasowa, kiedy problem pojawił się i jak długo trwał.
  • Data, godzina i strefa czasowa wystąpienia problemu.
  • Czas trwania problemu
  • Data, godzina i strefa czasowa wystąpienia problemu.
  • Czas trwania problemu
Konfiguracja Szczegółowe informacje, gdzie zaobserwowany problem.
  • Nazwa organizacji
  • Nazwa środowiska
  • Nazwa serwera proxy interfejsu API
  • Wersja
  • Topologia sieci
  • Uszkodzony komponent Edge

W sekcjach poniżej znajdziesz więcej szczegółów na temat tych koncepcji.

Produkt

Dostępne są różne usługi Apigee: Apigee Edge w chmurze publicznej Apigee Edge w Private Cloud, więc potrzebujemy określonych informacje o produkcie, którego dotyczy problem.

W poniższej tabeli zawarto kilka przykładów ilustrujących pełne informacje w kolumnie DOZWOLONE i niekompletne informacje w Kolumna NIEDOZWOLONE:

CO NALEŻY ROBIĆ DZIAŁANIA NIEZALECANE
Nie udało się wdrożyć serwera proxy interfejsu API OAuth2 w organizacji Public Cloud ...

Nie udało się wdrożyć serwera proxy interfejsu API

(musimy znać usługę Apigee, w której występuje problem).

Instalacja się nie udała. Wystąpił błąd w Edge Private Cloud w wersji 4.50.00...

Nie udało się zainstalować w konfiguracji Private Cloud.

(Brak informacji o wersji)

Szczegóły problemu

Podaj dokładne informacje o zaobserwowanym problemie, w tym komunikat o błędzie (jeśli dowolne) oraz oczekiwane i rzeczywiste zaobserwowane zachowanie.

W poniższej tabeli znajdziesz przykłady pełnych informacji w kolumnie DO. i niekompletne informacje w kolumnie NIE:

CO NALEŻY ROBIĆ DZIAŁANIA NIEZALECANE

Wystąpił błąd z nowym serwerem proxy edgemicro edgemicro_auth z powodu następującego błędu:

{"error":"missing_authorization","error_description":"Missing Authorization header"}

Utworzony dzisiaj nowy serwer proxy edgemicro nie działa

(Nazwa serwera proxy jest nieznana. Nie jest jasne, czy serwer proxy zwraca błąd nieoczekiwana odpowiedź).

Podczas gdy nasi klienci otrzymują 500 błędy z poniższym komunikatem o błędzie wysyłanie żądań do serwera proxy API:

{"fault":{"faultstring":"Execution of JSReadResponse failed with error: Javascript runtime error: \"TypeError: Cannot read property \"content\" from undefined. (JSReadResponse.js:23)","detail":{"errorcode":"steps.javascript.ScriptExecutionFailed"}}}

Podczas wysyłania żądań do serwera proxy API nasi klienci otrzymują 500 błędów.

Samo przekazanie błędów (500) nie daje nam wystarczających informacji zbadania problemu. Musimy znać rzeczywisty komunikat o błędzie oraz kod błędu, który jest obserwowane.

Godzina

Czas to bardzo ważna informacja. Inżynier pomocy musi wiedzieć, kiedy problem wystąpił po raz pierwszy, jak długo trwał i czy problem nadal występuje.

Inżynier pomocy, który rozwiązuje problem, może nie znajdować się w Twojej strefie czasowej, więc instrukcje względne co utrudnia zdiagnozowanie problemu. Dlatego zalecamy stosowanie metody Data i godzina w formacie ISO 8601 aby wskazać dokładną godzinę występowania problemu.

W tabeli poniżej znajdziesz kilka przykładów pokazujących dokładny czas i czas trwania, dla których wystąpił problem w kolumnie DOZWOLONE i niejednoznaczne lub niejasne informacje o tym, kiedy w kolumnie DON'Ts wystąpił problem:

CO NALEŻY ROBIĆ DZIAŁANIA NIEZALECANE
Wczoraj między 17:30 PDT 2020 roku od godz. 17:30 czasu PDT zarejestrowano bardzo dużą liczbę 503s. i 2020-11-06 17:35 PDT...

Ogromną liczbę zwierzaków 503s zaobserwowano wczoraj o 17:30 przez 5 minut.

(Musimy użyć dorozumianej daty i nie jest jasne, w której strefie czasowej występuje problem zaobserwowano).

Od 9.11.2020 o godz. 15:30 czasu IST zaobserwowano duże opóźnienia w następujących serwerach proxy interfejsów API do 9.11.2020 o 18:10 czasu IST...

W zeszłym tygodniu zaobserwowano duże opóźnienia w przypadku niektórych serwerów proxy interfejsów API.

(nie jest jasne, w którym dniu i jak długo zaobserwowano ten problem w ostatnim tygodniu).

Konfiguracja

Musimy wiedzieć, gdzie dokładnie występuje problem. W zależności od z usługi, której używasz, potrzebujemy tych informacji:

  • Jeśli korzystasz z Apigee Cloud, możesz mieć więcej niż jedną organizację, dlatego potrzebujemy aby poznać konkretną organizację i inne szczegóły, w których występuje problem:
    • Nazwy organizacji i środowisk
    • Nazwa serwera proxy interfejsu API i numery wersji (w przypadku nieudanych żądań do interfejsu API)
  • Jeśli korzystasz z Private Cloud , być może używasz jednej z wielu obsługiwanych opcji topologie instalacji. Musimy więc wiedzieć, jakiej topologii używasz, i poznać szczegóły, takie jak liczba w centrach danych i węzłach.

W poniższej tabeli znajdziesz przykłady pełnych informacji w kolumnie DO. i niekompletne informacje w kolumnie NIE:

CO NALEŻY ROBIĆ DZIAŁANIA NIEZALECANE

401Od 9:30 czasu CST w Edge Public Cloud wzrosła liczba błędów.

Szczegóły konfiguracji Edge:

Szczegóły dotyczące nieprawidłowego interfejsu API:
Nazwy organizacji: myorg
Nazwy środowiska: test
Nazwy serwerów proxy interfejsów API: myproxy
Numery wersji: 3

Błąd:

{"fault":{"faultstring":"Failed to resolve API Key variable request.header.X-APP-API_KEY","detail":{"errorcode":"steps.oauth.v2.FailedToResolveAPIKey"}}}

Liczba błędów: 401.

(Nie podano żadnych informacji o używanym produkcie, ponieważ zaobserwowanych danych lub szczegółów konfiguracji).

Nie udało się uruchomić procesora wiadomości w Edge Private Cloud w wersji 4.19.06 po przez dodanie kolejnych węzłów bramy.

Dzienniki diagnostyczne:
Dołączono dzienniki procesora wiadomości.

Topologia sieci:
Dołączono plik network-topology.png zawierający dodatkowe węzły.

Nie udało się uruchomić procesora wiadomości w Edge Private Cloud w wersji 4.19.06 po przez dodanie kolejnych węzłów bramy.

(Brak dzienników procesora wiadomości i topologii sieci).

Przydatne artefakty

Przesłanie nam artefaktów związanych z problemem przyspieszy jego rozwiązanie, ponieważ pomoże nam zrozumieć, co dokładnie obserwujesz, i uzyskać więcej informacji na ten temat.

W tej sekcji opisujemy kilka przydatnych artefaktów, które są pomocne we wszystkich usługach Apigee:

Wspólne artefakty wszystkich usług Apigee

Te artefakty są przydatne we wszystkich usługach Apigee: Apigee Edge w chmurze publicznej i Apigee Edge w Private Cloud:

Artefakt Opis
Wyniki narzędzia do śledzenia Dane wyjściowe narzędzia Trace zawierają szczegółowe informacje o przechodzących żądaniach do interfejsu API Usługi Apigee. Jest to przydatne w przypadku błędów działania, takich jak 4XX, 5XX i problemy z opóźnieniem.
Zrzuty ekranu Zrzuty ekranu pozwalają przedstawić kontekst rzeczywistego zachowania lub zaobserwowanego błędu. Jest pomocne w przypadku wszelkich zaobserwowanych błędów, np. w interfejsie użytkownika lub w Analytics.
HAR (Http ARchive) HAR to plik przechwytywany przez narzędzia sesji HTTP w celu debugowania wszelkich problemów z interfejsem użytkownika. Można to zrobić za pomocą przeglądarek takich jak Chrome, Firefox czy Internet Explorer.
tcpdumps Narzędzie tcpdump przechwytuje pakiety TCP/IP przesyłane lub odbierane przez Jest to przydatne w przypadku problemów związanych z siecią, takich jak błędy uzgadniania połączenia TLS 502 błędu, opóźnienia itp.

Dodatkowe artefakty Apigee Edge dla Private Cloud

W przypadku Apigee Edge dla Private Cloud możemy potrzebować dodatkowych artefaktów, które przyspieszą diagnozowanie problemów.

Artefakt Opis
Topologia sieci Diagram topologii instalacji brzegowej opisującej konfigurację Private Cloud, w tym wszystkich centrów danych, węzłów i komponentów zainstalowanych w każdym węźle.
Logi diagnostyczne komponentów brzegowych logi diagnostyczne związane z konkretnym komponentem Apigee Edge, takim jak Wiadomość. Procesor, router lub Cassandra.
Plik konfiguracji instalacji Plik konfiguracji cichej używany podczas instalowania lub uaktualniania Apigee Edge.

Ten plik pozwala sprawdzić, czy wszystkie ustawienia są prawidłowe w przypadku, gdy napotkanych problemów z instalacją lub migracją.

Zrzuty stosu Zrzuty stosu to zrzuty stosu procesu pamięci Java. Jest to pomocne, jeśli dużo pamięci W niektórych komponentach Edge występują błędy dotyczące wykorzystania lub OutOfMemory.
Zrzuty wątków Zrzut wątku to migawka wszystkich wątków uruchomionego procesu Java.

Jest to przydatne, jeśli w przypadku niektórych komponentów Edge zaobserwowano wysoki poziom obciążenia procesora lub obciążenia.

Szablony zgłoszeń i przykładowe zgłoszenia

W tej sekcji znajdziesz szablony zgłoszeń i przykładowe przypadki dla różnych usług wybranych na podstawie sprawdzone metody opisane w tym dokumencie:

Apigee Edge w chmurze publicznej

Szablon

Ta sekcja zawiera przykładowy szablon dla Apigee Edge w chmurze publicznej

Problem:

<Podaj szczegółowy opis problemu lub zaobserwowanego zachowania. W odpowiednich przypadkach podaj nazwę i wersję produktu.>

Komunikat o błędzie:

<Dołącz pełny zaobserwowany komunikat o błędzie (jeśli dotyczy)>

Problem z godziną rozpoczęcia (format ISO 8601):

Problemowy czas zakończenia (format ISO 8601):

Szczegóły konfiguracji Apigee:
Nazwy organizacji:
Nazwy środowiska:
Nazwy serwerów proxy interfejsów API:
Numery wersji:

Etapy odtwarzania:

<W miarę możliwości podaj kroki umożliwiające odtworzenie problemu>

Informacje diagnostyczne:

<Lista dołączonych plików>

Przykładowy przypadek

Ta sekcja zawiera przykładowy przypadek korzystania z usługi Apigee Cloud (Apigee w Google) Cloud/Apigee Edge w chmurze publicznej).

Problem:

W naszej chmurze publicznej widzimy dużą liczbę błędów 503 dotyczących niedostępności usługi. org. Czy możesz przeanalizować ten problem i go rozwiązać lub doradzić nam, jak go rozwiązać?

Komunikat o błędzie:

{"fault":{"faultstring":"The Service is temporarily available", "detail":{"errorcode":"messaging.adaptors.http.flow.ServiceUnavailable"}}}

Problem start time (format ISO 8601): 2020-10-04 06:30 IST

Problem z godziną zakończenia (format ISO 8601): problem nadal występuje.

Szczegóły konfiguracji Apigee:
Nazwy organizacji: myorg
Nazwy środowiska: dev
Nazwy serwerów proxy interfejsów API: myproxy
Numery wersji: 3

Etapy odtwarzania:

Uruchom to polecenie curl, aby odtworzyć problem:

curl -X GET 'https://myorg-dev.apigee.net/v1/myproxy'

Informacje diagnostyczne:

Dane wyjściowe narzędzia śledzenia (trace-503.xml)

Apigee Edge dla Private Cloud

Szablon

Ta sekcja zawiera przykładowy szablon dla Apigee Edge dla Private Cloud

Problem:

<Podaj szczegółowy opis problemu lub zaobserwowanego zachowania. W odpowiednich przypadkach podaj nazwę i wersję produktu.>

Komunikat o błędzie:

<Dołącz pełny zaobserwowany komunikat o błędzie (jeśli dotyczy)>

Problem z godziną rozpoczęcia (format ISO 8601):

Problemowy czas zakończenia (format ISO 8601):

Szczegóły konfiguracji Edge Private Cloud:

<Dołącz topologię sieci opisującą konfigurację Twojej chmury Private Cloud, w tym centra danych i węzły

Etapy odtwarzania:

<W miarę możliwości podaj kroki umożliwiające odtworzenie problemu>

Informacje diagnostyczne

<Lista dołączonych plików>

Przykładowy przypadek

W tej sekcji znajdziesz przykładowy przypadek dotyczący Apigee Edge dla Private Cloud.

Problem:

Podczas instalowania serwera zarządzania Apigee w węźle 10 Edge Private Cloud 4.19.06 w systemie Linux RHEL 7.6 napotkaliśmy ten błąd.

Komunikat o błędzie:

<snipped as the output is too long>
Checking for management-server uuid ................................................
Unable to get uuid for management-server.
Error: setup.sh: /opt/apigee/apigee-service/bin/apigee-service exited with unexpected status 1

Problem z godziną rozpoczęcia (format ISO 8601): problem występuje przy instalowaniu

Problematyczny czas zakończenia (format ISO 8601): nie dotyczy

Szczegóły konfiguracji Edge Private Cloud:

Załączony plik network-topology.png

Etapy odtwarzania:

Oto polecenie, które spowodowało błąd:

/opt/apigee/apigee-setup/bin/setup.sh -p ms -f /app/NonProdConfig.txt

Informacje diagnostyczne:

Załączony plik:

  • output.txt zawierające pełne dane wyjściowe powyższego polecenia, w tym komunikat o błędzie
  • dzienniki serwera zarządzania oraz
  • Plik konfiguracyjny NonProdConfig.txt