Sosreport aracı

Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin. bilgi

Sosreport, açık kaynak yazılımı SoS'yi temel alan sistem düzeyinde bir teşhis ve veri toplama aracıdır. Bir Apigee bileşeninin çalıştığı düğümlerde sorunları ayıklamanıza yardımcı olacak bilgileri toplamak için Sosreport aracını kullanabilirsiniz. Araç, bilgileri düğümün dosya sisteminde yerel olarak toplar ve depolar.

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

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

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

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

Sosreport aracı iki ana komut içerir:

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

Döşeme

Bu bölümde, sosreport uygulamasını nasıl yükleyeceğiniz açıklanmaktadır.

sosreport uygulamasının SoS sürümü zaten yüklüyse

Sisteminizde sosreport'in orijinal SoS sürümü zaten yüklüyse yükleme yolları çakışabileceğinden Apigee sürümünü kurmayın. Bunun yerine, aşağıda gösterilenlere benzer bir komut kullanarak Apigee'ye özel eklentileri /opt/apigee/apigee-sosreport/source/plugin dizininden uygun Python site-packages dizinine kopyalayın. Örneğin, agigee-mgmt.py öğesini kopyalamak için:

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

Eklentilerin yüklendiğini doğrulamak için

sudo sosreport --list-plugins

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

Apigee sosreport sürümünü yükleme

Sisteminizde sosreport'in SoS sürümü yüklü değilse Edge for Private Cloud'un yüklü olduğu tüm düğümlere aşağıdaki komutları girerek Apigee'nin sürümünü yükleyebilirsiniz: 

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

sosreport eklentisinin yüklü olup olmadığını test etmek için Apigee ile ilgili eklentilerin aşağıdaki dizinde bulunduğunu onaylayın:

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

Burada pythonx.x, yüklü Python sürümünüzdir.

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şlemle, aşağıdaki Apigee'ye özel eklentilerin listesi döndürülü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 komut, sosreport ile kullanılabilen eklentilerin aşağıdaki 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 gerekli eklenti seçeneğiyle sosreport komutunu çalıştırın (Apigee eklentileri bölümüne bakın). Raporun depolandığı varsayılan dizin tmp veya /var/tmp dizinidir. tmp-dir seçeneğine farklı bir dizin ileterek raporun depolandığı dizini değiştirebilirsiniz. Örneğin, Yönetim Sunucusu'nda rapor oluşturmak ve bunu my_report-dir adlı bir dizine kaydetmek 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 --tmp-dir=my_report-dir
  • Sosreport'un SoS sürümünü kullanarak: 
    sudo sosreport -o apigee-mgmt  --batch --tmp-dir=my_report-dir

Rapor, tmp-dir seçeneğini kullanarak belirttiğiniz dizindeki bir .tar.xz dosyasında depolanır. .tar.xz dosyasının konumu STDOUT'ta ve sağlama 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, tmp-dir seçeneğini kullanarak belirttiğiniz dizindeki bir .tar.xz dosyasında depolanır. .tar.xz file öğesinin konumu, sağlama toplamının yanı sıra STDOUT üzerinde gösterilir. Örneğin:

sosreport ile ilgili diğer seçenekleri görmek için man dosyasını okuyun:

sudo man sosreport

Apigee eklentileri

Aşağıdaki bölümlerde, aşağıdaki bileşenler için Sosreport aracındaki Apigee eklentileri açıklanmaktadır:

Yönetim Sunucusu

apigee-mgmt eklentisi, Yönetim Sunucusu'ndan şu bilgileri toplar:

  • sunucu ana makine adı (varsayılan)
  • cpuinfo (varsayılan)
  • meminfo (varsayılan)
  • Bellek, Djdk.tls.allowUnsafeServerCertChange vb. Java sanal makine (JVM) ayarları (varsayılan)
  • Geçerli 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 komutta belirtilen isteğe bağlı öğeleri(örneğin, yapılandırma dosyaları ve tüm günlükler) 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
  • 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 şunları 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 şunları girebilirsiniz:

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

Mesaj İşleyici

apigee-mp eklentisi Yönetim İşleyici'den (MP) şu bilgileri toplar:

  • 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üzeyinde ayarlar (ör. bellek, Djdk.tls.allowUnsafeServerCertChange) (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 sağlandığında). 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, toplanacak isteğe bağlı ek öğeler de belirtebilirsiniz. Örneğin, yığın dökümünü belirtmek için -k apigee-mp.heap işaretini kullanarak 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 de 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 hariç 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'den şu bilgileri toplar:

  • 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, bellek, Djdk.tls.allowUnsafeServerCertChange gibi JVM düzeyinde ayarları sağlar (varsayılan).
  • Geçerli Yönlendirici günlükleri (varsayılan)
  • Hatalı dosya adları dahil vhost 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, toplanacak isteğe bağlı ek öğeler de belirtebilirsiniz. Örneğin, -k apigee-rrt.all-logs işaretini kullanarak günlük klasörünün tamamını belirtmek 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 de 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, Cassandra düğümlerinden şu bilgileri toplar:

  • 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 version && Apigee-all durumu
  • Apigee-cassandra günlükleri: /opt/apigee/var/log/apigee-cassandra/ altındaki tüm dosyalar
  • Kaydetme günlüğü sayısı
  • Üst komut çıkışı
  • İş parçacığı dökümü
  • Yapılandırma dosyaları: cassandra-topology.properties, cassandra.yaml, cassandra-env.sh
  • Aşağıdaki parametreler için Nodetool çıkışı: version, status, ring, info, gossipinfo, compactionstats -H, tpstats, netstats, cfstats, proxyhistograms

Ö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