Oracle Cloud Infrastructureドキュメント

sosを使用したデバッグ情報の収集

sosコマンドは、ハードウェア構成、ソフトウェア構成、動作状態などのシステムに関する情報を収集します。sos reportコマンドを使用して、現在のシステム上の診断および分析機能を有効にすることもできます。

  • システム構成ファイル
  • ハードウェア情報
  • プロセスとサービスの実行
  • カーネル詳細
  • ログ・ファイル
  • 特定のシステムコマンドからの出力

生成されたレポートは、システム内の問題のトラブルシューティングにおいてOracleサポートの支援を受けている場合に役立ちます。サポート担当者は、このレポートにより、システム、そのリソース、そのシステムに存在するすべてのアプリケーションとプロセス、および発生した問題の原因を検出するために役立つその他すべてのデータを正確に把握できます。

sosユーティリティを使用するには、sosパッケージをインストールする必要があります。Oracle Linuxプラットフォーム・イメージでは、sosユーティリティがデフォルトでインストールされます。

別のLinuxイメージを使用している場合は、sosユーティリティがインストールされているかどうかを確認します。

  1. sosユーティリティがインストールされているかどうかを確認します。
    rpm -q sos

    sosユーティリティがインストールされている場合、コマンドはインストールされているバージョンを返します。

    sos-4.7.2-2.0.2.el8_10.noarch
  2. sosユーティリティがない場合は、次を実行してパッケージをインストールします。
    sudo dnf install sos

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

この表では、sosコマンドについて説明します。

アクション コマンド 説明
sosレポートを作成します。 sos report

システムおよびそのインストールされたアプリケーションからすべての診断および構成情報を収集する。
sosレポートから機密情報を非表示にします。 sos clean

Oracle Supportに提供される前に、既存のレポートの情報を不明瞭化します。

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
...
ノート

詳細は、man sosと入力するか、sosのユーザー・ドキュメントを参照してください。

sosレポートの作成

システムおよびそのインストール済アプリケーションから診断および構成情報を収集するには、rootとしてsos reportコマンドを実行してレポートを生成します。特定のトラブルシューティング・ケースに関連するレポートを生成する場合は、[Enter]を押して続行し、ケースIDを入力します。

sudo sos report

sos report (version 4.8.1)

This command will collect diagnostic and configuration information from
this Oracle Linux system and installed applications.

An archive containing the collected information will be generated in
/var/tmp/sos.s4zah5s1 and may be provided to a Oracle America support
representative.

Any information provided to Oracle America will be treated in accordance
with the published support policies at:

        Distribution Website : https://support.oracle.com/
        Commercial Support   : https://support.oracle.com/

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.
No changes will be made to system configuration.
Press ENTER to continue, or CTRL-C to quit.
Optionally, please enter the case id that you are generating this report for []:

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

重要

Oracle Supportと連携してシステムで確認した問題の診断およびトラブルシューティングを行う場合は、レポートに会社固有の機密情報が含まれていることに注意してください。このレポートを第三者に送信する前に、必ずレポートの内容を確認し、機密情報を特定してください。「sosレポート内の機密情報の非表示化」を参照してください。

インストールされているパッケージおよびシステムの負荷によっては、レポートの完了に時間がかかる場合があります。

  • システムに多数のパッケージがインストールされている場合は、次のコマンドを使用してrpmデータベース検証を無効にします。
    sos report -k rpm.rpmva=off
  • システムが負荷が高い場合は、次のコマンドを使用して kernel.sysrqオプションを無効にします。
    sos report -k kernel.sysrq=off

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

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.
...
Running plugins. Please wait ...
  Finishing plugins              [Running: unpackaged]
  Finished running plugins
Creating compressed archive...
Your sosreport has been generated and saved in:
        /var/tmp/sosreport-<user_name>-<os>-<date>.tar.xz

 Size   15.72MiB
 Owner  root
 sha256 0fcfef63887d76ebd5b831be5d93d7953b0b9a431d81c9665459fbc8ce4a5f16

Please send this file to your support representative.

sosコマンドの追加使用方法

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

sos reportコマンドは、その他のオプションを指定して使用することもできます。たとえば、使用可能なプラグインおよびプラグイン・オプションのみをレポートでリストします。また、問題領域固有の情報のみを取得することや、生成されるレポートを調整するオプションを指定することもできます。

  • 使用可能なプラグインおよびプラグイン・オプションのみをレポートでリストするには:
    sudo sos report -l

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

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

    プラグインを有効化または無効化する方法と、プラグイン・オプションの値を設定する方法の詳細は、sosユーザー・ドキュメントを参照してください。

  • ApacheとTomcatに関する情報のみを記録し、すべてのApacheログを収集するには:
    sudo sos report -o apache,tomcat -k apache.log=on
  • ロードされたすべてのプラグイン(rpm.rpmvaプラグインを除く)のすべてのブール型オプションを有効にして、すべてのパッケージを確認するには:
    sudo sos report -a -k rpm.rpmva=off

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

Oracle Supportに情報を提供する前に、sosレポートの情報を不明瞭化します。

このレポートを外部に送信する前に機密情報を保護するには、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

詳細は、man sosと入力するか、sosのユーザー・ドキュメントを参照してください。

sosreport結果の確認

Oracle Linuxのデバッグ情報の収集を構成および確認します。

sosコマンドは、ハードウェア情報、システム構成ファイルおよびログ・データを収集するように自動的に構成されます。モジュールを有効または無効にして、データ保護要件を満たすことができます。

ノート

この表に示したモジュール情報は、sos 3.9に関連しています。インストールしてあるモジュールを確認するには、sos reportコマンドを実行します。この出力には、実行中のsosユーティリティのバージョンが含まれます。

モジュールを無効にすると、sosコマンドで、高度なトラブルシューティングに必要になる可能性がある特定の詳細項目(ネットワーク情報など)が収集されなくなります。

モジュール 情報型 組込みファイル
anaconda インストール・ログ・ファイル
  • /root/install.log
  • /root/install.log.syslog
  • /var/log/anaconda
  • /var/log/anaconda.*
auditd 監査ログ・ファイル
  • /etc/audit/auditd.conf
  • /etc/audit/audit.rules
  • /var/log/audit/*
boot システム・ブート・プロセスの詳細
  • /etc/milo.conf
  • /etc/silo.conf
  • /boot/efi/efi/redhat/elilo.conf
  • /etc/yaboot.conf
  • /boot/yaboot.conf
cron rootユーザーのcronコマンド
  • /etc/cron*
  • /etc/crontab
  • /var/log/cron
  • /var/spool/cron
cups プリンタのログ・ファイル
  • /etc/cups/*.conf
  • /etc/cups/*.types
  • /etc/cups/lpoptions
  • /etc/cups/ppd/*.ppd
  • /var/log/cups/*
date コンテキスト・データ
  • /etc/localtime
devicemapper ハードウェア詳細

filesys すべての使用中のファイルのリスト
  • /proc/fs/*
  • /proc/mounts
  • /proc/filesystems
  • /proc/self/mounts
  • /proc/self/mountinfo
  • /proc/self/mountstats
  • /proc/[0-9]*/mountinfo
  • /etc/mtab
  • /etc/fstab
grub2 カーネルとシステムの起動構成
  • /boot/efi/EFI/*/grub.cfg
  • /boot/grub2/grub.cfg
  • /boot/grub2/grubenv
  • /boot/grub/grub.cfg
  • /boot/loader/entries
  • /etc/default/grub
  • /etc/grub2.cfg
  • /etc/grub.d/*
hardware ハードウェア詳細
  • /proc/interrupts
  • /proc/irq
  • /proc/dma
  • /proc/devices
  • /proc/rtc
  • /var/log/mcelog
  • /sys/class/dmi/id/*
  • /sys/class/drm/*/edid
host ホストID
  • /etc/sos.conf
  • /etc/hostid
kernel システム・ログ・ファイル
  • /etc/conf.modules
  • /etc/modules.conf
  • /etc/modprobe.conf
  • /etc/modprobe.d
  • /etc/sysctl.conf
  • /etc/sysctl.d
  • /lib/modules/*/modules.dep
  • /lib/sysctl.d
  • /proc/cmdline
  • /proc/driver
  • /proc/kallsyms
  • /proc/lock*
  • /proc/buddyinfo
  • /proc/misc
  • /proc/modules
  • /proc/slabinfo
  • /proc/softirqs
  • /proc/sys/kernel/random/boot_id
  • /proc/sys/kernel/tainted
  • /proc/timer*
  • /proc/zoneinfo
  • /sys/firmware/acpi/*
  • /sys/kernel/debug/tracing/*
  • /sys/kernel/livepatch/*
  • /sys/module/*/parameters
  • /sys/module/*/initstate
  • /sys/module/*/refcnt
  • /sys/module/*/taint
  • /sys/module/*/version
  • /sys/devices/system/clocksource/*/available_clocksource
  • /sys/devices/system/clocksource/*/current_clocksource
  • /sys/fs/pstore
  • /var/log/dmesg
libraries 共有ライブラリのリスト
  • /etc/ld.so.conf
  • /etc/ld.so.conf.d/*
logs システム・ログ・ファイル
  • /etc/syslog.conf
  • /etc/rsyslog.conf
  • /etc/rsyslog.d
  • /run/log/journal/*
  • /var/log/auth.log
  • /var/log/auth.log.1
  • /var/log/auth.log.2*
  • /var/log/boot.log
  • /var/log/dist-upgrade
  • /var/log/installer
  • /var/log/journal/*
  • /var/log/kern.log
  • /var/log/kern.log.1
  • /var/log/kern.log.2*
  • /var/log/messages*
  • /var/log/secure*
  • /var/log/syslog
  • /var/log/syslog.1
  • /var/log/syslog.2*
  • /var/log/udev
  • /var/log/unattended-upgrades
lvm2 ハードウェア詳細

memory ハードウェア詳細
  • /proc/pci
  • /proc/meminfo
  • /proc/vmstat
  • /proc/swaps
  • /proc/slabinfo
  • /proc/pagetypeinfo
  • /proc/vmallocinfo
  • /sys/kernel/mm/ksm
  • /sys/kernel/mm/transparent_hugepage/enabled
networking ネットワークID
  • /etc/dnsmasq*
  • /etc/host*
  • /etc/inetd.conf
  • /etc/iproute2
  • /etc/network*
  • /etc/nftables
  • /etc/nftables.conf
  • /etc/nsswitch.conf
  • /etc/resolv.conf
  • /etc/sysconfig/nftables.conf
  • /etc/xinetd.conf
  • /etc/xinetd.d
  • /etc/yp.conf
  • /proc/net/*
  • /sys/class/net/*/device/numa_node
  • /sys/class/net/*/flags
  • /sys/class/net/*/statistics/*
pam サインイン・セキュリティ設定
  • /etc/pam.d/*
  • /etc/security
pci ハードウェア詳細
  • /proc/bus/pci
  • /proc/iomem
  • /proc/ioports
process すべての実行中のプロセスとプロセス詳細のリスト
  • /proc/sched_debug
  • /proc/stat
  • /proc/[0-9]*/smaps
processor ハードウェア詳細
  • /proc/cpuinfo
  • /sys/class/cpuid
  • /sys/devices/system/cpu
rpm インストールされているソフトウェア・パッケージ
  • /var/lib/rpm/*
  • /var/log/rpmpkgs
sar リソースおよび使用状況データ
  • /var/log/sa/*
selinux セキュリティ設定
  • /etc/sestatus.conf
  • /etc/selinux
  • /var/lib/selinux
services すべての定義済のシステム・サービス
  • /etc/inittab
  • /etc/rc.d/*
  • /etc/rc.local
ssh SSH構成
  • /etc/ssh/ssh_config
  • /etc/ssh/sshd_config
x11 X Window SystemのGUIログ
  • /etc/X11/*
  • /var/log/Xorg.*.log
  • /var/log/Xorg.*.log.old
  • /var/log/XFree86.*.log
  • /var/log/XFree86.*.log.old
yum インストールされているソフトウェア・パッケージ
  • /etc/pki/consumer/cert.pem
  • /etc/pki/entitlement/*.pem
  • /etc/pki/product/*.pem
  • /etc/yum/*
  • /etc/yum.repos.d/*
  • /etc/yum/pluginconf.d/*
  • /var/log/dnf.log