Alat Sosreport

Anda sedang melihat dokumentasi Apigee Edge.
Buka dokumentasi Apigee X. info

Sosreport adalah alat diagnostik dan pengumpulan data tingkat sistem, yang didasarkan pada software open source SoS. Anda dapat menggunakan alat Sosreport untuk mengumpulkan informasi guna membantu Anda melakukan debug masalah di node tempat komponen Apigee berjalan. Alat ini mengumpulkan dan menyimpan informasi secara lokal di sistem file node.

Alat Sosreport mengumpulkan detail konfigurasi, informasi sistem, dan informasi diagnostik dari sistem Anda, dan menyimpan data dalam arsip. Untuk komponen Apigee, Sosreport mengumpulkan hal berikut:

  • Versi kernel yang berjalan
  • Modul yang dimuat
  • File konfigurasi sistem dan layanan

Sosreport juga menjalankan program eksternal untuk mengumpulkan informasi lebih lanjut, termasuk:

  • Log Apigee dari semua komponen.
  • Diagnostik runtime
  • Diagnostik Cassandra yang dikumpulkan menggunakan perintah nodetool.

Alat Sosreport berisi dua perintah utama:

  • sosreport: Perintah utama untuk mengumpulkan data dan membuat laporan.
  • apigee-sosreport: Alat bantu yang digunakan untuk menginstal sosreport dan mengelola plugin sosreport khusus untuk komponen Apigee.

Penginstalan

Tabel berikut menjelaskan ketersediaan dan metode penginstalan alat Sosreport di versi Edge for Private Cloud yang didukung.

Versi OPDK Penginstalan baru Upgrade langsung
4.50.00.11 - 4.52.01.00 Perlu penginstalan manual Penginstalan manual diperlukan
4.52.01.01+ Diinstal secara default Upgrade manual diperlukan
Amazon Linux 2023+ Tidak didukung Tidak didukung

Alat Sosreport diinstal secara default di semua node saat melakukan penginstalan baru Edge untuk Private Cloud 4.52.01.01 dan yang lebih baru.

Jika Anda melakukan upgrade langsung ke Edge for Private Cloud 4.52.01.01 atau yang lebih baru, jalankan perintah berikut di setiap node untuk mengupdate alat Sosreport:

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

Anda dapat menjalankan perintah berikut untuk memverifikasi penginstalan dan versi alat Sosreport serta pluginnya:

apigee-service apigee-sosreport version

Untuk menampilkan semua plugin yang mendukung alat Sosreport, gunakan perintah berikut:

sudo sosreport --list-plugins

Untuk mencantumkan plugin khusus Apigee saja, jalankan perintah berikut:

sudo sosreport --list-plugins | grep apigee

Untuk Edge for Private Cloud versi 4.50.00.11 hingga 4.52.01.00, alat Sosreport tersedia, tetapi mungkin memerlukan penyiapan manual, bergantung pada lingkungan Anda.

Jika versi SoS sosreport sudah diinstal

Jika versi SoS asli dari sosreport sudah diinstal di sistem Anda, jangan siapkan versi Apigee, karena jalur penginstalan mungkin bertentangan. Sebagai gantinya, salin plugin khusus Apigee dari direktori /opt/apigee/apigee-sosreport/source/plugin ke direktori site-packages Python yang sesuai menggunakan perintah seperti yang ditunjukkan di bawah. Misalnya, untuk menyalin apigee-mgmt.py:

  • Jika Anda menggunakan Python 2, masukkan: 
    sudo cp apigee-mgmt.py /usr/lib/python2.7/site-packages/sos/plugins/
  • Jika Anda menggunakan Python 3, masukkan: 
    sudo cp apigee-mgmt.py /usr/local/lib/python3.6/site-packages/sos/plugins/

Untuk memverifikasi bahwa plugin telah diinstal, masukkan

sudo sosreport --list-plugins

Jika ada pertanyaan, hubungi dukungan Apigee.

Bagian berikut menjelaskan cara menginstal `sosreport` untuk versi 4.50.00.11 hingga 4.52.01.00.

Menginstal sosreport versi Apigee

Jika versi SoS sosreport belum diinstal di sistem Anda, Anda dapat menginstal versi Apigee dengan memasukkan perintah berikut di semua node tempat Edge untuk Private Cloud diinstal: 

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

Untuk menguji apakah sosreport telah diinstal, pastikan plugin yang terkait dengan Apigee berada di direktori berikut:

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

dengan pythonx.x adalah versi Python yang Anda instal.

Atau, Anda dapat menjalankan salah satu perintah berikut:

  • Untuk memverifikasi plugin khusus Apigee saja: 
    apigee-service apigee-sosreport diagnose -l

    Tindakan ini akan menampilkan daftar plugin khusus Apigee berikut.

    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
  • Untuk memverifikasi semua plugin: 
    apigee-service apigee-sosreport diagnose -s -l

    Perintah ini akan menampilkan daftar plugin berikut yang tersedia dengan 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→

Membuat laporan

Edge for Private Cloud versi 4.52.01.01 dan yang lebih baru

Alat Sosreport dapat mendeteksi komponen yang ada di node Anda dan membuat laporan semua log yang diperlukan oleh tim dukungan untuk analisis.

Untuk membuat laporan, gunakan perintah berikut:

apigee-service apigee-sosreport diagnose

Anda dapat menambahkan tanda berikut jika diperlukan:

  • -f | --file | --config : Jalur ke file konfigurasi yang digunakan saat melakukan penyiapan. 
    Example: apigee-service apigee-sosreport diagnose -f /path/to/configuration.file
  • -o | --output : Untuk mengalihkan sosreport yang dihasilkan ke direktori atau jalur tertentu 
    Example: apigee-service apigee-sosreport diagnose -o /path/to/output_directory/

Edge for Private Cloud versi 4.50.00.11 hingga 4.52.01.00

Untuk membuat laporan menggunakan alat Sosreport, jalankan perintah sosreport dengan opsi plugin yang diperlukan (lihat Plugin Apigee). Direktori default tempat laporan disimpan adalah tmp atau /var/tmp. Anda dapat mengubah direktori tempat laporan disimpan dengan meneruskan direktori lain ke opsi tmp-dir. Misalnya, untuk membuat laporan di Server Pengelolaan dan menyimpannya di direktori bernama my_report-dir, masukkan salah satu perintah berikut:

  • Menggunakan sosreport versi Apigee: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf -o apigee-mgmt  --batch --tmp-dir=my_report-dir
  • Menggunakan sosreport versi SoS: 
    sudo sosreport -o apigee-mgmt  --batch --tmp-dir=my_report-dir

Laporan disimpan dalam file .tar.xz di direktori yang Anda tentukan menggunakan opsi tmp-dir. Lokasi file .tar.xz ditampilkan di STDOUT, serta checksum-nya. Contoh:

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

Laporan disimpan dalam file .tar.xz di direktori yang Anda tentukan menggunakan opsi tmp-dir. Lokasi .tar.xz file ditampilkan di STDOUT, serta checksum. Contoh:

Untuk opsi lain yang tersedia untuk sosreport, baca file man:

sudo man sosreport

Plugin Apigee

Bagian berikut menjelaskan plugin Apigee ke alat Sosreport untuk komponen berikut:

Server Pengelolaan

Plugin apigee-mgmt mengumpulkan informasi berikut dari Server Pengelolaan:

  • nama host server (default)
  • cpuinfo (default)
  • meminfo (default)
  • Setelan Java virtual machine (JVM), seperti memori, Djdk.tls.allowUnsafeServerCertChange, dan sebagainya (default)
  • Log Pengelolaan Saat Ini (default)
  • Sepuluh output top dan jstack berurutan (default)
  • Seluruh folder Log pengelolaan (opsional)
  • config-files (opsional)

Contoh:

Untuk mengumpulkan semua item default, masukkan salah satu hal berikut:

  • Menggunakan sosreport versi Apigee: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mgmt --batch my_report-dir
  • Menggunakan versi SoS sosreport: 
    sudo sosreport -o apigee-mgmt --batch my_report-dir

Untuk mengumpulkan semua item default dan juga item opsional yang ditentukan dalam perintah, misalnya, file konfigurasi dan semua log, masukkan salah satu perintah berikut:

  • Menggunakan versi sosreport 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
  • Menggunakan versi SoS sosreport: 
    sudo sosreport -o apigee-mgmt --batch -k apigee-mgmt.config-files -k apigee-mgmt.all-logs

Untuk mengumpulkan semuanya, masukkan salah satu dari berikut ini:

  • Menggunakan sosreport versi 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

    Atau, Anda dapat memasukkan:

    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mgmt --batch -a
  • Menggunakan versi SoS sosreport: 
    sudo sosreport -o apigee-mgmt --batch -k apigee-mgmt.config-files -k apigee-mgmt.all-logs

    Atau, dapat memasukkan:

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

Message Processor

Plugin apigee-mp mengumpulkan informasi berikut dari Management Processor (MP):

  • Nama host server (default)
  • cpuinfo (default)
  • meminfo (default)
  • info build/info rilis (default)
  • Status apigee-all (default)
  • detail server (default)
  • Setelan tingkat JVM, misalnya, memori, Djdk.tls.allowUnsafeServerCertChange, dll. (default)
  • Log MP saat ini (default)
  • Sepuluh output top, jstack, dan NIO Metrics berurutan (default)
  • Seluruh folder log MP (opsional)
  • Pohon klasifikasi (opsional)
  • Heap dump (opsional)
  • config-files (opsional)
  • Trace runtime (opsional dan hanya jika org:env:api:rev detail disediakan). Catatan: Plugin menunggu selama 25 detik untuk mengumpulkan permintaan runtime.

Contoh:

Untuk mengumpulkan semua item default, masukkan salah satu hal berikut:

  • Menggunakan sosreport versi Apigee: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mp --batch
  • Menggunakan versi SoS sosreport: 
    sudo sosreport -o apigee-mp --batch

Anda juga dapat menentukan item opsional tambahan yang akan dikumpulkan, selain semua item default. Misalnya, untuk menentukan heap dump, menggunakan flag -k apigee-mp.heap, masukkan salah satu dari berikut ini:

  • Menggunakan versi sosreport Apigee: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mp --batch -k apigee-mp.heap
  • Menggunakan versi SoS dari sosreport: 
    sudo sosreport -o apigee-mp --batch -k apigee-mp.heap

Demikian pula, Anda dapat menentukan item opsional berikut:

-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

Anda dapat menentukan beberapa opsi dalam satu perintah. Contoh:

  • Menggunakan versi sosreport 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
  • Menggunakan sosreport versi SoS: 
    sudo sosreport -o apigee-mp --batch -k apigee-mp.deployments -k apigee-mp.all-logs

Untuk mengumpulkan semuanya kecuali rekaman aktivitas, masukkan salah satu perintah berikut:

  • Menggunakan sosreport versi Apigee: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mp --batch -a
  • Menggunakan versi SoS sosreport: 
    sudo sosreport -o apigee-mp --batch -a

Router

Plugin apigee-rrt mengumpulkan informasi berikut dari Router:

  • Nama host server (default)
  • cpuinfo (default)
  • meminfo (default)
  • info build/info rilis (default)
  • Status apigee-all (default)
  • detail server (default)
  • output ps. Tindakan ini akan memberikan setelan tingkat JVM, misalnya, memori, Djdk.tls.allowUnsafeServerCertChange, dan sebagainya (default).
  • Log Router saat ini (default)
  • Daftar nama file vhost termasuk nama file yang buruk (default)
  • Seluruh folder log Router (opsional)
  • config-files (opsional)

Contoh:

Untuk mengumpulkan semua item default, masukkan salah satu hal berikut:

  • Menggunakan sosreport versi Apigee: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-rrt --batch
  • Menggunakan versi SoS sosreport: 
    sudo sosreport -o apigee-rrt --batch

Anda juga dapat menentukan item opsional tambahan untuk dikumpulkan, selain semua item default. Misalnya, untuk menentukan seluruh folder log, menggunakan flag -k apigee-rrt.all-logs, masukkan salah satu parameter berikut:

  • Menggunakan versi sosreport Apigee: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-rrt --batch -k apigee-rrt.all-logs
  • Menggunakan versi SoS dari sosreport: 
    sudo sosreport -o apigee-rrt --batch -k apigee-rrt.all-logs

Demikian pula, Anda dapat menentukan item opsional berikut:

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

Untuk mengumpulkan semuanya:

  • Menggunakan sosreport versi Apigee: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-rrt --batch -a
  • Menggunakan sosreport versi SoS: 
    sudo sosreport -o apigee-rrt --batch -a

Cassandra

Plugin apigee-cassandra mengumpulkan informasi berikut dari node Cassandra:

  • Statistik perangkat: 
    "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 dan versi komponen Apigee apigee-all version && apigee-all status
  • Log apigee-cassandra: Semua file di /opt/apigee/var/log/apigee-cassandra/
  • Jumlah log commit
  • Output perintah Top
  • Thread dump
  • File konfigurasi: cassandra-topology.properties, cassandra.yaml, cassandra-env.sh
  • Output Nodetool untuk parameter berikut: version, status, ring, info, gossipinfo, compactionstats -H, tpstats, netstats, cfstats, proxyhistograms

Contoh:

Untuk mengumpulkan semua item default, masukkan salah satu hal berikut:

  • Menggunakan sosreport versi Apigee: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-cassandra
  • Menggunakan versi SoS sosreport: 
    sudo sosreport -o apigee-cassandra