Sosreport ツール

<ph type="x-smartling-placeholder"></ph> 現在、Apigee Edge のドキュメントが表示されています。
Apigee X のドキュメント。 詳細

Sosreport は、オープンソース ベースのシステムレベルの診断およびデータ収集ツールです。 ソフトウェア SoS。 Sosreport ツールを使用して、問題のデバッグに役立つ情報を収集できます クラスタ内のノードで、 コンポーネントが実行されます。このツールは、情報を収集し、ノードのファイル システムにローカルに保存します。

Sosreport ツールは、構成の詳細、システム情報、 診断情報 システムから取り出し、データをアーカイブに保存します。 Apigee コンポーネントの場合、Sosreport は以下の情報を収集します。

  • 実行中のカーネル バージョン
  • 読み込まれたモジュール
  • システム構成ファイルとサービス構成ファイル

Sosreport は、さらに情報を収集するために外部プログラムも実行します 次の情報が含まれます。

  • すべてのコンポーネントの Apigee ログ。
  • ランタイム診断
  • nodetool コマンドを使用して収集された Cassandra の診断。

Sosreport ツールには、次の 2 つの主要コマンドが含まれています。

  • 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 オプションに追加します。たとえば、ある期間で 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
  • 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 プラグインは、 Management Server:

  • サーバーのホスト名（デフォルト）
  • cpuinfo（デフォルト）
  • meminfo（デフォルト）
  • Java 仮想マシン（JVM）の設定（メモリ、 Djdk.tls.allowUnsafeServerCertChange など（デフォルト）
  • 現在の管理ログ（デフォルト）
  • 10 個の連続したトップと jstack の出力（デフォルト）
  • 管理ログフォルダ全体（省略可）
  • 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

Message Processor

apigee-mp プラグインは、 管理プロセッサ（MP）：

  • サーバーのホスト名（デフォルト）
  • cpuinfo（デフォルト）
  • meminfo（デフォルト）
  • buildinfo/release info（デフォルト）
  • apigee-all のステータス（デフォルト）
  • サーバーの詳細（デフォルト）
  • JVM レベルの設定（メモリ、Djdk.tls.allowUnsafeServerCertChange など） その他（デフォルト）
  • 現在の MP ログ（デフォルト）
  • 10 個の連続した上部、jstack、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

1 つのコマンドで複数のオプションを指定できます。例:

  • 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 プラグインは、 Router:

  • サーバーのホスト名（デフォルト）
  • cpuinfo（デフォルト）
  • meminfo（デフォルト）
  • buildinfo/release info（デフォルト）
  • apigee-all のステータス（デフォルト）
  • サーバーの詳細（デフォルト）
  • あります。これにより、JVM レベルの設定が可能になります。たとえば、 Djdk.tls.allowUnsafeServerCertChange など（デフォルト）
  • 現在のルーターのログ（デフォルト）
  • 不正なファイル名を含む vhost ファイル名のリスト（デフォルト）
  • Router ログフォルダ全体（省略可）
  • 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-all バージョン &&apigee-all のステータス
  • apigee-cassandra のログ: /opt/apigee/var/log/apigee-cassandra/ の下にあるすべてのファイル
  • commit ログ数
  • コマンドの出力（上）
  • スレッドダンプ
  • 構成ファイル: cassandra-topology.properties、cassandra.yaml、 cassandra-env.sh
  • Nodetool 次のパラメータの出力: version、status、ring、info、gossipinfo、 Composionstats -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