Sosreport 工具

查看 Apigee Edge 說明文件。
前往 Apigee X說明文件。 資訊

Sosreport 是以開放原始碼為基礎的 軟體 SoS。 你可以使用 Sosreport 工具收集資訊，以便偵錯 會在節點中 執行。此工具會收集資訊並儲存在節點的檔案系統本機上。

Sosreport 工具會收集設定詳細資料、系統資訊和 診斷資訊 並將資料儲存在封存中。 針對 Apigee 元件，Sosreport 會收集下列項目：

  • 執行中的核心版本
  • 載入的模組
  • 系統和服務設定檔

Sosreport 也會執行外部程式，進一步收集相關資訊 資訊，包括：

  • Apigee 記錄，包含所有元件。
  • 執行階段診斷
  • 使用 nodetool 指令收集的 Cassandra 診斷資料。

Sosreport 工具包含兩個主要指令：

  • sosreport：收集資料和建立報表的主要指令。
  • apigee-sosreport：用來安裝的輔助工具 sosreport並管理 Apigee 元件專用的 sosreport 外掛程式。

安裝

本節說明如何安裝 sosreport。

如果已安裝 sosreport 的 SoS 版本

如果原始檔案 sosreport 的 SoS 版本 是已安裝在系統上 「不」設定 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 支援團隊聯絡。

正在安裝 Apigee 版本的「sosreport」

如果 sosreport 的 SoS 版本： 安裝在系統上 也可以安裝 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 的目錄， 請輸入下列其中一個值：

  • 使用 Apigee 的 sosreport 版本： 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf -o apigee-mgmt  --batch --tmp-dir=my_report-dir
  • 使用 Sosreport 的 SoS 版本： 
    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 外掛程式

以下各節將說明 Sosreport 工具的 Apigee 外掛程式 下列元件：

管理伺服器

apigee-mgmt 外掛程式會從 管理伺服器：

  • 伺服器主機名稱 (預設)
  • cpuinfo (預設)
  • meminfo (預設)
  • Java 虛擬機器 (JVM) 設定，例如記憶體 Djdk.tls.allowUnsafeServerCertChange，依此類推 (預設)
  • 目前管理記錄 (預設)
  • 10 個依序排列的頂端和 jstacks 輸出內容 (預設)
  • 整個管理記錄資料夾 (選用)
  • config-files (選用)

範例：

如要收集所有預設項目，請輸入下列其中一個值：

  • 使用 Apigee 的 sosreport 版本： 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mgmt --batch my_report-dir
  • 使用 sosreport 的 SoS 版本： 
    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
  • 使用 sosreport 的 SoS 版本： 
    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
  • 使用 sosreport 的 SoS 版本： 
    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/版本資訊 (預設)
  • apigee-all 狀態 (預設)
  • 伺服器詳細資料 (預設)
  • JVM 層級設定，例如記憶體、Djdk.tls.allowUnsafeServerCertChange 等 (預設)
  • 目前的 MP 記錄 (預設)
  • 10 個依序排列的頂端、jstacks 和 NIO 指標輸出 (預設)
  • 整個 MP 記錄資料夾 (選用)
  • 分類樹狀結構 (選用)
  • 記憶體快照資料 (選用)
  • config-files (選用)
  • 執行階段追蹤 (選用，且僅限 org:env:api:rev detail )。注意：外掛程式會等待 25 秒收集執行階段要求。

範例：

如要收集所有預設項目，請輸入下列其中一個值：

  • 使用 Apigee 的 sosreport 版本： 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-mp --batch
  • 使用 sosreport 的 SoS 版本： 
    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
  • 使用 sosreport 的 SoS 版本： 
    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
  • 使用 sosreport 的 SoS 版本： 
    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
  • 使用 sosreport 的 SoS 版本： 
    sudo sosreport -o apigee-mp --batch -a

路由器

apigee-rrt 外掛程式會從 路由器：

  • 伺服器主機名稱 (預設)
  • cpuinfo (預設)
  • meminfo (預設)
  • buildinfo/版本資訊 (預設)
  • 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
  • 使用 sosreport 的 SoS 版本： 
    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
  • 使用 sosreport 的 SoS 版本： 
    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
  • 使用 sosreport 的 SoS 版本： 
    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 所有版本 &Apigee-all 狀態
  • apigee-cassandra 記錄檔： 「/opt/apigee/var/log/apigee-cassandra/」中的所有檔案
  • 修訂記錄檔數量
  • 指令頂端的輸出內容
  • 執行緒傾印
  • 設定檔：cassandra-topology.properties、cassandra.yaml、 cassandra-env.sh
  • Nodetool 輸出參數，參數為 version、status、ring、info、gossipinfo compactionstats -H、tpstats、netstats、cfstats、proxyhistograms

範例：

如要收集所有預設項目，請輸入下列其中一個值：

  • 使用 Apigee 的 sosreport 版本： 
    sudo sosreport --config-file /opt/apigee/apigee-sosreport/conf/sos.conf  -o apigee-cassandra
  • 使用 sosreport 的 SoS 版本： 
    sudo sosreport -o apigee-cassandra