Sosreport aracı

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

Sosreport, açık kaynaklı yazılım SoS'e dayalı, sistem düzeyinde bir teşhis ve veri toplama aracıdır. Sosreport aracını kullanarak Apigee bileşeninin çalıştığı düğümlerdeki sorunları ayıklamanıza yardımcı olacak bilgileri toplayabilirsiniz. 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 bir arşivde depolar. Sosreport, Apigee bileşenleri için aşağıdakileri toplar:

  • Çalışan çekirdek sürümü
  • Yüklenen 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şhis bilgileri.

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 ve sosreport eklentilerini yüklemek ve yönetmek için kullanılan yardımcı bir araç.

Kurulum

Aşağıdaki tabloda, Edge for Private Cloud'un desteklenen sürümlerinde Sosreport aracının kullanılabilirliği ve yükleme yöntemi ayrıntılı olarak açıklanmaktadır.

OPDK sürümü Yeni yükleme Yerinde yükseltme
4.50.00.11 - 4.52.01.00 Manuel yükleme gerekiyor Manuel yükleme gerekir
4.52.01.01+ Varsayılan olarak yüklü Manuel yükseltme gerekiyor
Amazon Linux 2023+ Desteklenmiyor Desteklenmiyor

Sosreport aracı, Edge for Private Cloud 4.52.01.01 ve sonraki sürümlerin yeni bir yüklemesi gerçekleştirilirken tüm düğümlerde varsayılan olarak yüklenir.

Edge for Private Cloud 4.52.01.01 veya sonraki bir sürüme yerinde yükseltme yaparsanız Sosreport aracını güncellemek için her düğümde aşağıdaki komutu çalıştırın:

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

Sosreport aracının ve eklentilerinin yüklenmesini ve sürümünü doğrulamak için aşağıdaki komutu çalıştırabilirsiniz:

apigee-service apigee-sosreport version

Sosreport aracını destekleyen tüm eklentileri listelemek için aşağıdaki komutu kullanın:

sudo sosreport --list-plugins

Yalnızca Apigee'ye özel eklentileri listelemek için aşağıdaki komutu çalıştırın:

sudo sosreport --list-plugins | grep apigee

Edge for Private Cloud'un 4.50.00.11 ile 4.52.01.00 arasındaki sürümlerinde Sosreport aracı kullanılabilir ancak ortamınıza bağlı olarak manuel kurulum gerekebilir.

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

sosreport uygulamasının orijinal SoS sürümü sisteminizde zaten yüklüyse yükleme yolları çakışabileceğinden Apigee sürümünü kurmayın. Bunun yerine, Apigee'ye özel eklentileri /opt/apigee/apigee-sosreport/source/plugin dizininden uygun Python site-packages dizinine kopyalamak için aşağıda gösterilenlere benzer bir komut kullanın. Örneğin, apigee-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 şunu girin:

sudo sosreport --list-plugins

Sorularınız varsa Apigee Destek Ekibi ile iletişime geçin.

Aşağıdaki bölümde, 4.50.00.11 ile 4.52.01.00 arasındaki sürümler için `sosreport` un nasıl yükleneceği açıklanmaktadır.

sosreport için Apigee sürümü yükleniyor

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

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

sosreport'nın yüklendiğini test etmek için Apigee ile ilgili eklentilerin aşağıdaki dizinde bulunduğunu doğrulayın:

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

Burada pythonx.x, Python'un yüklü sürümüdür.

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

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

    Bu komut, Apigee'ye özgü aşağıdaki eklenti listesini 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 gathering class
  • Tüm eklentileri doğrulamak için: 
    apigee-service apigee-sosreport diagnose -s -l

    Bu komut, 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

Edge for Private Cloud 4.52.01.01 ve sonraki sürümler

Sosreport aracı, düğümünüzdeki mevcut bileşenleri algılayabilir ve destek ekiplerinin analiz için ihtiyaç duyduğu tüm günlüklerin raporunu oluşturabilir.

Rapor oluşturmak için aşağıdaki komutu kullanın:

apigee-service apigee-sosreport diagnose

Gerekirse aşağıdaki işaretleri ekleyebilirsiniz:

  • -f | --file | --config : Kurulum gerçekleştirilirken kullanılan yapılandırma dosyasının yolu. 
    Example: apigee-service apigee-sosreport diagnose -f /path/to/configuration.file
  • -o | --output : Oluşturulan sosreport'u belirli bir dizine veya yola yönlendirmek için 
    Example: apigee-service apigee-sosreport diagnose -o /path/to/output_directory/

Edge for Private Cloud 4.50.00.11 ile 4.52.01.00 arasındaki sürümler

Sosreport aracını kullanarak rapor oluşturmak için gerekli eklenti seçeneğiyle (Apigee eklentileri bölümüne bakın) sosreport komutunu çalıştırın. Raporun depolandığı varsayılan dizin tmp veya /var/tmp'dir. tmp-dir seçeneğine farklı bir dizin ileterek raporun depolandığı dizini değiştirebilirsiniz. Örneğin, Yönetim Sunucusu hakkında bir 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ü kullanma: 
    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, tmp-dir seçeneğini kullanarak belirttiğiniz dizindeki bir .tar.xz dosyasına kaydedilir. .tar.xz dosyasının konumu ve denetim toplamı stdout'ta 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 saklanır. .tar.xz file dosyasının konumu ve denetim toplamı STDOUT sayfasında gösterilir. Örneğin:

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

sudo man sosreport

Apigee eklentileri

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

Yönetim Sunucusu

apigee-mgmt eklentisi, Yönetim Sunucusu'ndan aşağıdaki bilgileri toplar:

  • sunucu ana makine adı (varsayılan)
  • cpuinfo (varsayılan)
  • meminfo (varsayılan)
  • Bellek gibi Java sanal makinesi (JVM) ayarları, Djdk.tls.allowUnsafeServerCertChange vb. (varsayılan)
  • Mevcut yönetim günlükleri (varsayılan)
  • On sıralı top ve jstack çıkışı (varsayılan)
  • Yönetim günlüğü 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ü kullanma: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mgmt --batch my_report-dir
  • sosreport uygulamasının SoS sürümü kullanılıyor: 
    sudo sosreport -o apigee-mgmt --batch my_report-dir

Tüm varsayılan öğeleri ve komutta belirtilen isteğe bağlı öğeleri(ör. 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ü kullanma: 
    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'nın SoS sürümünü kullanma: 
    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ü kullanma: 
    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ı girebilirsiniz:

    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mgmt --batch -a
  • sosreport uygulamasının SoS sürümü kullanılıyor: 
    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 İşlemcisi'nden (MP) aşağıdaki bilgileri toplar:

  • Sunucu ana makine adı (varsayılan)
  • cpuinfo (varsayılan)
  • meminfo (varsayılan)
  • buildinfo/release info (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)
  • Mevcut MP günlükleri (varsayılan)
  • On sıralı top, jstacks ve NIO Metrics çı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ı izi (isteğe bağlıdır ve yalnızca org:env:api:rev detail sağlandığında geçerlidir). 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ü kullanma: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mp --batch
  • sosreport uygulamasının SoS sürümü kullanılıyor: 
    sudo sosreport -o apigee-mp --batch

Tüm varsayılan öğelere ek olarak, toplanacak isteğe bağlı başka öğ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ü kullanma: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mp --batch -k apigee-mp.heap
  • sosreport'nın SoS sürümünü kullanma: 
    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ü kullanma: 
    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'nın SoS sürümünü kullanma: 
    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ü kullanma: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mp --batch -a
  • sosreport uygulamasının SoS sürümü kullanılıyor: 
    sudo sosreport -o apigee-mp --batch -a

Yönlendirici

apigee-rrt eklentisi, yönlendiriciden aşağıdaki bilgileri toplar:

  • Sunucu ana makine adı (varsayılan)
  • cpuinfo (varsayılan)
  • meminfo (varsayılan)
  • buildinfo/release info (varsayılan)
  • apigee-all durumu (varsayılan)
  • sunucu ayrıntıları (varsayılan)
  • ps çıkışı. Bu, JVM düzeyinde ayarlar sağlar. Örneğin, bellek, Djdk.tls.allowUnsafeServerCertChange vb. (varsayılan).
  • Mevcut yönlendirici günlükleri (varsayılan)
  • Kötü dosya adları da dahil olmak üzere vhost dosya adlarının listesi (varsayılan)
  • Yönlendirici günlüğü 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ü kullanma: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-rrt --batch
  • sosreport uygulamasının SoS sürümü kullanılıyor: 
    sudo sosreport -o apigee-rrt --batch

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

  • Apigee'nin sosreport sürümünü kullanma: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-rrt --batch -k apigee-rrt.all-logs
  • sosreport'nın SoS sürümünü kullanma: 
    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

Tüm verileri toplamak için:

  • Apigee'nin sosreport sürümünü kullanma: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-rrt --batch -a
  • sosreport'nın SoS sürümünü kullanma: 
    sudo sosreport -o apigee-rrt --batch -a

Cassandra

apigee-cassandra eklentisi, Cassandra düğümlerinden aşağıdaki 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 status
  • apigee-cassandra günlükleri: /opt/apigee/var/log/apigee-cassandra/ altındaki tüm dosyalar
  • Kaydetme günlüğü sayısı
  • Top komutunun çıkışı
  • İleti dizisi 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, proxyhistograms

Örnek:

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

  • Apigee'nin sosreport sürümünü kullanma: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-cassandra
  • sosreport uygulamasının SoS sürümü kullanılıyor: 
    sudo sosreport -o apigee-cassandra