Narzędzie Sosreport

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

Sosreport to narzędzie do diagnostyki i zbierania danych na poziomie systemu, oparte na oprogramowaniu open source SoS. Za pomocą narzędzia Sosreport możesz zbierać informacje, które pomogą Ci debugować problemy w węzłach, w których działa komponent Apigee. Narzędzie zbiera i przechowuje informacje lokalnie w systemie plików węzła.

Narzędzie Sosreport zbiera szczegóły konfiguracji, informacje o systemie i informacje diagnostyczne z systemu i przechowuje je w archiwum. W przypadku komponentów Apigee narzędzie Sosreport zbiera te informacje:

  • Wersja uruchomionego jądra
  • Wczytane moduły
  • Pliki konfiguracji systemu i usługi

Sosreport uruchamia też programy zewnętrzne, aby zebrać dodatkowe informacje, takie jak:

  • Logi Apigee ze wszystkich komponentów.
  • Diagnostyka środowiska wykonawczego
  • Diagnostyka Cassandra zebrana za pomocą poleceń nodetool.

Narzędzie Sosreport zawiera 2 główne polecenia:

  • sosreport: podstawowe polecenie do zbierania danych i tworzenia raportów.
  • apigee-sosreport: narzędzie pomocnicze służące do instalowania sosreport i zarządzania wtyczkami sosreport specyficznymi dla komponentów Apigee.

Instalacja

W tabeli poniżej znajdziesz informacje o dostępności i metodzie instalacji narzędzia Sosreport w obsługiwanych wersjach Edge dla chmury prywatnej.

Wersja OPDK Świeża instalacja Uaktualnienie w miejscu
4.50.00.11–4.52.01.00 Wymagana instalacja ręczna Wymagana instalacja ręczna
4.52.01.01+ Domyślnie zainstalowane Wymagane uaktualnienie ręczne
Amazon Linux 2023 lub nowszy Nieobsługiwane Nieobsługiwane

Narzędzie Sosreport jest domyślnie instalowane na wszystkich węzłach podczas nowej instalacji Edge dla chmury prywatnej w wersji 4.52.01.01 lub nowszej.

Jeśli przeprowadzisz aktualizację w miejscu do Edge dla chmury prywatnej w wersji 4.52.01.01 lub nowszej, uruchom to polecenie na każdym węźle, aby zaktualizować narzędzie Sosreport:

/opt/apigee/apigee-service/bin/apigee-service apigee-sosreport update

Aby sprawdzić instalację i wersję narzędzia Sosreport oraz jego wtyczek, możesz uruchomić to polecenie:

apigee-service apigee-sosreport version

Aby wyświetlić listę wszystkich wtyczek obsługujących narzędzie Sosreport, użyj tego polecenia:

sudo sosreport --list-plugins

Aby wyświetlić listę tylko wtyczek związanych z Apigee, uruchom to polecenie:

sudo sosreport --list-plugins | grep apigee

W przypadku Edge dla chmury prywatnej w wersjach od 4.50.00.11 do 4.52.01.00 narzędzie Sosreport jest dostępne, ale może wymagać ręcznej konfiguracji w zależności od środowiska.

Jeśli wersja SoS aplikacji sosreport jest już zainstalowana

Jeśli oryginalna wersja SoS sosreport jest już zainstalowana w systemie, nie konfiguruj wersji Apigee, ponieważ ścieżki instalacji mogą być sprzeczne. Zamiast tego skopiuj wtyczki Apigee z katalogu /opt/apigee/apigee-sosreport/source/plugin do odpowiedniego katalogu Pythona site-packages, używając polecenia podobnego do tych poniżej. Aby na przykład skopiować apigee-mgmt.py:

  • Jeśli używasz Pythona 2, wpisz: 
    sudo cp apigee-mgmt.py /usr/lib/python2.7/site-packages/sos/plugins/
  • Jeśli używasz Pythona 3, wpisz: 
    sudo cp apigee-mgmt.py /usr/local/lib/python3.6/site-packages/sos/plugins/

Aby sprawdzić, czy wtyczki zostały zainstalowane, wpisz

sudo sosreport --list-plugins

Jeśli masz pytania, skontaktuj się z zespołem pomocy Apigee.

W tej sekcji opisujemy, jak zainstalować `sosreport` w wersjach od 4.50.00.11 do 4.52.01.00.

Instalowanie wersji sosreport Apigee

Jeśli wersja SoS sosreport nie jest jeszcze zainstalowana w Twoim systemie, możesz zainstalować wersję Apigee, wpisując te polecenia na wszystkich węzłach, w których jest zainstalowana usługa Edge dla chmury prywatnej: 

/opt/apigee/apigee-service/bin/apigee-service apigee-sosreport install
/opt/apigee/apigee-service/bin/apigee-service apigee-sosreport setup

Aby sprawdzić, czy sosreport jest zainstalowany, potwierdź, że wtyczki związane z Apigee znajdują się w tym katalogu:

/usr/lib/pythonx.x/site-packages/sos/plugins

gdzie pythonx.x to zainstalowana wersja Pythona.

Możesz też uruchomić jedno z tych poleceń:

  • Aby zweryfikować tylko wtyczki Apigee: 
    apigee-service apigee-sosreport diagnose -l

    Zwróci to listę wtyczek związanych z Apigee.

    sosreport (version 3.9)

The following plugins are currently enabled:

apigee-mgmt          This is the apigee plugin for edge-management-server
apigee-mp            This is the apigee plugin for edge-message-processor
apigee-rrt           This is the apigee plugin for edge-router
apigee-sample        Main diagnostics gathering class
  • Aby zweryfikować wszystkie wtyczki: 
    apigee-service apigee-sosreport diagnose -s -l

    Zwróci to listę wtyczek dostępnych w sosreport:

    sosreport (version 3.9)

The following plugins are currently enabled:

 acpid                ACPI daemon information
 alternatives         System alternatives
 anacron              Anacron job scheduling service
 apigee-cassandra     This is the base class for sosreport plugins. Plugins should subclass
    this and set the class variables where applicable. ←truncated→
 apigee-mgmt          This is the base class for sosreport plugins. Plugins should subclass
    this and set the class variables where applicable. ←truncated→
 apigee-mp            Main diagnostics gathering class
 apigee-rrt           This is the base class for sosreport plugins. Plugins should subclass
    this and set the class variables where applicable. ←truncated→

………………………………………………….
………………………………………………….
………………………………………………….
←truncated→

Tworzenie raportu

Edge dla chmury prywatnej w wersji 4.52.01.01 lub nowszej

Narzędzie Sosreport może wykrywać istniejące komponenty w węźle i generować raport ze wszystkimi dziennikami wymaganymi przez zespoły pomocy na potrzeby analizy.

Aby wygenerować raport, użyj tego polecenia:

apigee-service apigee-sosreport diagnose

W razie potrzeby możesz dodać te flagi:

  • -f | --file | --config : ścieżka do pliku konfiguracji używanego podczas konfiguracji. 
    Example: apigee-service apigee-sosreport diagnose -f /path/to/configuration.file
  • -o | --output : przekierowuje wygenerowany raport sosreport do określonego katalogu lub ścieżki. 
    Example: apigee-service apigee-sosreport diagnose -o /path/to/output_directory/

Edge dla chmury prywatnej w wersjach od 4.50.00.11 do 4.52.01.00

Aby utworzyć raport za pomocą narzędzia Sosreport, uruchom polecenie sosreport z wymaganą opcją wtyczki (patrz Wtyczki Apigee). Domyślny katalog, w którym jest przechowywany raport, to tmp lub /var/tmp. Możesz zmienić katalog, w którym jest przechowywany raport, przekazując inny katalog do opcji tmp-dir. Aby na przykład utworzyć raport dotyczący serwera zarządzania i zapisać go w katalogu o nazwie my_report-dir, wpisz jedno z tych poleceń:

  • Używanie wersji sosreport w Apigee: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf -o apigee-mgmt  --batch --tmp-dir=my_report-dir
  • Używanie wersji SoS narzędzia sosreport: 
    sudo sosreport -o apigee-mgmt  --batch --tmp-dir=my_report-dir

Raport jest przechowywany w pliku .tar.xz w katalogu określonym za pomocą opcji tmp-dir. Lokalizacja pliku .tar.xz jest wyświetlana w STDOUT wraz z sumą kontrolną. Na przykład:

Your sosreport has been generated and saved in:
 /var/sosreport-prc-test-0-9613-2021-07-12-orwxufx.tar.xz
The checksum is: 5a8b97c6020346a688254c8b04ef86ec
For more available options for sosreport, read the man file:
sudo man sosreport

Raport jest przechowywany w pliku .tar.xz w katalogu określonym za pomocą opcji tmp-dir. Lokalizacja pliku .tar.xz file jest widoczna w STDOUT, podobnie jak suma kontrolna. Na przykład:

Aby dowiedzieć się więcej o dostępnych opcjach dla sosreport, przeczytaj plik man:

sudo man sosreport

Wtyczki Apigee

W sekcjach poniżej opisano wtyczki Apigee do narzędzia Sosreport dla tych komponentów:

Serwer zarządzania

Wtyczka apigee-mgmt zbiera z serwera zarządzającego te informacje:

  • nazwa hosta serwera (domyślna),
  • cpuinfo (domyślna)
  • meminfo (domyślny)
  • ustawienia maszyny wirtualnej Java (JVM), takie jak pamięć, Djdk.tls.allowUnsafeServerCertChange itp. (domyślne);
  • Bieżące logi zarządzania (domyślnie)
  • 10 sekwencyjnych danych wyjściowych top i jstacks (domyślnie)
  • Cały folder logów zarządzania (opcjonalnie)
  • config-files (opcjonalnie)

Przykłady:

Aby zbierać wszystkie elementy domyślne, wpisz jedną z tych wartości:

  • Używanie wersji sosreport w Apigee: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mgmt --batch my_report-dir
  • Korzystanie z wersji SoS usługi sosreport: 
    sudo sosreport -o apigee-mgmt --batch my_report-dir

Aby zebrać wszystkie elementy domyślne, a także opcjonalne elementy określone w poleceniu, na przykład pliki konfiguracji i wszystkie dzienniki, wpisz jedno z tych poleceń:

  • Używanie wersji sosreport w Apigee: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mgmt --batch -k apigee-mgmt.config-files -k apigee-mgmt.all-logs
  • Korzystanie z wersji SoS aplikacji sosreport: 
    sudo sosreport -o apigee-mgmt --batch -k apigee-mgmt.config-files -k apigee-mgmt.all-logs

Aby zebrać wszystkie dane, wpisz jedną z tych wartości:

  • Używanie wersji sosreport w Apigee: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mgmt --batch -k apigee-mgmt.config-files -k apigee-mgmt.all-logs

    Możesz też wpisać:

    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mgmt --batch -a
  • Korzystanie z wersji SoS usługi sosreport: 
    sudo sosreport -o apigee-mgmt --batch -k apigee-mgmt.config-files -k apigee-mgmt.all-logs

    Możesz też wpisać:

    sudo sosreport -o apigee-mgmt --batch -a

procesor komunikatów

Wtyczka apigee-mp zbiera następujące informacje z procesora zarządzania (MP):

  • Nazwa hosta serwera (domyślna)
  • cpuinfo (domyślny)
  • meminfo (domyślny)
  • informacje o kompilacji/informacje o wersji (domyślnie)
  • apigee-all status (domyślny)
  • szczegóły serwera (domyślnie),
  • Ustawienia na poziomie JVM, np. pamięć, Djdk.tls.allowUnsafeServerCertChange itp. (domyślne)
  • Bieżące logi MP (domyślnie)
  • 10 sekwencyjnych danych wyjściowych top, jstacks i NIO Metrics (domyślnie)
  • Cały folder logów MP (opcjonalnie)
  • Drzewo klasyfikacyjne (opcjonalnie)
  • Zrzut sterty (opcjonalnie)
  • config-files (opcjonalnie)
  • Ślad czasu działania (opcjonalny i tylko wtedy, gdy podano wartość org:env:api:rev detail). Uwaga: wtyczka czeka 25 sekund na zebranie żądań czasu działania.

Przykłady:

Aby zbierać wszystkie elementy domyślne, wpisz jedną z tych wartości:

  • Używanie wersji sosreport w Apigee: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mp --batch
  • Korzystanie z wersji SoS usługi sosreport: 
    sudo sosreport -o apigee-mp --batch

Możesz też określić dodatkowe opcjonalne elementy do zebrania oprócz wszystkich elementów domyślnych. Aby na przykład określić zrzut stosu za pomocą flagi -k apigee-mp.heap, wpisz jedną z tych wartości:

  • Korzystanie z wersji sosreport od Apigee: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mp --batch -k apigee-mp.heap
  • Korzystanie z wersji SoS aplikacji sosreport: 
    sudo sosreport -o apigee-mp --batch -k apigee-mp.heap

Możesz też określić te opcjonalne elementy:

-k apigee-mp.deployments
-k apigee-mp.heap
-k apigee-mp.all-logs
-k apigee-mp.config-files
-k apigee-mp.trace=gsc-cps:test:httpbin:3

W jednym poleceniu możesz określić kilka opcji. Na przykład:

  • Używanie wersji sosreport w Apigee: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mp --batch -k apigee-mp.deployments -k apigee-mp.all-logs
  • Korzystanie z wersji SoS usługi sosreport: 
    sudo sosreport -o apigee-mp --batch -k apigee-mp.deployments -k apigee-mp.all-logs

Aby zebrać wszystkie dane oprócz logów czasu, wpisz jedną z tych wartości:

  • Używanie wersji sosreport w Apigee: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mp --batch -a
  • Korzystanie z wersji SoS usługi sosreport: 
    sudo sosreport -o apigee-mp --batch -a

Router

Wtyczka apigee-rrt zbiera z routera te informacje:

  • Nazwa hosta serwera (domyślna)
  • cpuinfo (domyślny)
  • meminfo (domyślny)
  • informacje o kompilacji/informacje o wersji (domyślnie)
  • apigee-all status (domyślny)
  • szczegóły serwera (domyślne),
  • ps output. Spowoduje to wyświetlenie ustawień na poziomie JVM, np. pamięci, Djdk.tls.allowUnsafeServerCertChange itd. (domyślnie).
  • Logi bieżącego routera (domyślnie)
  • Lista nazw plików hostów wirtualnych, w tym nieprawidłowych nazw plików (domyślnie)
  • Cały folder logów routera (opcjonalnie)
  • config-files (opcjonalnie)

Przykłady:

Aby zbierać wszystkie elementy domyślne, wpisz jedną z tych wartości:

  • Używanie wersji sosreport w Apigee: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-rrt --batch
  • Korzystanie z wersji SoS usługi sosreport: 
    sudo sosreport -o apigee-rrt --batch

Oprócz wszystkich elementów domyślnych możesz też określić dodatkowe opcjonalne elementy do zebrania. Aby na przykład określić cały folder dziennika za pomocą flagi -k apigee-rrt.all-logs, wpisz jedną z tych wartości:

  • Używanie wersji sosreport w Apigee: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-rrt --batch -k apigee-rrt.all-logs
  • Korzystanie z wersji SoS aplikacji sosreport: 
    sudo sosreport -o apigee-rrt --batch -k apigee-rrt.all-logs

Możesz też określić te opcjonalne elementy:

-k apigee-rrt.all-logs
-k apigee-rrt.config-files

Aby zebrać wszystko:

  • Używanie wersji sosreport w Apigee: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-rrt --batch -a
  • Korzystanie z wersji SoS usługi sosreport: 
    sudo sosreport -o apigee-rrt --batch -a

Cassandra

Wtyczka apigee-cassandra zbiera z węzłów Cassandry te informacje:

  • Statystyki maszyny: 
    "hostname -i"
"cat /proc/cpuinfo"
"cat /proc/meminfo"
"ulimit -a"
"ps auxw"
"df -kh"
"du -sh"
"netstat -ntlpu"
"free -h"
"ifconfig -h"
"ps -ef"
  • Stan i wersja komponentu Apigee apigee-all version && apigee-all status
  • Logi apigee-cassandra: wszystkie pliki w /opt/apigee/var/log/apigee-cassandra/
  • Liczba logów zatwierdzeń
  • Wynik polecenia Top
  • Zrzut wątków
  • Pliki konfiguracji: cassandra-topology.properties, cassandra.yaml, cassandra-env.sh
  • Dane wyjściowe narzędzia nodetool dla tych parametrów: version, status, ring, info, gossipinfo, compactionstats -H, tpstats, netstats, cfstats, proxyhistograms

Przykład:

Aby zbierać wszystkie elementy domyślne, wpisz jedną z tych wartości:

  • Używanie wersji sosreport w Apigee: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-cassandra
  • Korzystanie z wersji SoS sosreport: 
    sudo sosreport -o apigee-cassandra