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 men-debug masalah di node tempat komponen Apigee dijalankan. 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, serta menyimpan data dalam arsip. Untuk komponen Apigee, Sosreport mengumpulkan hal berikut:
- Versi {i>kernel<i} 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 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 mengelola pluginsosreport
khusus untuk komponen Apigee.
Penginstalan
Bagian ini menjelaskan cara menginstal sosreport
.
Jika versi SoS sosreport
sudah terinstal
Jika versi SoS asli dari sosreport
sudah diinstal di sistem Anda, jangan siapkan versi Apigee, karena jalur penginstalan dapat bertentangan.
Sebagai gantinya, salin plugin khusus Apigee dari direktori
/opt/apigee/apigee-sosreport/source/plugin
ke direktori Python
site-packages
yang sesuai menggunakan perintah seperti yang ditampilkan 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 sosreport
versi Apigee
Jika versi SoS sosreport
belum
terinstal di sistem, Anda dapat menginstal versi Apigee dengan memasukkan
perintah berikut di 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
sudah 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
Perintah 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
Perintah ini akan menampilkan daftar plugin 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
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 yang berbeda
ke opsi tmp-dir
. Misalnya, untuk membuat laporan di Server Pengelolaan dan menyimpannya di direktori bernama my_report-dir
, masukkan salah satu opsi 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 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
opsi 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
opsi tmp-dir
.
Lokasi .tar.xz file
ditampilkan pada STDOUT
, serta
checksum. Contoh:
Guna mengetahui 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 mesin virtual Java (JVM), seperti memori,
Djdk.tls.allowUnsafeServerCertChange
, dan sebagainya (default) - Log Pengelolaan Saat Ini (default)
- Sepuluh output atas dan jstacks 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 hal berikut:
- 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
- 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:
- 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/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 teratas berurutan, jstacks, dan NIO Metrics (default)
- Seluruh folder log MP (opsional)
- Hierarki klasifikasi (opsional)
- Heap dump (opsional)
- config-files (opsional)
- Rekaman aktivitas 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
Selain semua item default, Anda juga dapat menentukan item opsional tambahan yang akan dikumpulkan.
Misalnya, untuk menentukan heap dump, menggunakan tanda
-k apigee-mp.heap
, masukkan salah satu parameter berikut:
- Menggunakan
sosreport
versi Apigee:sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf -o apigee-mp --batch -k apigee-mp.heap
- Menggunakan versi SoS
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
sosreport
versi 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 versi SoS
sosreport
:sudo sosreport -o apigee-mp --batch -k apigee-mp.deployments -k apigee-mp.all-logs
Untuk mengumpulkan semuanya kecuali trace, masukkan salah satu opsi 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/rilis (default)
- status apigee-all (default)
- detail server (default)
- {i>ps<i}. Perintah ini akan memberikan setelan level JVM, misalnya, memory, 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
Selain semua item default, Anda juga dapat menentukan item opsional tambahan yang akan dikumpulkan.
Misalnya, untuk menentukan seluruh folder log, menggunakan flag
-k apigee-rrt.all-logs
, masukkan salah satu opsi berikut:
- Menggunakan
sosreport
versi Apigee:sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf -o apigee-rrt --batch -k apigee-rrt.all-logs
- Menggunakan versi SoS
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 versi SoS
sosreport
:sudo sosreport -o apigee-rrt --batch -a
Cassandra
Plugin apigee-cassandra
mengumpulkan informasi berikut dari
node Casssandra:
- 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 versi apigee-all && apigee-all status
- apigee-cassandra logs:
Semua file di bagian
/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: versi, status, ring, info, gossipinfo, Compactionstats -H, tpstats, netstats, cfstats, proxyhistogram
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