Công cụ Sosreport

Bạn đang xem tài liệu về Apigee Edge.
Truy cập vào tài liệu Apigee X. info

Sosreport là một công cụ thu thập dữ liệu và chẩn đoán ở cấp hệ thống, dựa trên phần mềm nguồn mở SoS. Bạn có thể sử dụng công cụ Sosreport để thu thập thông tin giúp bạn gỡ lỗi trong các nút nơi đang chạy một thành phần Apigee. Công cụ này thu thập và lưu trữ thông tin ngay trên hệ thống tệp của nút.

Công cụ Sosreport thu thập thông tin chi tiết về cấu hình, thông tin hệ thống và thông tin chẩn đoán từ hệ thống của bạn, đồng thời lưu trữ dữ liệu trong một tệp lưu trữ. Đối với các thành phần Apigee, Sosreport sẽ thu thập những thông tin sau:

  • Phiên bản kernel đang chạy
  • Mô-đun đã tải
  • Tệp cấu hình hệ thống và dịch vụ

Sosreport cũng chạy các chương trình bên ngoài để thu thập thêm thông tin, bao gồm:

  • Nhật ký Apigee từ tất cả các thành phần.
  • Thông tin chẩn đoán thời gian chạy
  • Thông tin chẩn đoán Cassandra được thu thập bằng các lệnh nodetool.

Công cụ Sosreport có 2 lệnh chính:

  • sosreport: Lệnh chính để thu thập dữ liệu và tạo báo cáo.
  • apigee-sosreport: Một công cụ phụ trợ dùng để cài đặt sosreport và quản lý các trình bổ trợ sosreport dành riêng cho các thành phần Apigee.

Cài đặt

Phần này giải thích cách cài đặt sosreport.

Nếu bạn đã cài đặt phiên bản SoS của sosreport

Nếu phiên bản SoS ban đầu của sosreport đã được cài đặt trên hệ thống của bạn, thì đừng thiết lập phiên bản của Apigee, vì các đường dẫn cài đặt có thể xung đột. Thay vào đó, hãy sao chép các trình bổ trợ dành riêng cho Apigee từ thư mục /opt/apigee/apigee-sosreport/source/plugin vào thư mục site-packages thích hợp của Python bằng một lệnh như các lệnh bên dưới. Ví dụ: để sao chép agigee-mgmt.py:

  • Nếu bạn đang dùng Python 2, hãy nhập: 
    sudo cp apigee-mgmt.py /usr/lib/python2.7/site-packages/sos/plugins/
  • Nếu bạn đang dùng Python 3, hãy nhập: 
    sudo cp apigee-mgmt.py /usr/local/lib/python3.6/site-packages/sos/plugins/

Để xác minh rằng bạn đã cài đặt các trình bổ trợ, hãy nhập

sudo sosreport --list-plugins

Nếu bạn có câu hỏi, hãy liên hệ với nhóm hỗ trợ Apigee.

Cài đặt phiên bản sosreport của Apigee

Nếu chưa cài đặt phiên bản SoS của sosreport trên hệ thống, bạn có thể cài đặt phiên bản của Apigee bằng cách nhập các lệnh sau trên tất cả các nút đã cài đặt Edge cho Đám mây riêng: 

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

Để kiểm tra xem sosreport đã được cài đặt hay chưa, hãy xác nhận rằng các trình bổ trợ liên quan đến Apigee nằm trong thư mục sau:

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

trong đó pythonx.x là phiên bản Python bạn đã cài đặt.

Hoặc bạn có thể chạy một trong các lệnh sau:

  • Chỉ xác minh các trình bổ trợ dành riêng cho Apigee: 
    apigee-service apigee-sosreport diagnose -l

    Thao tác này sẽ trả về danh sách sau đây gồm các trình bổ trợ dành riêng cho 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
  • Cách xác minh tất cả trình bổ trợ: 
    apigee-service apigee-sosreport diagnose -s -l

    Thao tác này sẽ trả về danh sách sau đây gồm các trình bổ trợ có trong 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→

Tạo báo cáo

Để tạo báo cáo bằng công cụ Sosreport, hãy chạy lệnh sosreport bằng lựa chọn trình bổ trợ bắt buộc (xem Trình bổ trợ Apigee). Thư mục mặc định nơi lưu trữ báo cáo là tmp hoặc /var/tmp. Bạn có thể thay đổi thư mục lưu trữ báo cáo bằng cách truyền một thư mục khác vào tuỳ chọn tmp-dir. Ví dụ: để tạo báo cáo trên Máy chủ quản lý và lưu báo cáo đó vào một thư mục có tên là my_report-dir, hãy nhập một trong các lệnh sau:

  • Sử dụng phiên bản sosreport của Apigee: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf -o apigee-mgmt  --batch --tmp-dir=my_report-dir
  • Sử dụng phiên bản SoS của sosreport: 
    sudo sosreport -o apigee-mgmt  --batch --tmp-dir=my_report-dir

Báo cáo được lưu trữ trong một tệp .tar.xz trong thư mục mà bạn chỉ định bằng cách sử dụng lựa chọn tmp-dir. Vị trí của tệp .tar.xz xuất hiện trên STDOUT, cũng như tổng kiểm tra. Ví dụ:

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

Báo cáo được lưu trữ trong một tệp .tar.xz trong thư mục mà bạn chỉ định bằng cách sử dụng lựa chọn tmp-dir. Vị trí của .tar.xz file được hiển thị trên STDOUT, cũng như tổng kiểm tra. Ví dụ:

Để biết thêm các lựa chọn có sẵn cho sosreport, hãy đọc tệp man:

sudo man sosreport

Trình bổ trợ Apigee

Các phần sau đây mô tả các trình bổ trợ Apigee cho công cụ Sosreport đối với các thành phần sau:

Máy chủ quản lý

Trình bổ trợ apigee-mgmt thu thập thông tin sau đây từ Máy chủ quản lý:

  • tên máy chủ (mặc định)
  • cpuinfo (mặc định)
  • meminfo (mặc định)
  • Các chế độ cài đặt máy ảo Java (JVM), chẳng hạn như bộ nhớ, Djdk.tls.allowUnsafeServerCertChange, v.v. (mặc định)
  • Nhật ký quản lý hiện tại (mặc định)
  • 10 đầu ra hàng đầu và jstacks tuần tự (mặc định)
  • Toàn bộ thư mục Nhật ký quản lý (không bắt buộc)
  • config-files (không bắt buộc)

Ví dụ:

Để thu thập tất cả các mục mặc định, hãy nhập một trong những mục sau:

  • Sử dụng phiên bản sosreport của Apigee: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mgmt --batch my_report-dir
  • Sử dụng phiên bản SoS của sosreport: 
    sudo sosreport -o apigee-mgmt --batch my_report-dir

Để thu thập tất cả các mục mặc định và(các) mục không bắt buộc được chỉ định trong lệnh, ví dụ: tệp cấu hình và tất cả nhật ký, hãy nhập một trong những lệnh sau:

  • Sử dụng phiên bản sosreport của 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
  • Sử dụng phiên bản SoS của sosreport: 
    sudo sosreport -o apigee-mgmt --batch -k apigee-mgmt.config-files -k apigee-mgmt.all-logs

Để thu thập mọi thứ, hãy nhập một trong những nội dung sau:

  • Sử dụng phiên bản sosreport của 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

    Ngoài ra, bạn có thể nhập:

    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mgmt --batch -a
  • Sử dụng phiên bản SoS của sosreport: 
    sudo sosreport -o apigee-mgmt --batch -k apigee-mgmt.config-files -k apigee-mgmt.all-logs

    Ngoài ra, bạn có thể nhập:

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

Trình xử lý thông báo

Trình bổ trợ apigee-mp thu thập thông tin sau đây từ Bộ xử lý quản lý (MP):

  • Tên máy chủ (mặc định)
  • cpuinfo (mặc định)
  • meminfo (mặc định)
  • buildinfo/release info (mặc định)
  • Trạng thái apigee-all (mặc định)
  • thông tin chi tiết về máy chủ (mặc định)
  • Các chế độ cài đặt ở cấp JVM, ví dụ: bộ nhớ, Djdk.tls.allowUnsafeServerCertChange, v.v. (mặc định)
  • Nhật ký MP hiện tại (mặc định)
  • 10 đầu ra liên tiếp về chỉ số hàng đầu, jstack và NIO (mặc định)
  • Toàn bộ thư mục nhật ký MP (không bắt buộc)
  • Cây phân loại (không bắt buộc)
  • Tệp báo lỗi (không bắt buộc)
  • config-files (không bắt buộc)
  • Dấu vết thời gian chạy (không bắt buộc và chỉ khi org:env:api:rev detail được cung cấp). Lưu ý: Trình bổ trợ sẽ đợi 25 giây để thu thập các yêu cầu trong thời gian chạy.

Ví dụ:

Để thu thập tất cả các mục mặc định, hãy nhập một trong những mục sau:

  • Sử dụng phiên bản sosreport của Apigee: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mp --batch
  • Sử dụng phiên bản SoS của sosreport: 
    sudo sosreport -o apigee-mp --batch

Ngoài tất cả các mục mặc định, bạn cũng có thể chỉ định các mục bổ sung không bắt buộc để thu thập. Ví dụ: để chỉ định kết xuất heap, hãy sử dụng cờ -k apigee-mp.heap và nhập một trong những nội dung sau:

  • Sử dụng phiên bản sosreport của Apigee: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mp --batch -k apigee-mp.heap
  • Sử dụng phiên bản SoS của sosreport: 
    sudo sosreport -o apigee-mp --batch -k apigee-mp.heap

Tương tự, bạn có thể chỉ định các mục không bắt buộc sau:

-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

Bạn có thể chỉ định nhiều lựa chọn trong một lệnh duy nhất. Ví dụ:

  • Sử dụng phiên bản sosreport của 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
  • Sử dụng phiên bản SoS của sosreport: 
    sudo sosreport -o apigee-mp --batch -k apigee-mp.deployments -k apigee-mp.all-logs

Để thu thập mọi thứ, ngoại trừ dấu vết, hãy nhập một trong những nội dung sau:

  • Sử dụng phiên bản sosreport của Apigee: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mp --batch -a
  • Sử dụng phiên bản SoS của sosreport: 
    sudo sosreport -o apigee-mp --batch -a

Bộ định tuyến

Trình bổ trợ apigee-rrt thu thập những thông tin sau đây từ Bộ định tuyến:

  • Tên máy chủ (mặc định)
  • cpuinfo (mặc định)
  • meminfo (mặc định)
  • buildinfo/release info (mặc định)
  • Trạng thái apigee-all (mặc định)
  • thông tin chi tiết về máy chủ (mặc định)
  • Đầu ra ps. Thao tác này sẽ cung cấp các chế độ cài đặt ở cấp JVM, ví dụ: bộ nhớ, Djdk.tls.allowUnsafeServerCertChange, v.v. (mặc định).
  • Nhật ký Bộ định tuyến hiện tại (mặc định)
  • Danh sách tên tệp vhost, bao gồm cả tên tệp không hợp lệ (mặc định)
  • Toàn bộ thư mục nhật ký của Bộ định tuyến (không bắt buộc)
  • config-files (không bắt buộc)

Ví dụ:

Để thu thập tất cả các mục mặc định, hãy nhập một trong những mục sau:

  • Sử dụng phiên bản sosreport của Apigee: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-rrt --batch
  • Sử dụng phiên bản SoS của sosreport: 
    sudo sosreport -o apigee-rrt --batch

Ngoài tất cả các mục mặc định, bạn cũng có thể chỉ định các mục bổ sung không bắt buộc để thu thập. Ví dụ: để chỉ định toàn bộ thư mục nhật ký, hãy sử dụng cờ -k apigee-rrt.all-logs và nhập một trong các nội dung sau:

  • Sử dụng phiên bản sosreport của Apigee: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-rrt --batch -k apigee-rrt.all-logs
  • Sử dụng phiên bản SoS của sosreport: 
    sudo sosreport -o apigee-rrt --batch -k apigee-rrt.all-logs

Tương tự, bạn có thể chỉ định các mục không bắt buộc sau:

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

Cách thu thập mọi thứ:

  • Sử dụng phiên bản sosreport của Apigee: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-rrt --batch -a
  • Sử dụng phiên bản SoS của sosreport: 
    sudo sosreport -o apigee-rrt --batch -a

Cassandra

Trình bổ trợ apigee-cassandra thu thập những thông tin sau từ các nút Cassandra:

  • Số liệu thống kê về máy: 
    "hostname -i"
"cat /proc/cpuinfo"
"cat /proc/meminfo"
"ulimit -a"
"ps auxw"
"df -kh"
"du -sh"
"netstat -ntlpu"
"free -h"
"ifconfig -h"
"ps -ef"
  • Trạng thái và phiên bản của thành phần Apigee phiên bản apigee-all && trạng thái apigee-all
  • Nhật ký apigee-cassandra: Tất cả các tệp trong /opt/apigee/var/log/apigee-cassandra/
  • Số lượng nhật ký cam kết
  • Đầu ra của lệnh Top
  • Kết xuất luồng
  • Tệp cấu hình: cassandra-topology.properties, cassandra.yaml, cassandra-env.sh
  • Đầu ra Nodetool cho các tham số sau: version, status, ring, info, gossipinfo, compactionstats -H, tpstats, netstats, cfstats, proxyhistograms

Ví dụ:

Để thu thập tất cả các mục mặc định, hãy nhập một trong những mục sau:

  • Sử dụng phiên bản sosreport của Apigee: 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-cassandra
  • Sử dụng phiên bản SoS của sosreport: 
    sudo sosreport -o apigee-cassandra