Sosreport aracı

Apigee Edge belgelerini görüntülüyorsunuz.
. Git: Apigee X belgeleri. bilgi

Sosreport, açık kaynağa dayalı, sistem düzeyinde bir teşhis ve veri toplama aracıdır yazılım SoS. Hata ayıklamanıza yardımcı olacak bilgileri toplamak için Sosreport aracını kullanabilirsiniz bir Apigee'nin bileşeni çalışıyor. Araç, bilgileri düğümün dosya sisteminde yerel olarak toplar ve depolar.

Sosreport aracı yapılandırma ayrıntılarını, sistem bilgilerini ve teşhis bilgileri sisteminizden kaldırır ve verileri bir arşivde depolar. Sosreport, Apigee bileşenleri için şu bilgileri toplar:

  • Çalışan çekirdek sürümü
  • Yüklenen modüller
  • Sistem ve hizmet yapılandırma dosyaları

Sosreport, daha fazla veri toplamak için harici programlar da çalıştırır aşağıdaki bilgiler de dahil olmak üzere:

  • Tüm bileşenlerden Apigee günlükleri.
  • Çalışma zamanı teşhisi
  • Nodetool komutları kullanılarak toplanan Cassandra teşhisi.

Sosreport aracı iki ana komut içerir:

  • sosreport: Veri toplamak ve rapor oluşturmak için kullanılan birincil komut.
  • apigee-sosreport: Yükleme için kullanılan yardımcı bir araç sosreport ve Apigee bileşenlerine özel sosreport eklentilerini yönetin.

Kurulum

Bu bölümde sosreport uygulamasının nasıl yükleneceği açıklanmaktadır.

sosreport işletim sisteminin SoS sürümü zaten yüklüyse

Asıl sosreport adlı cihazın SoS sürümü sisteminizde zaten yüklüyse Yükleme yolları çakışabileceğinden, Apigee'nin sürümünü kurmayın. Bunun yerine, dizinden Apigee'ye özel eklentileri kopyalayın. Uygun Python'a /opt/apigee/apigee-sosreport/source/plugin site-packages dizinini oluşturmak için aşağıdakine benzer bir komut kullanabilirsiniz. Örneğin, agigee-mgmt.py öğesini kopyalamak için:

  • Python 2 kullanıyorsanız şunları girin: 
    sudo cp apigee-mgmt.py /usr/lib/python2.7/site-packages/sos/plugins/
    .
  • Python 3 kullanıyorsanız şunları girin: 
    sudo cp apigee-mgmt.py /usr/local/lib/python3.6/site-packages/sos/plugins/
    .

Eklentilerin yüklendiğini doğrulamak için şunu girin:

sudo sosreport --list-plugins

Sorunuz varsa Apigee destek ekibiyle iletişime geçin.

Apigee'nin sosreport sürümü yükleniyor

sosreport işletim sisteminin SoS sürümü uyumlu değilse sisteminizde zaten yüklüyse aşağıdaki adımları uygulayarak Apigee'nin sürümünü yükleyebilirsiniz: Edge for Private Cloud'un yüklü olduğu tüm düğümlerde aşağıdaki komutları kullanın: 

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

sosreport uygulamasının yüklü olup olmadığını test etmek için Apigee şu dizinde yer almaktadır:

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

pythonx.x burada Python'un yüklü olduğu sürümdür.

Alternatif olarak aşağıdaki komutlardan birini de çalıştırabilirsiniz:

  • Yalnızca Apigee'ye özel eklentileri doğrulamak için: 
    apigee-service apigee-sosreport diagnose -l
    .

    Bu işlem, aşağıdaki Apigee'ye özel eklentileri döndürür.

    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
  • Tüm eklentileri doğrulamak için: 
    apigee-service apigee-sosreport diagnose -s -l
    .

    Bu, sosreport ile kullanılabilen aşağıdaki eklentilerin listesini döndürür:

    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→

Rapor oluşturma

Sosreport aracını kullanarak rapor oluşturmak için sosreport komutunu çalıştırın (Apigee eklentileri sayfasına bakın). İlgili içeriği oluşturmak için kullanılan raporun depolandığı varsayılan dizin tmp veya /var/tmp şeklindedir. Farklı bir dizin ileterek raporun depolandığı dizini değiştirebilirsiniz. tmp-dir seçeneğine. Örneğin, Yönetim Sunucusu'nu yükleyin ve my_report-dir adlı bir dizine kaydedin. aşağıdakilerden birini girin:

  • Apigee'nin sosreport sürümünü kullanarak: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf -o apigee-mgmt  --batch --tmp-dir=my_report-dir
  • Sosreport'un Sos sürümünü kullanma: 
    sudo sosreport -o apigee-mgmt  --batch --tmp-dir=my_report-dir
    .

Rapor, belirttiğiniz dizindeki bir .tar.xz dosyasında tmp-dir seçeneği. .tar.xz dosyasının konumu STDOUT'ta ve denetim toplamında gösterilir. Örneğin:

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

Rapor, belirttiğiniz dizindeki bir .tar.xz dosyasında tmp-dir seçeneği. .tar.xz file etkinliğinin konumu STDOUT üzerinde gösteriliyor ve denetim toplamı. Örneğin:

sosreport için kullanılabilen diğer seçenekler için man dosyasını okuyun:

sudo man sosreport

Apigee eklentileri

Aşağıdaki bölümlerde, Arkadaş Bitkiler projesi için Sosreport aracına Apigee eklentileri aşağıdaki bileşenlerden oluşur:

Yönetim Sunucusu

apigee-mgmt eklentisi, Yönetim Sunucusu:

  • sunucu ana makine adı (varsayılan)
  • cpuinfo (varsayılan)
  • meminfo (varsayılan)
  • Bellek gibi Java sanal makine (JVM) ayarları, Djdk.tls.allowUnsafeServerCertChange vb. (varsayılan)
  • Mevcut Yönetim günlükleri (varsayılan)
  • On sıralı üst ve jstacks çıkışı (varsayılan)
  • Yönetim günlük klasörünün tamamı (isteğe bağlı)
  • config-files (isteğe bağlı)

Örnekler:

Tüm varsayılan öğeleri toplamak için aşağıdakilerden birini girin:

  • Apigee'nin sosreport sürümünü kullanarak: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mgmt --batch my_report-dir
  • sosreport işletim sisteminin SoS sürümünü kullanarak: 
    sudo sosreport -o apigee-mgmt --batch my_report-dir

Tüm varsayılan öğeleri ve ayrıca komutta belirtilen isteğe bağlı öğeleri toplamak üzere Örneğin, yapılandırma dosyalarını ve tüm günlükleri, aşağıdakilerden birini girin:

  • Apigee'nin sosreport sürümünü kullanarak: 
    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
  • sosreport işletim sisteminin SoS sürümünü kullanarak: 
    sudo sosreport -o apigee-mgmt --batch -k apigee-mgmt.config-files -k apigee-mgmt.all-logs

Her şeyi toplamak için aşağıdakilerden birini girin:

  • Apigee'nin sosreport sürümünü kullanarak: 
    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

    Alternatif olarak şunu da girebilirsiniz:

    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mgmt --batch -a
  • sosreport işletim sisteminin SoS sürümünü kullanarak: 
    sudo sosreport -o apigee-mgmt --batch -k apigee-mgmt.config-files -k apigee-mgmt.all-logs

    Alternatif olarak şunu da girebilirsiniz:

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

Mesaj İşleyici

apigee-mp eklentisi, Yönetim İşleyici (MP):

  • Sunucu ana makine adı (varsayılan)
  • cpuinfo (varsayılan)
  • meminfo (varsayılan)
  • derleme bilgileri/sürüm bilgisi (varsayılan)
  • Apigee-all durumu (varsayılan)
  • sunucu ayrıntıları (varsayılan)
  • JVM düzeyindeki ayarlar (ör. bellek, Djdk.tls.allowUnsafeServerCertChange, vb. (varsayılan)
  • Geçerli MP günlükleri (varsayılan)
  • On sıralı üst, jstacks ve NIO Metrikleri çıkışı (varsayılan)
  • MP günlük klasörünün tamamı (isteğe bağlı)
  • Sınıflandırma ağacı (isteğe bağlı)
  • Yığın dökümü (isteğe bağlı)
  • config-files (isteğe bağlı)
  • Çalışma zamanı izleme (isteğe bağlı ve yalnızca org:env:api:rev detail olduğunda) sağlanır). Not: Eklenti, çalışma zamanı isteklerini toplamak için 25 saniye bekler.

Örnekler:

Tüm varsayılan öğeleri toplamak için aşağıdakilerden birini girin:

  • Apigee'nin sosreport sürümünü kullanarak: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mp --batch
  • sosreport işletim sisteminin SoS sürümünü kullanarak: 
    sudo sosreport -o apigee-mp --batch

Tüm varsayılan öğelere ek olarak, başka isteğe bağlı öğeler de toplayabilirsiniz. Örneğin, yığın dökümünü belirtmek için -k apigee-mp.heap için aşağıdakilerden birini girin:

  • Apigee'nin sosreport sürümünü kullanarak: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mp --batch -k apigee-mp.heap
  • sosreport işletim sisteminin SoS sürümünü kullanarak: 
    sudo sosreport -o apigee-mp --batch -k apigee-mp.heap

Benzer şekilde, aşağıdaki isteğe bağlı öğeleri belirtebilirsiniz:

-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

Tek bir komutta birden fazla seçenek belirtebilirsiniz. Örneğin:

  • Apigee'nin sosreport sürümünü kullanarak: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mp --batch -k apigee-mp.deployments -k apigee-mp.all-logs
  • sosreport işletim sisteminin SoS sürümünü kullanarak: 
    sudo sosreport -o apigee-mp --batch -k apigee-mp.deployments -k apigee-mp.all-logs

İzleme dışındaki her şeyi toplamak için aşağıdakilerden birini girin:

  • Apigee'nin sosreport sürümünü kullanarak: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mp --batch -a
  • sosreport işletim sisteminin SoS sürümünü kullanarak: 
    sudo sosreport -o apigee-mp --batch -a

Yönlendirici

apigee-rrt eklentisi, Yönlendirici:

  • Sunucu ana makine adı (varsayılan)
  • cpuinfo (varsayılan)
  • meminfo (varsayılan)
  • derleme bilgileri/sürüm bilgisi (varsayılan)
  • Apigee-all durumu (varsayılan)
  • sunucu ayrıntıları (varsayılan)
  • ps çıkışı. Bu işlem JVM düzeyinde ayarlar sağlar. Örneğin: bellek, Djdk.tls.allowUnsafeServerCertChange vb. (varsayılan).
  • Geçerli Yönlendirici günlükleri (varsayılan)
  • Bozuk dosya adları da dahil olmak üzere sanal makine dosya adlarının listesi (varsayılan)
  • Yönlendirici günlük klasörünün tamamı (isteğe bağlı)
  • config-files (isteğe bağlı)

Örnekler:

Tüm varsayılan öğeleri toplamak için aşağıdakilerden birini girin:

  • Apigee'nin sosreport sürümünü kullanarak: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-rrt --batch
  • sosreport işletim sisteminin SoS sürümünü kullanarak: 
    sudo sosreport -o apigee-rrt --batch

Tüm varsayılan öğelere ek olarak, başka isteğe bağlı öğeler de toplayabilirsiniz. Örneğin, günlük klasörünün tamamını belirtmek için -k apigee-rrt.all-logs için aşağıdakilerden birini girin:

  • Apigee'nin sosreport sürümünü kullanarak: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-rrt --batch -k apigee-rrt.all-logs
  • sosreport işletim sisteminin SoS sürümünü kullanarak: 
    sudo sosreport -o apigee-rrt --batch -k apigee-rrt.all-logs

Benzer şekilde, aşağıdaki isteğe bağlı öğeleri belirtebilirsiniz:

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

Her şeyi toplamak için:

  • Apigee'nin sosreport sürümünü kullanarak: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-rrt --batch -a
  • sosreport işletim sisteminin SoS sürümünü kullanarak: 
    sudo sosreport -o apigee-rrt --batch -a

Cassandra

apigee-cassandra eklentisi, aşağıdaki bilgileri Cassandra düğümleri:

  • Makine istatistikleri: 
    "hostname -i"
"cat /proc/cpuinfo"
"cat /proc/meminfo"
"ulimit -a"
"ps auxw"
"df -kh"
"du -sh"
"netstat -ntlpu"
"free -h"
"ifconfig -h"
"ps -ef"
    .
  • Apigee bileşeninin durumu ve sürümü Apigee-all sürümü && Apigee-all durumu
  • Apigee-cassandra günlükleri: /opt/apigee/var/log/apigee-cassandra/ altındaki tüm dosyalar
  • Kaydetme günlüğü sayısı
  • Komut çıkışı Üst
  • İş parçacığı dökümü
  • Yapılandırma dosyaları: cassandra-topology.properties, cassandra.yaml, cassandra-env.sh
  • Şu parametreler için Nodetool Çıkışı: version, status, ring, info, gossipinfo, compactionstats -H, tpstats, netstats, cfstats, proxyhistogramlar

Örnek:

Tüm varsayılan öğeleri toplamak için aşağıdakilerden birini girin:

  • Apigee'nin sosreport sürümünü kullanarak: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-cassandra
  • sosreport işletim sisteminin SoS sürümünü kullanarak: 
    sudo sosreport -o apigee-cassandra