Włączam dzienniki debugowania NGINX na routerach

Wyświetlasz dokumentację Apigee Edge.
Przejdź do dokumentacji Apigee X. info

W Apigee routery są domyślnie skonfigurowane tak, aby rejestrować w plikach dziennika błędów tylko komunikaty o błędach. Może jednak wystąpić wiele sytuacji, w których trzeba będzie zebrać więcej informacji, aby ustalić przyczynę konkretnego błędu. Jednym ze sposobów jest skonfigurowanie routera do działania w trybie debugowania, aby można było uzyskać dzienniki debugowania, które mogą pomóc w uzyskaniu więcej informacji o błędzie i szybszym jego rozwiązaniu.

Z tego dokumentu dowiesz się, jak włączyć dzienniki debugowania na routerze Apigee Edge w przypadku żądań wysyłanych do konkretnego hosta wirtualnego. Rejestrowanie debugowania można włączyć, aby rejestrować więcej informacji w przypadku problemów, takich jak nieprawidłowe żądanie, błąd 400 Nieprawidłowe żądanie – błąd certyfikatu SSL, na Northbound (między aplikacją klienta a routerem).

Zanim zaczniesz

  • Jeśli nie znasz dzienników błędów NGINX i poziomów rejestrowania, zapoznaj się z dokumentacją dziennika błędów NGINX.
  • Zbierz nazwy organizacji, środowiska i hosta wirtualnego żądań API, w przypadku których chcesz zebrać informacje o debugowaniu.

Włączanie dzienników debugowania NGINX na routerach

W tej sekcji dowiesz się, jak włączyć dzienniki debugowania na routerach Edge.

Określanie odpowiedniego pliku konfiguracji hosta wirtualnego

Poniższe kroki opisują, jak znaleźć odpowiedni plik konfiguracji hosta wirtualnego na routerze:

  1. Jeśli znasz nazwę organizacji, nazwę środowiska i hosta wirtualnego konkretnego żądania API , które chcesz debugować, określ plik konfiguracyjny hosta wirtualnego w ten sposób:
    1. Otwórz katalog /opt/nginx/conf.d/.
    2. W katalogu conf.d wyszukaj plik ORG_NAME_ENV_NAME_VIRTUALHOST.conf za pomocą tego polecenia: 
      ls -ltrh | grep "ORG_NAME_ENV_NAME_VIRTUALHOST_NAME"

  2. Jeśli nie znasz nazwy organizacji, możesz zidentyfikować plik konfiguracji hosta wirtualnego używając nazwy aliasu hosta używanej w żądaniu do interfejsu API, w ten sposób:

    Otwórz katalog /opt/nginx/conf.d/ i wyszukaj hostalias, za pomocą którego zostało wysłane żądanie, za pomocą tego polecenia: 

    ls -ltrh | grep -r 'HOST_ALIAS_NAME'

    Przykładowe dane wyjściowe:

    Załóżmy, że nazwa aliasu hosta to opdk.cert-test.com. Gdy uruchomisz polecenie ls -ltrh, zobaczysz dane wyjściowe jak poniżej:

Włączanie rejestrowania debugowania w przypadku konkretnego hosta wirtualnego na routerze

Poniższe kroki opisują, jak włączyć dzienniki debugowania na routerach Apigee w przypadku konkretnego hosta wirtualnego.

  1. Otwórz ten plik na maszynie routera w edytorze: /opt/nginx/conf.d/ORG_NAME_ENV_NAME_VIRTUALHOST_NAME.conf. Na przykład: 
    vi /opt/nginx/conf.d/ORG_NAME_ENV_NAME_VIRTUALHOST_NAME.conf
  2. Zmień ten wiersz: 
    error_log /opt/apigee/var/log/edge-router/nginx/ORG_NAME~ENV_NAME.PORT_error_log error;

    do 

    error_log /opt/apigee/var/log/edge-router/nginx/ORG_NAME~ENV_NAME.PORT_error_log info;
  3. Zapisz zmiany.
  4. Uruchom polecenie ponownego wczytania NGINX. Na przykład: 
    sudo /opt/nginx/scripts/apigee-nginx reload
  5. Ten plik będzie teraz rejestrować dzienniki debugowania: 
    /opt/apigee/var/log/edge-router/nginx/ORG_NAME~ENV_NAME.PORT_error_log
  6. Jeśli chcesz rejestrować dzienniki debugowania na więcej niż 1 routerze, powtórz te czynności na każdym z nich.

Sprawdzanie, czy informacje o debugowaniu są rejestrowane w pliku dziennika błędów NGINX

  1. Gdy klienci wysyłają żądania API na alias hosta i port powiązany z konfiguracją hosta wirtualnego dzienniki debugowania są rejestrowane w tym pliku:

    /opt/apigee/var/log/edge-router/nginx/ORG_NAME~ENV_NAME.PORT_error_log

  2. Sprawdź, czy widzisz informacje o debugowaniu żądań API, jak pokazano w tym przykładzie:

    Przykładowe informacje o debugowaniu:

    2021/01/27 02:48:40 [warn] 27624#27624: *3777 a client request body is buffered to a temporary file /opt/apigee/var/log/edge-router/nginx/client_temp/0000000001, client: XX.XX.XX.XX, server: XX.XX.XX.XX, request: "POST /post-no-target HTTP/1.1", host: "XX.XX.XX.XX:443"

    Informacje pokazane powyżej zostaną zarejestrowane, gdy klient wyśle żądanie POST z dużym ładunkiem. Ten dziennik będzie widoczny tylko wtedy, gdy włączone jest rejestrowanie debugowania.

  3. Jeśli nie widzisz dodatkowych informacji o debugowaniu, sprawdź, czy prawidłowo wykonano wszystkie czynności opisane w sekcji Włączanie rejestrowania debugowania w przypadku konkretnego hosta wirtualnego na routerze. Jeśli pominiesz jakiś krok, powtórz wszystkie czynności.
  4. Jeśli nadal nie możesz uzyskać informacji o debugowaniu, skontaktuj się z zespołem pomocy Apigee Edge.

Wyłączanie dzienników debugowania w przypadku konkretnego hosta wirtualnego na routerze

W tej sekcji dowiesz się, jak wyłączyć dzienniki debugowania na routerze w przypadku konkretnego hosta wirtualnego.

  1. Otwórz ten plik na maszynie routera w edytorze: /opt/nginx/conf.d/ORG_NAME_ENV_NAME_VIRTUALHOST_NAME.conf Na przykład: 
    vi /opt/nginx/conf.d/ORG_NAME_ENV_NAME_VIRTUALHOST_NAME.conf

  2. Zmień ten wiersz: 

    error_log /opt/apigee/var/log/edge-router/nginx/ORG_NAME~ENV_NAME.PORT_error_log info;

    do 

    error_log /opt/apigee/var/log/edge-router/nginx/ORG_NAME~ENV_NAME.PORT_error_log error;
  3. Zapisz zmiany.
  4. Uruchom polecenie ponownego wczytania NGINX. Na przykład: 
    /opt/nginx/scripts/apigee-nginx reload
  5. Ten plik będzie teraz rejestrować tylko dzienniki błędów: 
    /opt/apigee/var/log/edge-router/nginx/ORG_NAME~ENV_NAME.PORT_error_log
  6. Jeśli chcesz zatrzymać rejestrowanie dzienników debugowania na więcej niż 1 routerze, powtórz te czynności na każdym z nich.

Sprawdzanie, czy w pliku dziennika błędów NGINX są rejestrowane tylko informacje o błędach

  1. Wyślij kilka żądań API na alias hosta i port powiązany z konkretną konfiguracją hosta wirtualnego lub poczekaj, aż klienci wyślą żądania.
  2. Sprawdź ten plik: /opt/apigee/var/log/edge-router/nginx/ORG_NAME~ENV_NAME.PORT_error_log
  3. Sprawdź, czy widzisz tylko informacje o błędach, a informacje o debugowaniu nie są już rejestrowane w przypadku żądań.
  4. Jeśli nadal widzisz rejestrowane dodatkowe informacje o debugowaniu, sprawdź, czy prawidłowo wykonano wszystkie czynności opisane w sekcji Wyłączanie dzienników debugowania w przypadku konkretnego hosta wirtualnego na routerze. Jeśli pominiesz jakiś krok, powtórz wszystkie czynności.
  5. Jeśli nadal nie możesz uzyskać informacji o debugowaniu, skontaktuj się z zespołem pomocy Apigee Edge .