ابزار Sosreport

شما در حال مشاهده مستندات Apigee Edge هستید.
به مستندات Apigee X مراجعه کنید . اطلاعات

Sosreport یک ابزار تشخیص و جمع‌آوری داده در سطح سیستم است که بر اساس نرم‌افزار متن‌باز SoS ساخته شده است. شما می‌توانید از ابزار Sosreport برای جمع‌آوری اطلاعات جهت کمک به اشکال‌زدایی مشکلات در گره‌هایی که یک جزء Apigee در آنها اجرا می‌شود، استفاده کنید. این ابزار اطلاعات را به‌صورت محلی در سیستم فایل گره جمع‌آوری و ذخیره می‌کند.

ابزار Sosreport جزئیات پیکربندی، اطلاعات سیستم و اطلاعات تشخیصی را از سیستم شما جمع‌آوری کرده و داده‌ها را در یک بایگانی ذخیره می‌کند. برای اجزای Apigee، Sosreport موارد زیر را جمع‌آوری می‌کند:

  • نسخه هسته در حال اجرا
  • ماژول‌های بارگذاری شده
  • فایل‌های پیکربندی سیستم و سرویس

Sosreport همچنین برنامه‌های خارجی را برای جمع‌آوری اطلاعات بیشتر اجرا می‌کند، از جمله:

  • لاگ‌های Apigee از تمام اجزا.
  • تشخیص زمان اجرا
  • تشخیص‌های کاساندرا با استفاده از دستورات nodetool جمع‌آوری می‌شوند.

ابزار Sosreport شامل دو دستور اصلی است:

  • sosreport : دستور اصلی برای جمع‌آوری داده‌ها و ایجاد گزارش‌ها.
  • apigee-sosreport : یک ابزار کمکی که برای نصب sosreport و مدیریت افزونه‌های sosreport مخصوص کامپوننت‌های Apigee استفاده می‌شود.

نصب

جدول زیر جزئیات مربوط به در دسترس بودن و روش نصب ابزار Sosreport در نسخه‌های پشتیبانی‌شده توسط Edge برای Private Cloud را نشان می‌دهد.

نسخه OPDK نصب تازه ارتقاء درجا
۴.۵۰.۰۰.۱۱ - ۴.۵۲.۰۱.۰۰ نصب دستی مورد نیاز است نصب دستی مورد نیاز است
۴.۵۲.۰۱.۰۱+ پیش‌فرض نصب شده پیش‌فرض نصب شده
آمازون لینوکس ۲۰۲۳+ پشتیبانی نمی‌شود پشتیبانی نمی‌شود

ابزار Sosreport به طور پیش‌فرض روی همه گره‌ها هنگام تنظیم یا به‌روزرسانی Edge برای Private Cloud نسخه‌های ۴.۵۲.۰۱.۰۱ و بالاتر نصب می‌شود.

برای تأیید نصب و نسخه ابزار Sosreport و افزونه‌های آن، می‌توانید دستور زیر را اجرا کنید:

apigee-service apigee-sosreport version

برای فهرست کردن تمام افزونه‌هایی که از ابزار Sosreport پشتیبانی می‌کنند، از دستور زیر استفاده کنید:

sudo sosreport --list-plugins

برای لیست کردن فقط افزونه‌های مخصوص Apigee، دستور زیر را اجرا کنید:

sudo sosreport --list-plugins | grep apigee

برای نسخه‌های ۴.۵۰.۰۰.۱۱ تا ۴.۵۲.۰۱.۰۰ مرورگر اج برای فضای ابری خصوصی، ابزار Sosreport در دسترس است، اما بسته به محیط شما ممکن است نیاز به تنظیم دستی داشته باشد.

اگر نسخه SoS از sosreport از قبل نصب شده باشد

اگر نسخه اصلی SoS از sosreport از قبل روی سیستم شما نصب شده است، نسخه Apigee را تنظیم نکنید ، زیرا ممکن است مسیرهای نصب با هم تداخل داشته باشند. در عوض، افزونه‌های مخصوص Apigee را از دایرکتوری /opt/apigee/apigee-sosreport/source/plugin با استفاده از دستوری مانند آنچه در زیر نشان داده شده است، در دایرکتوری مناسب site-packages پایتون کپی کنید. به عنوان مثال، برای کپی کردن apigee-mgmt.py :

  • اگر از پایتون ۲ استفاده می‌کنید، وارد کنید: 
    sudo cp apigee-mgmt.py /usr/lib/python2.7/site-packages/sos/plugins/
  • اگر از پایتون ۳ استفاده می‌کنید، وارد کنید: 
    sudo cp apigee-mgmt.py /usr/local/lib/python3.6/site-packages/sos/plugins/

برای تأیید نصب افزونه‌ها، وارد کنید

sudo sosreport --list-plugins

در صورت داشتن هرگونه سوال، با پشتیبانی Apigee تماس بگیرید.

بخش زیر نحوه نصب `sosreport` را برای نسخه‌های ۴.۵۰.۰۰.۱۱ تا ۴.۵۲.۰۱.۰۰ توضیح می‌دهد.

نصب نسخه Apigee از sosreport

اگر نسخه 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 نسخه نصب شده پایتون شما است.

به عنوان یک راه حل جایگزین، می‌توانید یکی از دستورات زیر را اجرا کنید:

  • برای تأیید افزونه‌های مخصوص 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 gathering 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 می‌تواند اجزای موجود در گره شما را شناسایی کرده و گزارشی از تمام گزارش‌های مورد نیاز تیم‌های پشتیبانی برای تجزیه و تحلیل ایجاد کند.

برای تولید گزارش، از دستور زیر استفاده کنید: 

apigee-service apigee-sosreport diagnose

در صورت نیاز می‌توانید پرچم‌های زیر را اضافه کنید:

  • -f | --file | --config : مسیر فایل پیکربندی مورد استفاده هنگام انجام تنظیمات. 
    Example: apigee-service apigee-sosreport diagnose -f /path/to/configuration.file
  • ‎-o | --output: برای هدایت sosreport تولید شده به یک دایرکتوری یا مسیر خاص 
    Example: apigee-service apigee-sosreport diagnose -o /path/to/output_directory/

نسخه‌های ۴.۵۰.۰۰.۱۱ تا ۴.۵۲.۰۱.۰۰ مرورگر اج برای فضای ابری خصوصی

برای ایجاد گزارش با استفاده از ابزار Sosreport، دستور sosreport را با گزینه افزونه مورد نیاز اجرا کنید (به افزونه‌های Apigee مراجعه کنید). دایرکتوری پیش‌فرض که گزارش در آن ذخیره می‌شود، tmp یا /var/tmp است. می‌توانید با ارسال یک دایرکتوری متفاوت به گزینه tmp-dir ، دایرکتوری محل ذخیره گزارش را تغییر دهید. به عنوان مثال، برای ایجاد گزارش در سرور مدیریت و ذخیره آن در دایرکتوری به نام my_report-dir ، یکی از موارد زیر را وارد کنید:

  • با استفاده از نسخه Apigee از sosreport : 
    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 و همچنین checksum نشان داده می‌شود. برای مثال: 

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 و همچنین checksum نشان داده می‌شود. برای مثال:

برای گزینه‌های بیشتر برای sosreport ، فایل man را بخوانید: 

sudo man sosreport

افزونه‌های Apigee

بخش‌های زیر افزونه‌های Apigee برای ابزار Sosreport را برای اجزای زیر شرح می‌دهند:

سرور مدیریت

افزونه apigee-mgmt اطلاعات زیر را از سرور مدیریت جمع‌آوری می‌کند:

  • نام میزبان سرور (پیش‌فرض)
  • cpuinfo (پیش‌فرض)
  • اطلاعات حافظه (پیش‌فرض)
  • تنظیمات ماشین مجازی جاوا (JVM)، مانند حافظه، Djdk.tls.allowUnsafeServerCertChange و غیره (پیش‌فرض)
  • گزارش‌های مدیریت فعلی (پیش‌فرض)
  • خروجی ده تایی top و jstacks متوالی (پیش‌فرض)
  • کل پوشه لاگ مدیریت (اختیاری)
  • فایل‌های پیکربندی (اختیاری)

مثال‌ها:

برای جمع‌آوری همه موارد پیش‌فرض، یکی از موارد زیر را وارد کنید:

  • با استفاده از نسخه Apigee از sosreport : 
    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

برای جمع‌آوری تمام موارد پیش‌فرض و همچنین موارد اختیاری مشخص‌شده در دستور، مثلاً فایل‌های پیکربندی و تمام گزارش‌ها، یکی از موارد زیر را وارد کنید:

  • با استفاده از نسخه Apigee از sosreport : 
    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

برای جمع‌آوری همه چیز، یکی از موارد زیر را وارد کنید:

  • با استفاده از نسخه Apigee از sosreport :
    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 (پیش‌فرض)
  • اطلاعات حافظه (پیش‌فرض)
  • اطلاعات ساخت/انتشار (پیش‌فرض)
  • وضعیت همه آپیجی (پیش‌فرض)
  • جزئیات سرور (پیش‌فرض)
  • تنظیمات سطح JVM، برای مثال، حافظه، Djdk.tls.allowUnsafeServerCertChange و غیره (پیش‌فرض)
  • گزارش‌های فعلی MP (پیش‌فرض)
  • ده خروجی متوالی top، jstacks و NIO Metrics (پیش‌فرض)
  • کل پوشه گزارش MP (اختیاری)
  • درخت طبقه‌بندی (اختیاری)
  • تخلیه هیپ (اختیاری)
  • فایل‌های پیکربندی (اختیاری)
  • ردیابی زمان اجرا (اختیاری و فقط زمانی که org:env:api:rev detail ارائه شده باشد). توجه: افزونه 25 ثانیه برای جمع آوری درخواست های زمان اجرا منتظر می ماند.

مثال‌ها:

برای جمع‌آوری همه موارد پیش‌فرض، یکی از موارد زیر را وارد کنید:

  • با استفاده از نسخه Apigee از sosreport : 
    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 ، یکی از موارد زیر را وارد کنید:

  • با استفاده از نسخه Apigee از sosreport : 
    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

شما می‌توانید چندین گزینه را در یک دستور مشخص کنید. برای مثال:

  • با استفاده از نسخه Apigee از sosreport : 
    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

برای جمع‌آوری همه چیز به جز ردیابی، یکی از موارد زیر را وارد کنید:

  • با استفاده از نسخه Apigee از sosreport : 
    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 (پیش‌فرض)
  • اطلاعات حافظه (پیش‌فرض)
  • اطلاعات ساخت/انتشار (پیش‌فرض)
  • وضعیت همه آپیجی (پیش‌فرض)
  • جزئیات سرور (پیش‌فرض)
  • خروجی ps. این تنظیمات سطح JVM، به عنوان مثال، حافظه، Djdk.tls.allowUnsafeServerCertChange و غیره (پیش‌فرض) را ارائه می‌دهد.
  • گزارش‌های فعلی روتر (پیش‌فرض)
  • فهرست نام فایل‌های میزبان مجازی شامل نام‌های نامناسب فایل (پیش‌فرض)
  • کل پوشه لاگ روتر (اختیاری)
  • فایل‌های پیکربندی (اختیاری)

مثال‌ها:

برای جمع‌آوری همه موارد پیش‌فرض، یکی از موارد زیر را وارد کنید:

  • با استفاده از نسخه Apigee از sosreport : 
    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 ، یکی از موارد زیر را وارد کنید:

  • با استفاده از نسخه Apigee از sosreport : 
    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

برای جمع آوری همه چیز:

  • با استفاده از نسخه Apigee از sosreport : 
    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 اطلاعات زیر را از گره‌های کاساندرا جمع‌آوری می‌کند:

  • آمار ماشین آلات: 
    "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 برای پارامترهای زیر: نسخه، وضعیت، حلقه، اطلاعات، اطلاعات عمومی، آمار فشرده‌سازی -H، آمار tpstats، آمار شبکه، آمار cfstats، نمودارهای پروکسی

مثال:

برای جمع‌آوری همه موارد پیش‌فرض، یکی از موارد زیر را وارد کنید:

  • با استفاده از نسخه Apigee از sosreport : 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-cassandra
  • استفاده از نسخه SoS از sosreport : 
    sudo sosreport -o apigee-cassandra