sosコマンド・リファレンス

2 sosコマンド・リファレンス

この表は、sosコマンドに関する情報を示しています。

アクション	コマンド	説明
`sos`レポートを作成します。	`sos report`	システムおよびそのインストールされたアプリケーションからすべての診断および構成情報を収集します。
`sos`レポートから機密情報を非表示にします。	`sos clean`	Oracleサポートに提供される前に、既存のレポートの情報を難読化します。

sosユーティリティで使用できるオプションおよび引数のリストを取得するには、次のコマンドを実行します:

sos report -h

optional arguments:
  -h, --help            show this help message and exit
                
Global Options:
  --batch               Do not prompt interactively
  --config-file CONFIG_FILE
                        specify alternate configuration file
...

sosレポートの作成

システムおよびそのインストールされているアプリケーションからの診断および構成情報に基づいて、sosレポートを作成します。

システムおよびそれにインストールされたアプリケーションからすべての診断および構成情報を収集するには、次のコマンドを実行します。

sudo sos report

sosreport (sosreport version)
...
The generated archive may contain data considered sensitive and its
content should be reviewed by the originating organization before being
passed to any third party.
...
Press ENTER to continue, or CTRL-C to quit.

sosユーティリティを実行するたびに、このユーティリティによって、続行するか終了するかを確認するプロンプトが表示されます。[Enter]を押して続行すると、オプションのプロンプトを使用して、レポートのケースIDを指定できます。

Optionally, please enter the case id that you are generating this report for []:

特定のトラブルシューティング・ケースに関連するレポートを生成している場合は、このプロンプトでそのケースIDを入力できます。

プロンプトに従って情報を指定すると、このコマンドによってレポートの生成が続行されます。これは、完了までにかなり時間がかかる場合があります。このプロセスの最後に、画面に次のようなメッセージが表示されます。

Your sosreport has been generated and saved in:
        /var/tmp/sosreport-hostname-case#-datestamp-ID.tar.xz

 Size   20.62MiB
 Owner  root
 sha256 428f7b4118acd2d349bb022946877d853aa0eefbb4d340af3839810dc634b8b7

Please send this file to your support representative.

このレポートは、/var/tmpディレクトリ内に、xa圧縮されたtarファイルとして生成されます。このレポートのファイル名では、IDがユーティリティによって動的に作成されます。

重要:

前述のとおり、このレポートは、ご使用のシステムで発生した問題の診断およびトラブルシューティングをOracleサポートに依頼する場合に役立ちます。ただし、このレポートには、お客様の会社固有の機密情報が含まれています。このレポートを第三者に送信する前に、必ずレポートの内容を確認し、機密情報を特定してください。

sosレポート内の機密情報の非表示化

sosレポートの情報を難読化してから、Oracleサポートに情報を提供します。

このレポートを外部に送信する前に機密情報を保護するには、sosユーティリティのclean機能を使用します。この機能では、このレポート内の機密とみなされる情報が難読化されます。たとえば、次のような情報です。

IPv4アドレスとネットワーク(ネットワーク・トポロジは維持されます)
MACアドレス
ホスト名
ユーザー名
--keywordオプションで指定する任意の単語またはフレーズ

生成されたレポートに対してsos cleanユーティリティを使用するには、次のコマンドを入力し、表示されるプロンプトに従います:

sudo sos clean /var/tmp/sosreport-hostname-case#-datestamp-ID.tar.xz

...
Users should review any resulting data and/or archives generated or processed by
this utility for remaining sensitive content before being passed to a third
party.

Press ENTER to continue, or CTRL-C to quit.

このプロセスの最後に、画面に次のようなメッセージが表示されます。

Successfully obfuscated 1 report(s)

A mapping of obfuscated elements is available at
	/var/tmp/sosreport-host0-2022-08-08-qxbegcn-private_map

The obfuscated archive is available at
	/var/tmp/sosreport-host0-2022-08-08-qxbegcn-obfuscated.tar.xz

	Size	3.62MiB
	Owner	root

Please send the obfuscated archive to your support representative and keep the mapping file private

機密情報が除去された後のレポートも/var/tmpに格納されます。ただし、そのファイル名自体は修正されています。ホスト名は共通です。重要なのは、ファイル名にobfuscatedが追加されているということで、これによりレポートのクリーン・バージョンを特定できます。

注意:

sos cleanユーティリティについては、次の点を考慮に入れておいてください。

clean機能は、機密情報を特定してからマスクするための最善の努力としての方法です。ただし、sos cleanでは、特定のシステムにおけるそのマスキング処理の対象範囲にすべての対象が含まれているとはかぎりません。
sos cleanコマンドで処理されたレポートでは、サポート担当者などの第三者が問題のトラブルシューティングの際により適切な支援を提供するために必要となる場合がある特定の詳細情報を難読化します。
sosユーティリティによって生成されたアーカイブおよびレポートは、外部に送信する前に必ず監査する必要があります。

作成したsosレポートを自動的にクリーンにするには、レポートを生成するときに次のコマンド構文を使用します。

sudo sos report --clean

詳細は、マニュアル・ページのsos-report(1)とsos clean(1)を参照してください。https://github.com/sosreport/sos/wikiも参照してください。

sosコマンドのその他のサンプル使用例

追加のsosコマンド・オプションを使用して、sosレポートの出力をカスタマイズします。

sos reportコマンドは、その他のオプションを指定して使用することもできます。たとえば、使用可能なプラグインおよびプラグイン・オプションのみをレポートでリストするには、次のように入力します。

sudo sos report -l

このコマンドによって表示されるプラグインは、次のセクションに準じてグループ化されます。

有効になっているすべてのプラグイン
無効になっているすべてのプラグイン
すべてのプラグインに使用可能なオプション
使用可能プラグインのオプション

プラグインを有効化または無効化する方法と、プラグイン・オプションの値を設定する方法の詳細は、sos-report(1)マニュアル・ページを参照してください。

また、問題領域固有の情報のみを取得することや、生成されるレポートを調整するオプションを指定することもできます。たとえば、ApacheとTomcatに関する情報のみを記録し、すべてのApacheログを収集するには、次のようにします。

sudo sos report -o apache,tomcat -k apache.log=on

ロードされたすべてのプラグイン(rpm.rpmvaプラグインを除く)のすべてのブール型オプションを有効にして、すべてのパッケージを確認するには、次のようにします。

sudo sos report -a -k rpm.rpmva=off

詳細は、マニュアル・ページのsos-report(1)とsos clean(1)を参照してください。https://github.com/sosreport/sos/wikiも参照してください。