Anda sedang melihat dokumentasi Apigee Edge.
Buka
Dokumentasi Apigee X. info
Sosreport adalah alat diagnostik dan pengumpulan data tingkat sistem, yang didasarkan pada software SoS. Anda dapat menggunakan alat Sosreport untuk mengumpulkan informasi guna membantu men-debug masalah di node tempat Apigee komponen berjalan. Alat ini mengumpulkan dan menyimpan informasi secara lokal pada 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 {i>kernel<i} yang sedang berjalan
- Modul yang dimuat
- File konfigurasi sistem dan layanan
Sosreport juga menjalankan program eksternal untuk mengumpulkan termasuk:
- Log Apigee dari semua komponen.
- Diagnostik runtime
- Diagnostik Cassandra dikumpulkan menggunakan perintah nodetool.
Alat Sosreport berisi dua perintah utama:
sosreport
: Perintah utama untuk mengumpulkan data dan membuat laporan.apigee-sosreport
: Alat tambahan yang digunakan untuk menginstalsosreport
dan kelola pluginsosreport
khusus untuk komponen Apigee.
Penginstalan
Bagian ini menjelaskan cara menginstal sosreport
.
Jika versi SoS sosreport
sudah diinstal
Jika data asli
Versi SoS dari sosreport
sudah terinstal
di sistem Anda,
tidak menyiapkan versi Apigee, karena jalur penginstalannya mungkin bertentangan.
Sebagai gantinya, salin plugin khusus Apigee dari direktori
/opt/apigee/apigee-sosreport/source/plugin
ke Python yang sesuai
site-packages
menggunakan perintah seperti yang ditunjukkan di bawah ini.
Misalnya, untuk menyalin agigee-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.
Menginstal versi Apigee dari sosreport
Jika sosreport
versi SoS tidak
yang sudah terinstal di sistem, Anda dapat menginstal versi Apigee dengan memasukkan
perintah berikut pada semua node tempat Edge for 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 gatehring class
- Untuk memverifikasi semua plugin:
apigee-service apigee-sosreport diagnose -s -l
Tindakan ini akan menampilkan daftar plugin yang tersedia di sosreport berikut:
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
Untuk membuat laporan menggunakan alat Sosreport, jalankan perintah sosreport
dengan opsi plugin yang diperlukan (lihat plugin Apigee). Tujuan
direktori default tempat laporan disimpan adalah tmp
atau /var/tmp
.
Anda dapat mengubah direktori tempat laporan disimpan dengan meneruskan direktori yang berbeda
ke opsi tmp-dir
. Misalnya, untuk membuat laporan tentang
Server Pengelolaan dan menyimpannya
dalam direktori bernama my_report-dir
,
masukkan salah satu dari berikut ini:
- Menggunakan versi
sosreport
Apigee:sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf -o apigee-mgmt --batch --tmp-dir=my_report-dir
- Menggunakan versi Sos dari sosreport:
sudo sosreport -o apigee-mgmt --batch --tmp-dir=my_report-dir
Laporan disimpan dalam file .tar.xz
di direktori yang Anda tentukan menggunakan
tmp-dir
.
Lokasi file .tar.xz
ditampilkan di STDOUT, serta checksum. 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
tmp-dir
.
Lokasi .tar.xz file
ditampilkan di STDOUT
, serta
{i>checksum<i}. Contoh:
Untuk opsi lainnya 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 mesin virtual (JVM) Java, seperti memori,
Djdk.tls.allowUnsafeServerCertChange
, dan sebagainya (default) - Log Pengelolaan Saat Ini (default)
- Sepuluh output jstacks dan top berurutan (default)
- Seluruh folder log Pengelolaan (opsional)
- file-konfigurasi (opsional)
Contoh:
Untuk mengumpulkan semua item default, masukkan salah satu opsi berikut:
- Menggunakan versi
sosreport
Apigee:sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf -o apigee-mgmt --batch my_report-dir
- Menggunakan
sosreport
versi SoS:sudo sosreport -o apigee-mgmt --batch my_report-dir
Untuk mengumpulkan semua item default dan juga item opsional yang ditentukan dalam perintah, untuk misalnya, file konfigurasi dan semua log, masukkan salah satu opsi 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
sosreport
versi SoS: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 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
Atau, Anda dapat memasukkan:
sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf -o apigee-mgmt --batch -a
- Menggunakan
sosreport
versi SoS: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
Prosesor Pengelolaan (MP):
- Nama host server (default)
- cpuinfo (default)
- meminfo (default)
- info buildinfo/rilis (default)
- status apigee-all (default)
- detail server (default)
- Setelan level JVM, misalnya, memori,
Djdk.tls.allowUnsafeServerCertChange
, dll. (default) - Log MP saat ini (default)
- Sepuluh output Metrik teratas, jstacks, dan NIO yang berurutan (default)
- Seluruh folder log MP (opsional)
- Hierarki klasifikasi (opsional)
- Heap dump (opsional)
- file-konfigurasi (opsional)
- Rekaman aktivitas runtime (opsional dan hanya saat
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 opsi berikut:
- Menggunakan versi
sosreport
Apigee:sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf -o apigee-mp --batch
- Menggunakan
sosreport
versi SoS:sudo sosreport -o apigee-mp --batch
Anda juga dapat menentukan item opsional tambahan untuk dikumpulkan, selain semua item default.
Misalnya, untuk menentukan heap dump, menggunakan flag
-k apigee-mp.heap
, masukkan salah satu opsi berikut:
- Menggunakan versi
sosreport
Apigee:sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf -o apigee-mp --batch -k apigee-mp.heap
- Menggunakan
sosreport
versi SoS: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 informasi berikut:
- Menggunakan versi
sosreport
Apigee:sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf -o apigee-mp --batch -a
- Menggunakan
sosreport
versi SoS:sudo sosreport -o apigee-mp --batch -a
Router
Plugin apigee-rrt
mengumpulkan informasi berikut dari
{i>Router<i}:
- Nama host server (default)
- cpuinfo (default)
- meminfo (default)
- info buildinfo/rilis (default)
- status apigee-all (default)
- detail server (default)
- ps. Ini akan memberikan pengaturan level JVM, misalnya, {i>memory<i}, 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)
- file-konfigurasi (opsional)
Contoh:
Untuk mengumpulkan semua item default, masukkan salah satu opsi berikut:
- Menggunakan versi
sosreport
Apigee:sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf -o apigee-rrt --batch
- Menggunakan
sosreport
versi SoS: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 penanda
-k apigee-rrt.all-logs
, masukkan salah satu opsi 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
sosreport
versi SoS: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 versi
sosreport
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 mesin:
"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-semua versi && status apigee-semua
- log apigee-cassandra:
Semua file di bawah
/opt/apigee/var/log/apigee-cassandra/
- Jumlah log commit
- Output perintah Atas
- Thread dump
- File konfigurasi:
cassandra-topology.properties
,cassandra.yaml
,cassandra-env.sh
- Output Nodetool untuk parameter berikut: version, status, ring, info, gossipinfo, pemadatan -H, tpstats, netstats, cfstats, {i>proxyhistograms<i}
Contoh:
Untuk mengumpulkan semua item default, masukkan salah satu opsi berikut:
- Menggunakan versi
sosreport
Apigee:sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf -o apigee-cassandra
- Menggunakan
sosreport
versi SoS:sudo sosreport -o apigee-cassandra