1sos(1) General Commands Manual sos(1)
2
6 sos - A unified tool for collecting system logs and other debug infor‐
7 mation
8
10 sos component [options]
11
14 sos is a diagnostic data collection utility, used by system administra‐
15 tors, support representatives, and the like to assist in troubleshoot‐
16 ing issues with a system or group of systems.
17 The most well known function is sos report or sosreport as it was pre‐
19 viously known.
20 An sos archive is typically requested by support organizations to col‐
22 lect baseline configuration and system data from which to begin the
23 troubleshooting process.
24
28 sos supports several subcommands or components. Each provides a differ‐
29 ent set of information for the user. Supported components are as fol‐
30 lows
31 report Report generates an archive of system information including con‐
34 figuration files and command output. Information included in the
35 report is based upon plugins that are activated automatically
36 when certain criteria, such as installed packages, files, ser‐
37 vices, or system architecture is detected.
38 See sos report --help and man sos-report for more information.
40 May also be invoked via the alias rep or the deprecated command
42 sosreport.
43 collect
46 Collect is used to capture reports on multiple systems simulta‐
47 neously. These systems can either be defined by the user at the
48 command line and/or defined by clustering software that exists
49 either on the local system or on a "master" system that is able
50 to inform about other nodes in the cluster.
51 When running collect, sos report will be run on the remote
53 nodes, and then the resulting archives will be copied from those
54 nodes to the local system running sos collect. Archives are then
55 removed from the remote systems.
56 See sos collect --help and man sos-collect for more information.
58 May also be invoked via the alias sos collector or the depre‐
60 cated command sos-collector.
61 clean|mask
64 This subcommand takes input of either 1) an sosreport tarball,
65 2) a collection of sosreport tarballs such as from collect, or
66 3) the unpackaged directory of an sosreport and obfuscates
67 potentially sensitive system information that is not covered by
68 the standard postprocessing of sos report.
69 Such data includes IP addresses, networks, MAC addresses, and
71 more. Data obfuscated by this command will remain consistent
72 throughout the report and across reports provided in the same
73 invocation. Additionally, care is taken to maintain network
74 topology relationships between matched data items.
75 See sos clean --help and man sos-clean for more information.
77 May be invoked via either sos clean, sos mask, or via the
79 --clean or --mask options for report and collect.
80
83 sos components provide their own set of options, however the following
84 are available to be set across all components.
85 --batch Do not prompt interactively, user will not be prompted for any
87 data
88 --encrypt-key KEY
90 Encrypts the resulting archive that sosreport produces using
91 GPG. KEY must be an existing key in the user's keyring as GPG
92 does not allow for keyfiles. KEY can be any value accepted by
93 gpg's 'recipient' option.
94 Note that the user running sosreport must match the user owning
96 the keyring from which keys will be obtained. In particular this
97 means that if sudo is used to run sosreport, the keyring must
98 also be set up using sudo (or direct shell access to the
99 account).
100 Users should be aware that encrypting the final archive will
102 result in sos using double the amount of temporary disk space -
103 the encrypted archive must be written as a separate, rather than
104 replacement, file within the temp directory that sos writes the
105 archive to. However, since the encrypted archive will be the
106 same size as the original archive, there is no additional space
107 consumption once the temporary directory is removed at the end
108 of execution.
109 This means that only the encrypted archive is present on disk
111 after sos finishes running.
112 If encryption fails for any reason, the original unencrypted ar‐
114 chive is preserved instead.
115 --encrypt-pass PASS
117 The same as --encrypt-key, but use the provided PASS for symmet‐
118 ric encryption rather than key-pair encryption.
119 --config-file CONFIG
121 Specify alternate configuration file.
122 -s, --sysroot SYSROOT
124 Specify an alternate root file system path.
125 --tmp-dir DIRECTORY
127 Specify alternate temporary directory to copy data during execu‐
128 tion.
129 --threads THREADS
131 Specify the number of threads sosreport will use for concur‐
132 rency. Defaults to 4.
133 -v, --verbose
135 Increase logging verbosity. May be specified multiple times to
136 enable additional debugging messages.
137 -q, --quiet
139 Only log fatal errors to stderr.
140 -z, --compression-type {auto|xz|gzip}
142 Compression type to use when compression the final archive out‐
143 put
144 --help Display usage message.
146
148 Jake Hunsaker <jhunsake@redhat.com>
149
151 See AUTHORS file in the package documentation.
152 April 2020 sos(1)