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

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

16 stycznia 2025 r. zastąpimy portal pomocy Apigee konsolą Google Cloud, która korzysta z usług obsługi klienta.

Obecnie wyświetlasz dokumentację Apigee X.
Zobacz dokumentację Apigee Edge.

Podanie szczegółowych i wymaganych informacji w zgłoszeniu ułatwi zespołowi pomocy Google Cloud Apigee szybkie i skuteczne udzielenie odpowiedzi. Jeśli w Twoim zgłoszeniu brakuje ważnych informacji, musimy poprosić Cię o dodatkowe informacje. Może to wymagać kilkukrotnego kontaktu z nami. Zajmuje to więcej czasu i może opóźnić rozwiązanie problemów. Ten przewodnik po najlepszych praktykach zawiera informacje, których potrzebujemy, aby szybciej rozwiązać Twój problem techniczny.

Opisz problem

Problem powinien zawierać informacje wyjaśniające, co się wydarzyło w porównaniu z tym, co miało się wydarzyć, a także kiedy i jak to się stało. W przypadku zgłoszenia do zespołu pomocy Apigee należy podać te kluczowe informacje o każdym produkcie Apigee:

Najważniejsze informacje Opis Apigee Edge for Public Cloud Apigee Edge for Private Cloud
Produkt Konkretny produkt Apigee, w którym występuje problem, w tym informacje o wersji (w stosownych przypadkach).
  • Wersja
Szczegóły problemu Jasny i szczegółowy opis problemu, w tym pełny komunikat o błędzie (jeśli występuje).
  • Komunikat o błędzie
  • Wyniki działania narzędzia do śledzenia
  • Kroki umożliwiające odtworzenie problemu
  • Wypełnij żądanie/polecenie API
  • Komunikat o błędzie
  • Wyniki działania narzędzia do śledzenia
  • Kroki umożliwiające odtworzenie problemu
  • Wypełnij żądanie/polecenie API
  • Rejestry diagnostyczne komponentów
Czas Sygnatury czasowe rozpoczęcia i zakończenia występowania problemu.
  • 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 o tym, gdzie występuje problem;
  • Nazwa organizacji
  • Nazwa środowiska
  • Nazwa serwera proxy interfejsu API
  • Wersja
  • Topologia sieci
  • Nieprawidłowy komponent Edge

W następnych sekcjach omawiamy te pojęcia bardziej szczegółowo.

Produkt

Istnieją różne usługi Apigee: Apigee Edge w chmurze publicznej i Apigee Edge w chmurze prywatnej, więc potrzebujemy szczegółowych informacji o tym, w której usłudze występuje problem.

W tabeli poniżej znajdziesz kilka przykładów pokazujących pełne informacje w kolumnie DOs i niepełne informacje w kolumnie DON'Ts:

 DOS NIE
Wdrożenie serwera proxy interfejsu API OAuth2 zakończyło się niepowodzeniem w organizacji Public Cloud ...

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

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

Instalacja nie powiodła się z powodu tego błędu w chmurze prywatnej Edge w wersji 4.50.00 ...

Instalacja nie powiodła się w naszej konfiguracji chmury prywatnej.

(Brak informacji o wersji)

Szczegóły problemu

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

W tabeli poniżej znajdziesz przykłady, w których kolumna DOs zawiera pełne informacje, a kolumna DON'Ts – niepełne informacje:

 DOS NIE

Nowy serwer proxy edgemicro edgemicro_auth nie działa z powodu tego błędu:

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

Nowy serwer proxy edgemicro utworzony dzisiaj nie działa

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

Podczas wysyłania żądań do serwera proxy interfejsu API nasi klienci otrzymują błędy 500 z tym komunikatem:

{"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 interfejsu API nasi klienci otrzymują błędy 500.

(Przekazywanie tylko informacji o błędach 500 nie daje nam wystarczających informacji do zbadania problemu. Musimy poznać komunikat o błędzie i kod błędu, które występują w Twoim przypadku.

Godzina

Czas jest bardzo ważną informacją. Inżynier ds. pomocy technicznej musi wiedzieć, kiedy problem został zauważony po raz pierwszy, jak długo trwał i czy nadal występuje.

Inżynier pomocy, który rozwiązuje problem, może nie być z Twojego obszaru czasowego, więc względne informacje o czasie utrudniają diagnozowanie problemu. Dlatego zalecamy używanie formatu ISO 8601 do oznaczania daty i godziny, aby podać dokładną godzinę, w której wystąpił problem.

W tabeli poniżej znajdziesz przykłady pokazujące dokładny czas i czas trwania problemu w kolumnie DOs oraz niejednoznaczne lub niejasne informacje o czasie wystąpienia problemu w kolumnie DON'Ts:

 DOS NIE
Wczoraj między 2020-11-06 17:30 czasu PDT a 2020-11-06 17:35 czasu PDT zaobserwowano ogromną liczbę 503s.

Wczoraj o 17:30 przez 5 min obserwowano ogromną liczbę 503s.

(musimy użyć sugerowanej daty. Nie wiadomo też, w której strefie czasowej wystąpił problem).

Wysokie opóźnienia zostały zaobserwowane w przypadku tych serwerów proxy interfejsu API w okresie od 2020-11-09 15:30 IST do 2020-11-09 18:10 IST ...

W zeszłym tygodniu zaobserwowaliśmy wysokie opóźnienia w przypadku niektórych serwerów proxy interfejsu API.

(Nie wiadomo, w którym dniu i jak długo w ciągu ostatniego tygodnia wystąpił ten problem).

Konfiguracja

Musimy znać szczegóły dotyczące tego, gdzie dokładnie występuje problem. W zależności od tego, z jakiego produktu korzystasz, potrzebujemy tych informacji:

  • Jeśli korzystasz z Apigee Cloud, możesz mieć więcej niż jedną organizację, więc musimy znać konkretną organizację i inne szczegóły, w których występuje problem:
    • nazwy organizacji i środowiska;
    • nazwa proxy interfejsu API i numery wersji (w przypadku niepowodzeń żądań do interfejsu API),
  • Jeśli korzystasz z chmury prywatnej , możesz używać jednej z wielu obsługiwanych topologii instalacji. Musimy więc znać topologię, której używasz, w tym takie szczegóły jak liczba centrów danych i węzłów.

W tabeli poniżej znajdziesz przykłady, w których kolumna DOs zawiera pełne informacje, a kolumna DON'Ts – niepełne informacje:

 DOS NIE

401 Liczba błędów w chmurze publicznej Edge wzrosła od 2020-11-06 09:30 CST.

Szczegóły konfiguracji Edge:

Szczegóły niedziałającego interfejsu API:
  Nazwy organizacji: myorg
  Nazwy środowisk: test
  Nazwy serwerów proxy 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"}}}

401 Wystąpiło więcej błędów.

(Nie zawiera on żadnych informacji o używanym produkcie, czasie wystąpienia problemu ani szczegółów konfiguracji).

Nie można uruchomić usługi Message Processor w wersji 4.19.06 usługi Edge Private Cloud po dodaniu dodatkowych węzłów bramy.

Logi diagnostyczne:
Załączono logi procesora wiadomości.

Topologia sieci:
Załączony plik network-topology.png zawiera dodatkowe węzły.

Nie można uruchomić usługi Message Processor w wersji 4.19.06 usługi Edge Private Cloud po dodaniu dodatkowych węzłów bramy.

(Braki logów usługi Message Processor i topologii sieci).

Przydatne elementy

Przekazanie nam artefaktów związanych z problemem przyspieszy jego rozwiązanie, ponieważ pomoże nam to zrozumieć dokładniej obserwowane przez Ciebie zachowanie i uzyskać więcej informacji na jego temat.

W tej sekcji opisano przydatne elementy, które są przydatne we wszystkich usługach Apigee:

Elementy wspólne dla wszystkich usług Apigee

Te elementy są przydatne we wszystkich usługach Apigee: Apigee Edge w chmurze publicznej i Apigee Edge w chmurze prywatnej:

Artefakt Opis
Dane wyjściowe narzędzia Śledzenie Wyjście narzędzia Trace zawiera szczegółowe informacje o żądaniach interfejsu API przesyłanych przez usługi Apigee. Jest to przydatne w przypadku błędów środowiska wykonawczego, takich jak 4XX, 5XX i problemy z opóźnieniami.
Zrzuty ekranu Zrzuty ekranu pomagają przekazać kontekst rzeczywistego zachowania lub błędu. Jest to przydatne w przypadku błędów lub problemów, które występują w interfejsie użytkownika lub Analytics.
HAR (archiwum HTTP) Plik HAR jest przechwytywany przez narzędzia do przechwytywania sesji HTTP w celu debugowania problemów związanych z interfejsem użytkownika. Możesz to zrobić w przeglądarce, np. Chrome, Firefox lub Internet Explorer.
tcpdumps Narzędzie tcpdump przechwytuje pakiety TCP/IP przesyłane lub odbierane przez sieć. Jest to przydatne w przypadku problemów z siecią, takich jak błędy w procesie TLS, błędy 502, opóźnienia itp.

Dodatkowe elementy Apigee Edge for Private Cloud

W przypadku Apigee Edge for Private Cloud możemy potrzebować dodatkowych artefaktów, które ułatwią szybszą diagnostykę problemów.

Artefakt Opis
Topologia sieci Diagram topologii instalacji Edge opisujący konfigurację prywatnej chmury, w tym wszystkie centra danych, węzły i komponenty zainstalowane w każdym węźle.
Rejestry diagnostyczne komponentów Edge Logi diagnostyczne powiązane z określonym komponentem Apigee Edge, takim jak Message Processor, Router czy Cassandra.
Plik konfiguracji instalacji Plik konfiguracji w trybie cichym, który jest używany podczas instalowania lub aktualizowania Apigee Edge.

Ten plik jest przydatny do sprawdzania, czy wszystkie ustawienia są prawidłowe w przypadku problemów z instalacją lub migracją.

Zrzuty stosu Zrzuty stosu to migawka procesu pamięci Java. Jest to przydatne, jeśli w przypadku niektórych komponentów przeglądarki Edge występuje wysokie wykorzystanie pamięci lub błędy OutOfMemory.
Pamięć podręczna wątku Wydruk wątku to zrzut wszystkich wątków uruchomionego procesu Java.

Jest to przydatne, jeśli w przypadku niektórych komponentów Edge występuje wysokie obciążenie procesora lub obciążenie.

Szablony i przykładowe przypadki

W tej sekcji znajdziesz szablony i przykładowe przypadki dotyczące różnych usług oparte na opisanych w tym dokumencie sprawdzonych metodach:

Apigee Edge w chmurze publicznej

Szablon

W tej sekcji znajdziesz przykładowy szablon Apigee Edge w Public Cloud.

Problem:

<Podaj szczegółowy opis problemu lub zachowania, które obserwujesz. W stosownych przypadkach podaj nazwę i wersję produktu.>

Komunikat o błędzie:

<Include the complete error message (if any)>

Czas rozpoczęcia problemu (w formacie ISO 8601):

Czas zakończenia problemu (format ISO 8601):

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

Kroki do odtworzenia błędu:

<Podaj czynności, które prowadzą do wystąpienia problemu (jeśli to możliwe)>

Informacje diagnostyczne:

<Lista załączonych plików>

Przykładowy przypadek

W tej sekcji znajdziesz przykładowy przypadek użycia dotyczący Apigee Cloud (Apigee w Google Cloud lub Apigee Edge w Public Cloud).

Problem:

odnotowujemy dużą liczbę błędów 503 „Usługa niedostępna” w organizacji Public Cloud. Czy możesz zająć się tym problemem i go rozwiązać lub doradzić, jak to zrobić?

Komunikat o błędzie:

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

Czas rozpoczęcia problemu (w formacie ISO 8601): 2020-10-04 06:30 IST

Problem end time (czas zakończenia problemu) w formacie ISO 8601: problem nadal występuje.

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

Kroki do odtworzenia błędu:

Aby odtworzyć problem, uruchom to polecenie curl:

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

Informacje diagnostyczne:

Wyjście narzędzia Śledzenie (trace-503.xml)

Apigee Edge for Private Cloud

Szablon

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

Problem:

<Podaj szczegółowy opis problemu lub zachowania, które obserwujesz. W stosownych przypadkach podaj nazwę i wersję produktu.>

Komunikat o błędzie:

<Include the complete error message (if any)>

Czas rozpoczęcia problemu (w formacie ISO 8601):

Czas zakończenia problemu (format ISO 8601):

Szczegóły konfiguracji Edge Private Cloud:

<Załącz topologię sieci, która opisuje konfigurację Twojej chmury prywatnej, w tym centra danych i węzły>

Kroki do odtworzenia błędu:

<Podaj czynności, które prowadzą do wystąpienia problemu (jeśli to możliwe)>

Informacje diagnostyczne

<List of files attached>

Przykładowy przypadek

Ta sekcja zawiera przykładowy przypadek użycia Apigee Edge for Private Cloud.

Problem:

Podczas instalowania serwera Apigee Management na węźle 10 w ramach Edge Private Cloud 4.19.06 na Linux RHEL 7.6 wystąpił 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 start time (format ISO 8601): występuje zawsze, gdy instalujemy

Problem end time(czas zakończenia problemu) w formacie ISO 8601: nie dotyczy

Szczegóły konfiguracji Edge Private Cloud:

Załączony plik network-topology.png

Kroki do odtworzenia błędu:

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

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

Informacje diagnostyczne:

Załączam te pliki:

  • output.txt zawierający pełny wynik polecenia, w tym komunikat o błędzie.
  • Dzienniki serwera zarządzania i
  • Plik konfiguracji NonProdConfig.txt