1sos.conf(5) File Formats Manual sos.conf(5)
2
3
4
6 sos.conf - sosreport configuration
7
9 sosreport uses a configuration file at /etc/sos/sos.conf, and there are
10 subdirectories under /etc/sos that are used for specific purposes.
11
12 Note that non-root users may override options set in /etc/sos/sos.conf
13 by creating their own sos.conf under $HOME/.config/sos.
14
15 The order in which options are loaded is as follows:
16
17 1. System configuration file at /etc/sos/sos.conf
18 2. User-specific configuration file at $HOME/.config/sos/sos.conf
19 (for sos
20 components that support non-root)
21 3. In the case of running sos report, presets either automatically
22 loaded
23 due to system configuration, or specified via --preset
24 4. Command line values
25
26
27 In other words, config files will override defaults, presets override
28 config files, and command line values override presets and config
29 files.
30
31
33 The following subdirectories exist under /etc/sos and are used as noted
34 below
35
36
37 extras.d
38 This directory is used to store configuration files used by the
39 sos_extras plugin.
40
41 The plugin traverses this directory and for each file there it
42 executes commands or collects files optionally with sizelimit.
43
44 Expected content of an extras file is as follows:
45 - empty lines or those starting with '#' are ignored
46 - add_copy_spec called to lines starting by ':', optionally
47 followed by
48 sizelimit
49 - otherwise, whole line will be executed as a command.
50 Example:
51 command1 --arg1 val1
52 command2
53 :/path/to/file
54 :/path/to/files* sizelimit
55
56 WARNING: be careful what files to collect or what commands
57 to execute:
58 - avoid calling potentially dangerous or system altering
59 commands, like:
60 - using multiple commands on a line (via pipes, semicolon
61 etc.)
62 - executing commands on background
63 - setting env.variables (as those will be ignored)
64 - altering a system (not only by "rm -rf")
65 - be aware, no secret obfuscation is made
66
67 groups.d
68 This directory is used to store host group configuration files
69 for sos collect.
70
71 These files can specify any/all of the primary, nodes, and clus‐
72 ter-type options.
73
74 Users may create their own private host groups in $HOME/.con‐
75 fig/sos/groups.d/. If a host group of the same name is saved in
76 both the user's homedir and this directory, the homedir configu‐
77 ration file will have precedence. When run as non-root, sos col‐
78 lect will save host groups to the user's home dir, and create
79 the necessary directory structure if required.
80
81 Note that non-root users may load host groups defined under
82 /etc/sos/groups.d/, but they may not write new groups or update
83 existing groups saved there.
84
85
86 presets.d
87 This directory is used to store preset configuration files for
88 sos report.
89
90 Presets may be used to save standard sets of options. See man
91 sos-report for more information.
92
93
95 There are sections for each sos component, as well as global values and
96 those for plugin options. Options are set using 'ini'-style name =
97 value pairs. Disabling/enabling a boolean option is done the same way
98 like on command line (e.g. process.lsof=off).
99
100 Some options accept a comma separated list of values.
101
102 Using options that don't expect a value (like all-logs or no-report)
103 will result in enabling those options, regardless of value set.
104
105 Sections are parsed in the ordering:
106 - [global]
107 - [component]
108 - [plugin_options]
109
110
111 [global]
112 <option> Sets (long) option value. Short options (i.e.
113 z=auto)
114 are not supported.
115
116 [component]
117 Each component will have a separate section, and it will support
118 the options that particular component provides. These are read‐
119 ily identifiable in the --help output for each component, E.G.
120 sos report --help.
121
122 [plugin_options]
123 Alter available options for defined (and loaded) plugins.
124
125 Takes the form plugin.option = value, for example rpm.rpmva =
126 true.
127
129 To use quiet and batch mode with 10 threads:
130
131 [global]
132 batch=yes
133 build=true
134 threads=10
135
136 To disable the 'host' and 'filesys' plugins:
137
138 [report]
139 skip-plugins = host,filesys
140
141 To disable rpm package verification in the RPM plugin:
142
143 [plugin_options]
144 rpm.rpmva = off
145
147 /etc/sos/sos.conf
148 $HOME/.config/sos/sos.conf (optional)
149
151 sos-report(1) sos-collect(1) sos-clean(1)
152
153
154
155sosreport configuration file SOSREPORT sos.conf(5)