Sosreport-Tool

<ph type="x-smartling-placeholder"></ph> Sie sehen die Dokumentation zu Apigee Edge.
Gehen Sie zur Apigee X-Dokumentation. Weitere Informationen

Sosreport ist ein Diagnose- und Datenerhebungstool auf Systemebene, das auf der Open-Source- Software-SoS Mit dem Sosreport-Tool können Sie Informationen erfassen, die Ihnen bei der Fehlerbehebung helfen. in Knoten, in denen ein Apigee- Komponente ausgeführt wird. Das Tool erfasst und speichert Informationen lokal im Dateisystem des Knotens.

Das Sosreport-Tool erfasst Konfigurationsdetails, Systeminformationen und Diagnosedaten und speichert die Daten in einem Archiv. Für Apigee-Komponenten erhebt Sosreport Folgendes:

  • Die ausgeführte Kernel-Version
  • Geladene Module
  • System- und Dienstkonfigurationsdateien

Darüber hinaus werden auch externe Programme durchgeführt, um weitere Informationen wie:

  • Apigee-Logs aus allen Komponenten.
  • Laufzeitdiagnose
  • Mit nodetool-Befehlen erfasste Cassandra-Diagnose.

Das Sosreport-Tool enthält zwei Hauptbefehle:

  • sosreport: Der primäre Befehl zum Erfassen von Daten und Erstellen von Berichten.
  • apigee-sosreport: ein Hilfstool, das zur Installation verwendet wird sosreport und verwalten Sie die für Apigee-Komponenten spezifischen Plug-ins sosreport.

Installation

In diesem Abschnitt wird die Installation von sosreport erläutert.

Wenn die SoS-Version von sosreport bereits installiert ist

Wenn die ursprüngliche SoS-Version von sosreport bereits auf Ihrem System installiert ist, Richten Sie keine Apigee-Version ein, da die Installationspfade in Konflikt stehen können. Kopieren Sie stattdessen die Apigee-spezifischen Plug-ins aus dem Verzeichnis /opt/apigee/apigee-sosreport/source/plugin zum entsprechenden Python site-packages mit einem Befehl wie dem unten gezeigten Verzeichnis site-packages. So kopieren Sie beispielsweise agigee-mgmt.py:

  • Wenn Sie Python 2 verwenden, geben Sie Folgendes ein: 
    sudo cp apigee-mgmt.py /usr/lib/python2.7/site-packages/sos/plugins/
  • Wenn Sie Python 3 verwenden, geben Sie Folgendes ein: 
    sudo cp apigee-mgmt.py /usr/local/lib/python3.6/site-packages/sos/plugins/

Geben Sie Folgendes ein, um zu prüfen, ob die Plug-ins installiert wurden:

sudo sosreport --list-plugins

Wenn Sie Fragen haben, wenden Sie sich an den Apigee-Support.

Apigee-Version von sosreport wird installiert

Wenn die SoS-Version von sosreport nicht bereits auf Ihrem System installiert ist, können Sie die Apigee-Version installieren, indem Sie die folgenden Befehle auf allen Knoten, auf denen Edge for Private Cloud installiert ist: 

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

Um zu testen, ob sosreport installiert ist, prüfen Sie, ob die zu Apigee befindet sich in folgendem Verzeichnis:

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

Dabei ist pythonx.x die installierte Version von Python.

Alternativ können Sie einen der folgenden Befehle ausführen:

  • So prüfen Sie nur Apigee-spezifische Plug-ins: 
    apigee-service apigee-sosreport diagnose -l

    Dadurch wird die folgende Liste der Apigee-spezifischen Plug-ins zurückgegeben.

    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 gatehring class
  • So überprüfen Sie alle Plug-ins: 
    apigee-service apigee-sosreport diagnose -s -l

    Daraufhin wird die folgende Liste der für sosreport verfügbaren Plug-ins zurückgegeben:

    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→

Erstellen eines Berichts

Um einen Bericht mit dem Sosreport-Tool zu erstellen, führen Sie den Befehl sosreport aus. mit der erforderlichen Plug-in-Option (siehe Apigee-Plug-ins). Die Das Standardverzeichnis, in dem der Bericht gespeichert ist, ist entweder tmp oder /var/tmp. Sie können das Verzeichnis ändern, in dem der Bericht gespeichert ist, indem Sie ein anderes Verzeichnis übergeben. auf die Option tmp-dir. Um beispielsweise einen Bericht zu den Verwaltungsserver aus und speichern Sie ihn im Verzeichnis my_report-dir. geben Sie eine der folgenden Optionen ein:

  • Mit der Apigee-Version von sosreport: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf -o apigee-mgmt  --batch --tmp-dir=my_report-dir
  • SoS-Version von sosreport verwenden: 
    sudo sosreport -o apigee-mgmt  --batch --tmp-dir=my_report-dir

Der Bericht wird in einer .tar.xz-Datei in dem Verzeichnis gespeichert, das Sie mithilfe der Methode Option tmp-dir. Der Speicherort der Datei .tar.xz wird auf STDOUT sowie die Prüfsumme angezeigt. Beispiel:

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

Der Bericht wird in einer .tar.xz-Datei in dem Verzeichnis gespeichert, das Sie mithilfe der Methode Option tmp-dir. Der Standort von .tar.xz file wird auf STDOUT angezeigt, ebenso wie die Prüfsumme. Beispiel:

Weitere verfügbare Optionen für sosreport finden Sie in der Datei man:

sudo man sosreport

Apigee-Plug-ins

In den folgenden Abschnitten werden die Apigee-Plug-ins für das Sosreport-Tool beschrieben. folgende Komponenten:

Verwaltungsserver

Das Plug-in apigee-mgmt erfasst die folgenden Informationen aus der Verwaltungsserver:

  • Hostname des Servers (Standardeinstellung)
  • cpuinfo (Standard)
  • meminfo (Standard)
  • Einstellungen für Java Virtual Machine (JVM) wie Arbeitsspeicher, Djdk.tls.allowUnsafeServerCertChange usw. (Standardeinstellung)
  • Aktuelle Verwaltungslogs (Standard)
  • Zehn sequenzielle Ausgabe von oberem und jstacks (Standard)
  • Gesamter Verwaltungsprotokollordner (optional)
  • Konfigurationsdateien (optional)

Beispiele:

Um alle Standardelemente zu erfassen, geben Sie eine der folgenden Optionen ein:

  • Mit der Apigee-Version von sosreport: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mgmt --batch my_report-dir
  • Mit der SoS-Version von sosreport: 
    sudo sosreport -o apigee-mgmt --batch my_report-dir

Zum Erfassen aller Standardelemente und auch der optionalen Elemente, die im Befehl angegeben sind, für für Konfigurationsdateien und alle Protokolle einen der folgenden Werte eingeben:

  • Mit der Apigee-Version von sosreport: 
    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
  • Mit der SoS-Version von sosreport: 
    sudo sosreport -o apigee-mgmt --batch -k apigee-mgmt.config-files -k apigee-mgmt.all-logs

Um alles zu erfassen, geben Sie eine der folgenden Optionen ein:

  • Mit der Apigee-Version von sosreport: 
    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

    Alternativ können Sie auch Folgendes eingeben:

    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mgmt --batch -a
  • Mit der SoS-Version von sosreport: 
    sudo sosreport -o apigee-mgmt --batch -k apigee-mgmt.config-files -k apigee-mgmt.all-logs

    Alternativ können Sie Folgendes eingeben:

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

Message Processor

Das Plug-in apigee-mp erfasst die folgenden Informationen aus der Verwaltungsprozessor (MP):

  • Hostname des Servers (Standardeinstellung)
  • cpuinfo (Standard)
  • meminfo (Standard)
  • Buildinfo/Release-Informationen (Standard)
  • Apigee-All-Status (Standard)
  • Serverdetails (Standard)
  • Einstellungen auf JVM-Ebene, z. B. Arbeitsspeicher, Djdk.tls.allowUnsafeServerCertChange, usw. (Standard)
  • Aktuelle MP-Logs (Standardeinstellung)
  • Zehn sequenzielle Top-, jstacks- und NIO-Messwertausgabe (Standardeinstellung)
  • Gesamter MP-Protokollordner (optional)
  • Klassifizierungsstruktur (optional)
  • Heap-Dump (optional)
  • Konfigurationsdateien (optional)
  • Laufzeit-Trace (optional und nur wenn org:env:api:rev detail bereitgestellt wird. Hinweis: Das Plug-in wartet 25 Sekunden, um die Laufzeitanfragen zu erfassen.

Beispiele:

Um alle Standardelemente zu erfassen, geben Sie eine der folgenden Optionen ein:

  • Mit der Apigee-Version von sosreport: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mp --batch
  • Mit der SoS-Version von sosreport: 
    sudo sosreport -o apigee-mp --batch

Zusätzlich zu allen Standardelementen können Sie weitere optionale Elemente angeben, die erfasst werden sollen. Um beispielsweise den Heap-Dump anzugeben, verwenden Sie das Flag Geben Sie für -k apigee-mp.heap einen der folgenden Werte ein:

  • Mit der Apigee-Version von sosreport: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mp --batch -k apigee-mp.heap
  • Mit der SoS-Version von sosreport: 
    sudo sosreport -o apigee-mp --batch -k apigee-mp.heap

In ähnlicher Weise können Sie die folgenden optionalen Elemente angeben:

-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

Sie können mehrere Optionen mit einem einzigen Befehl angeben. Beispiel:

  • Mit der Apigee-Version von sosreport: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mp --batch -k apigee-mp.deployments -k apigee-mp.all-logs
  • Mit der SoS-Version von sosreport: 
    sudo sosreport -o apigee-mp --batch -k apigee-mp.deployments -k apigee-mp.all-logs

Um alles außer Trace zu erfassen, geben Sie eine der folgenden Optionen ein:

  • Mit der Apigee-Version von sosreport: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mp --batch -a
  • Mit der SoS-Version von sosreport: 
    sudo sosreport -o apigee-mp --batch -a

Router

Das Plug-in apigee-rrt erfasst die folgenden Informationen aus der Router:

  • Hostname des Servers (Standardeinstellung)
  • cpuinfo (Standard)
  • meminfo (Standard)
  • Buildinfo/Release-Informationen (Standard)
  • Apigee-All-Status (Standard)
  • Serverdetails (Standard)
  • ps-Ausgabe. Dadurch erhalten Sie Einstellungen auf JVM-Ebene, z. B. Speicher, Djdk.tls.allowUnsafeServerCertChange usw. (Standardeinstellung).
  • Aktuelle Routerlogs (Standard)
  • Liste der Vhost-Dateinamen, einschließlich ungültiger Dateinamen (Standardeinstellung)
  • Gesamter Router-Logordner (optional)
  • Konfigurationsdateien (optional)

Beispiele:

Um alle Standardelemente zu erfassen, geben Sie eine der folgenden Optionen ein:

  • Mit der Apigee-Version von sosreport: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-rrt --batch
  • Mit der SoS-Version von sosreport: 
    sudo sosreport -o apigee-rrt --batch

Zusätzlich zu allen Standardelementen können Sie weitere optionale Elemente angeben, die erfasst werden sollen. Um beispielsweise den gesamten Protokollordner anzugeben, verwenden Sie das Flag Geben Sie für -k apigee-rrt.all-logs einen der folgenden Werte ein:

  • Mit der Apigee-Version von sosreport: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-rrt --batch -k apigee-rrt.all-logs
  • Mit der SoS-Version von sosreport: 
    sudo sosreport -o apigee-rrt --batch -k apigee-rrt.all-logs

In ähnlicher Weise können Sie die folgenden optionalen Elemente angeben:

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

So sammelst du alles:

  • Mit der Apigee-Version von sosreport: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-rrt --batch -a
  • Mit der SoS-Version von sosreport: 
    sudo sosreport -o apigee-rrt --batch -a

Cassandra

Das Plug-in „apigee-cassandra“ erhebt die folgenden Informationen aus Cassandra-Knoten:

  • Maschinenstatistiken: 
    "hostname -i"
"cat /proc/cpuinfo"
"cat /proc/meminfo"
"ulimit -a"
"ps auxw"
"df -kh"
"du -sh"
"netstat -ntlpu"
"free -h"
"ifconfig -h"
"ps -ef"
  • Status und Version der Apigee-Komponente Apigee – alle Version && Apigee-Gesamtstatus
  • Apigee-Cassandra-Logs: Alle Dateien unter /opt/apigee/var/log/apigee-cassandra/
  • Commit-Loganzahl
  • Ausgabe des Befehls „Top“
  • Thread-Dump
  • Konfigurationsdateien: cassandra-topology.properties, cassandra.yaml, cassandra-env.sh
  • Nodetool-Ausgabe für die folgenden Parameter: version, status, ring, info, gossipinfo, kompaktionstats -H, tpstats, netstats, cfstats, proxyhistograms

Beispiel:

Um alle Standardelemente zu erfassen, geben Sie eine der folgenden Optionen ein:

  • Mit der Apigee-Version von sosreport: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-cassandra
  • Mit der SoS-Version von sosreport: 
    sudo sosreport -o apigee-cassandra