أداة Sosreport

أنت تعرض مستندات Apigee Edge.
انتقل إلى مستندات Apigee X. معلومات

Sosreport هي أداة تشخيصية وجمع بيانات على مستوى النظام، تستند إلى المصدر المفتوح البرامج SoS. يمكنك استخدام أداة Sosreport لجمع معلومات لمساعدتك في تصحيح الأخطاء. في النقاط حيث يشير Apigee قيد التشغيل. تجمع الأداة المعلومات وتخزنها محليًا على نظام ملفات العقدة.

تجمع أداة Sosreport تفاصيل التهيئة ومعلومات النظام معلومات التشخيص من نظامك ويخزن البيانات في أرشيف. بالنسبة إلى مكونات Apigee، يجمع Sosreport ما يلي:

  • إصدار النواة قيد التشغيل
  • الوحدات التي تم تحميلها
  • ملفات إعداد الخدمة والنظام

يدير Sosreport أيضًا برامج خارجية لجمع المزيد من المعلومات، بما في ذلك:

  • سجلّات Apigee من جميع المكوّنات
  • بيانات التشخيص أثناء التشغيل
  • بيانات تشخيص كاساندرا التي تم جمعها باستخدام أوامر العقدة.

تحتوي أداة Sosreport على أمرين رئيسيين:

  • sosreport: الأمر الأساسي لجمع البيانات وإنشاء التقارير.
  • apigee-sosreport: أداة إضافية تُستخدم للتثبيت sosreport وإدارة مكوّنات sosreport الإضافية الخاصة بمكونات Apigee

تثبيت

يوضّح هذا القسم كيفية تثبيت "sosreport".

في حال سبق أن تم تثبيت إصدار SoS من "sosreport"

إذا كانت النتيجة الأصلية إصدار SoS من sosreport مثبت بالفعل على نظامك، يُرجى عدم إعداد إصدار Apigee، لأنّ مسارات التثبيت قد تتعارض. بدلاً من ذلك، انسخ المكوّنات الإضافية الخاصة بـ Apigee من الدليل. /opt/apigee/apigee-sosreport/source/plugin إلى لغة Python المناسبة site-packages باستخدام أمر مثل الأوامر الموضحة أدناه. على سبيل المثال، لنسخ agigee-mgmt.py:

  • إذا كنت تستخدم Python 2، أدخِل: 
    sudo cp apigee-mgmt.py /usr/lib/python2.7/site-packages/sos/plugins/
  • إذا كنت تستخدم Python 3، أدخِل: 
    sudo cp apigee-mgmt.py /usr/local/lib/python3.6/site-packages/sos/plugins/

للتحقّق من تثبيت المكوّنات الإضافية، أدخِل

sudo sosreport --list-plugins

إذا كانت لديك أسئلة، يُرجى التواصل مع فريق دعم Apigee.

جارٍ تثبيت إصدار sosreport من Apigee

إذا لم يكن إصدار SoS من sosreport مثبت بالفعل على نظامك، يمكنك تثبيت إصدار Apigee من خلال إدخال الأوامر التالية على جميع العقد حيث تم تثبيت Edge for Private Cloud: 

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

لاختبار تثبيت sosreport، تأكد من أن المكوّنات الإضافية ذات الصلة تتوفّر Apigee في الدليل التالي:

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

حيث pythonx.x هو نسختك المثبَّتة من Python.

ويمكنك بدلاً من ذلك تشغيل أحد الطلبات التالية:

  • للتحقّق من المكوّنات الإضافية الخاصة بـ Apigee فقط، اتّبِع الخطوات التالية: 
    apigee-service apigee-sosreport diagnose -l

    تؤدي هذه الخطوة إلى عرض القائمة التالية للمكوّنات الإضافية الخاصة بـ Apigee.

    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
  • للتحقق من جميع المكوّنات الإضافية: 
    apigee-service apigee-sosreport diagnose -s -l

    يؤدي هذا إلى عرض القائمة التالية من المكونات الإضافية المتوفرة مع 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→

إنشاء تقرير

لإنشاء تقرير باستخدام أداة Sosreport، شغِّل الأمر sosreport. باستخدام خيار المكوّن الإضافي المطلوب (اطّلِع على مكوّنات Apigee الإضافية). تشير رسالة الأشكال البيانية الدليل التلقائي الذي يتم فيه تخزين التقرير هو tmp أو /var/tmp. يمكنك تغيير الدليل الذي يتم تخزين التقرير فيه من خلال تمرير دليل مختلف. إلى الخيار tmp-dir. على سبيل المثال، لإنشاء تقرير عن خادم الإدارة واحفظه دليلاً باسم my_report-dir، أدخِل أيًا مما يلي:

  • باستخدام إصدار sosreport من Apigee: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf -o apigee-mgmt  --batch --tmp-dir=my_report-dir
  • استخدام إصدار SoS من Sosreport: 
    sudo sosreport -o apigee-mgmt  --batch --tmp-dir=my_report-dir

يتم تخزين التقرير في ملف .tar.xz في الدليل الذي تحدّده باستخدام الخيار tmp-dir يظهر موقع ملف .tar.xz على STDOUT، بالإضافة إلى المجموع الاختباري. على سبيل المثال:

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

يتم تخزين التقرير في ملف .tar.xz في الدليل الذي تحدّده باستخدام الخيار tmp-dir يظهر موقع .tar.xz file في STDOUT، بالإضافة إلى المجموع الاختباري. على سبيل المثال:

للحصول على مزيد من الخيارات المتاحة بشأن sosreport، يُرجى قراءة الملف man:

sudo man sosreport

مكوّنات Apigee الإضافية

تصف الأقسام التالية مكونات Apigee الإضافية لأداة Sosreport المكونات التالية:

خادم الإدارة

يجمع المكوّن الإضافي apigee-mgmt المعلومات التالية من خادم الإدارة:

  • اسم مضيف الخادم (الإعداد التلقائي)
  • cpuinfo (تلقائي)
  • Meminfo (تلقائي)
  • إعدادات جهاز Java الافتراضي (JVM) مثل الذاكرة Djdk.tls.allowUnsafeServerCertChange وما إلى ذلك (تلقائي)
  • سجلات الإدارة الحالية (تلقائي)
  • عشرة مخرجات تسلسلية في الأعلى وjstacks (الإعداد التلقائي)
  • مجلد سجلّ "الإدارة" بالكامل (اختياري)
  • config-files (اختياريّة)

أمثلة:

لجمع كل العناصر التلقائية، أدخِل أحد العناصر التالية:

  • باستخدام إصدار sosreport من Apigee: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mgmt --batch my_report-dir
  • باستخدام إصدار SoS من sosreport: 
    sudo sosreport -o apigee-mgmt --batch my_report-dir

لجمع كل العناصر التلقائية وكذلك العناصر الاختيارية المحددة في الأمر، مثال، ملفات التهيئة وجميع السجلات، أدخل أحد ما يلي:

  • باستخدام إصدار 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
  • باستخدام إصدار SoS من sosreport: 
    sudo sosreport -o apigee-mgmt --batch -k apigee-mgmt.config-files -k apigee-mgmt.all-logs

لجمع كل البيانات، أدخِل إحدى القيم التالية:

  • باستخدام إصدار 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

    بدلاً من ذلك، يمكنك إدخال:

    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mgmt --batch -a
  • باستخدام إصدار SoS من sosreport: 
    sudo sosreport -o apigee-mgmt --batch -k apigee-mgmt.config-files -k apigee-mgmt.all-logs

    بدلاً من ذلك، يمكن إدخال ما يلي:

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

معالج الرسائل

يجمع المكوّن الإضافي apigee-mp المعلومات التالية من معالج الإدارة (MP):

  • اسم مضيف الخادم (تلقائي)
  • cpuinfo (تلقائي)
  • Meminfo (تلقائي)
  • Buildinfo/release info (تلقائي)
  • حالة apigee-all (تلقائي)
  • تفاصيل الخادم (تلقائي)
  • الإعدادات على مستوى JVM، مثل الذاكرة وDjdk.tls.allowUnsafeServerCertChange وما إلى ذلك (تلقائي)
  • سجلات MP الحالية (تلقائي)
  • عشرة مخرجات تسلسلية لأعلى وjstacks وNIO Metrics (الإعداد التلقائي)
  • مجلد سجلات MP بالكامل (اختياري)
  • شجرة التصنيف (اختياري)
  • تسجيل لقطات لأجزاء من الذاكرة (اختياري)
  • config-files (اختياريّة)
  • تتبُّع بيئة التشغيل (اختياريّة وعند حدوث org:env:api:rev detail فقط) ). ملاحظة: ينتظر المكوِّن الإضافي مدة 25 ثانية لجمع طلبات وقت التشغيل.

أمثلة:

لجمع كل العناصر التلقائية، أدخِل أحد العناصر التالية:

  • باستخدام إصدار sosreport من Apigee: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mp --batch
  • باستخدام إصدار SoS من sosreport: 
    sudo sosreport -o apigee-mp --batch

يمكنك أيضًا تحديد عناصر اختيارية إضافية لجمعها، بالإضافة إلى كل العناصر التلقائية. على سبيل المثال، لتحديد لقطة لأجزاء من الذاكرة باستخدام العلامة -k apigee-mp.heap، أدخِل إحدى القيم التالية:

  • باستخدام إصدار sosreport من Apigee: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mp --batch -k apigee-mp.heap
  • باستخدام إصدار SoS من sosreport: 
    sudo sosreport -o apigee-mp --batch -k apigee-mp.heap

وبالمثل، يمكنك تحديد العناصر الاختيارية التالية:

-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

ويمكنك تحديد خيارات متعددة في أمر واحد. على سبيل المثال:

  • باستخدام إصدار 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
  • باستخدام إصدار SoS من sosreport: 
    sudo sosreport -o apigee-mp --batch -k apigee-mp.deployments -k apigee-mp.all-logs

لجمع كل البيانات باستثناء بيانات آثار الأنشطة، أدخِل قيمة مما يلي:

  • باستخدام إصدار sosreport من Apigee: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mp --batch -a
  • باستخدام إصدار SoS من sosreport: 
    sudo sosreport -o apigee-mp --batch -a

جهاز التوجيه

يجمع المكوّن الإضافي apigee-rrt المعلومات التالية من الموجه:

  • اسم مضيف الخادم (تلقائي)
  • cpuinfo (تلقائي)
  • Meminfo (تلقائي)
  • Buildinfo/release info (تلقائي)
  • حالة apigee-all (تلقائي)
  • تفاصيل الخادم (تلقائي)
  • إخراج ps. سيمنح ذلك إعدادات مستوى JVM، على سبيل المثال، الذاكرة، Djdk.tls.allowUnsafeServerCertChange، وما إلى ذلك (تلقائي).
  • سجلّات جهاز التوجيه الحالية (تلقائي)
  • قائمة بأسماء ملفات vhost التي تتضمّن أسماء الملفات السيئة (تلقائية)
  • مجلد سجلّ جهاز التوجيه بالكامل (اختياري)
  • config-files (اختياريّة)

أمثلة:

لجمع كل العناصر التلقائية، أدخِل أحد العناصر التالية:

  • باستخدام إصدار sosreport من Apigee: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-rrt --batch
  • باستخدام إصدار SoS من sosreport: 
    sudo sosreport -o apigee-rrt --batch

يمكنك أيضًا تحديد عناصر اختيارية إضافية لجمعها، بالإضافة إلى كل العناصر التلقائية. على سبيل المثال، لتحديد مجلد السجل بالكامل، باستخدام العلامة -k apigee-rrt.all-logs، أدخِل إحدى القيم التالية:

  • باستخدام إصدار sosreport من Apigee: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-rrt --batch -k apigee-rrt.all-logs
  • باستخدام إصدار SoS من sosreport: 
    sudo sosreport -o apigee-rrt --batch -k apigee-rrt.all-logs

وبالمثل، يمكنك تحديد العناصر الاختيارية التالية:

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

لجمع كلّ البيانات، اتّبِع الخطوات التالية:

  • باستخدام إصدار sosreport من Apigee: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-rrt --batch -a
  • باستخدام إصدار SoS من sosreport: 
    sudo sosreport -o apigee-rrt --batch -a

كاساندرا

يجمع المكوّن الإضافي apigee-cassandra المعلومات التالية من عُقد Cassandra:

  • إحصائيات الجهاز: 
    "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 وإصداره إصدار apigee-all && حالة apigee-all
  • سجلات apigee-cassandra: كل الملفات ضمن /opt/apigee/var/log/apigee-cassandra/
  • تنفيذ عدد السجلات
  • ناتج الأمر العلوي
  • تفريغ سلسلة المحادثات
  • ملفات الإعداد: cassandra-topology.properties وcassandra.yaml cassandra-env.sh
  • إخراج Nodetool للمعلَمات التالية: الإصدار والحالة والحلقة والمعلومات ومعلومات شائعات Compactionstats -H، وtpstats، وnetstats، وcfstats، وproxyhistograms

مثال:

لجمع كل العناصر التلقائية، أدخِل أحد العناصر التالية:

  • باستخدام إصدار sosreport من Apigee: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-cassandra
  • باستخدام إصدار SoS من sosreport: 
    sudo sosreport -o apigee-cassandra