ابزار Sosreport

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

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

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

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

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

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

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

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

نصب

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

نسخه OPDK نصب جدید ارتقا درجا
4.50.00.11 - 4.52.01.00 نصب دستی لازم است نصب دستی لازم است
4.52.01.01+ نصب‌شده به‌طور پیش‌فرض ارتقای دستی لازم است
Amazon Linux 2023+‎ پشتیبانی نمی‌شود پشتیبانی نمی‌شود

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

اگر ارتقای درجا به Edge for Private Cloud نسخه ۴.۵۲.۰۱.۰۱ یا جدیدتر انجام می‌دهید، فرمان زیر را در هر گره اجرا کنید تا ابزار Sosreport به‌روز شود:

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

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

apigee-service apigee-sosreport version

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

sudo sosreport --list-plugins

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

sudo sosreport --list-plugins | grep apigee

برای Edge برای نسخه‌های Private Cloud از 4.50.00.11 تا 4.52.01.00، ابزار Sosreport دردسترس است اما ممکن است بسته به محیط شما به راه‌اندازی دستی نیاز داشته باشد.

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

اگر نسخه اصلی SoS از sosreport ازقبل در سیستم شما نصب شده است، نسخه Apigee را راه‌اندازی نکنید، زیرا مسیرهای نصب ممکن است با هم تداخل داشته باشند. به‌جای آن، افزایه‌های مختص Apigee را از فهرست راهنمای /opt/apigee/apigee-sosreport/source/plugin به فهرست راهنمای Python site-packages مناسب بااستفاده از فرمانی مانند فرمان‌های نشان‌داده‌شده در زیر کپی کنید. برای مثال، برای کپی کردن apigee-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 از 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 نسخه نصب‌شده 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 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→

ایجاد گزارش

Edge برای نسخه‌های 4.52.01.01 و جدیدتر Private Cloud

ابزار 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/

Edge برای نسخه‌های 4.50.00.11 تا 4.52.01.00 از Private Cloud

برای ایجاد گزارش بااستفاده از ابزار Sosreport، فرمان sosreport را با گزینه افزایه موردنیاز اجرا کنید (افزایه‌های Apigee را ببینید). مسیر پیش‌فرضی که گزارش در آن ذخیره می‌شود tmp یا /var/tmp است. می‌توانید با ارسال دایرکتوری دیگری به گزینه tmp-dir، دایرکتوری محل ذخیره گزارش را تغییر دهید. برای مثال، برای ایجاد گزارش در Management Server و ذخیره آن در دایرکتوری‌ای به‌نام 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 و همچنین مجموع وارسی نشان داده می‌شود. برای مثال:

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، و غیره (پیش‌فرض)
  • گزارش‌های «مدیریت کنونی» (پیش‌فرض)
  • ده خروجی متوالی top و jstacks (پیش‌فرض)
  • کل پوشه گزارش مدیریت (اختیاری)
  • config-files (اختیاری)

مثال‌ها:

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

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

مثال‌ها:

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

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

مثال‌ها:

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

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

Cassandra

افزونه 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/
  • تعداد گزارش‌های ثبت
  • برونداد فرمان Top
  • برون‌ریزی رشته
  • فایل‌های پیکربندی: cassandra-topology.properties، cassandra.yaml، cassandra-env.sh
  • خروجی Nodetool برای پارامترهای زیر: نسخه، وضعیت، حلقه، اطلاعات، gossipinfo، compactionstats -H،‏ tpstats،‏ netstats،‏ cfstats،‏ proxyhistograms

مثال:

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

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