sos.conf(5)

✨ NAME ✨

okay bestie, this is the sos.conf(5) page from the File Formats Manual 🎀 and it's all about sos.conf, the sos report configuration file 💖

---

🌸 DESCRIPTION 🌸

okay so sos report reads a config file at /etc/sos/sos.conf 📁, and there are a few subdirectories under /etc/sos that each do their own specific job 🧚

ngl, non-root users get to override anything in /etc/sos/sos.conf by making their own sos.conf under $HOME/.config/sos 🫶

the order options get loaded in is:

1. the system config file at /etc/sos/sos.conf 🏠
2. the user-specific config file at $HOME/.config/sos/sos.conf (for sos components that support non-root 🙋‍♀️)
3. when you run sos report, presets, either auto-loaded because of the system config or picked with --preset 🎯
4. command line values 💅

so basically: config files beat the defaults, presets beat config files, and command line values beat literally everything 👑

---

🦋 SUBDIRECTORIES 🦋

these subdirectories live under /etc/sos, and each one has its own vibe 💜

🧩 extras.d

this one stores config files for the sos_extras plugin ✨

the plugin walks through this directory, and for each file in there it runs commands or collects files (optionally with a sizelimit) 📦

an extras file should look like this 👇:

• empty lines, or lines starting with #, get ignored 🙈
• lines starting with : call add_copy_spec, and you can optionally tack on a sizelimit after the path 📄
• anything else gets run as a command 🏃‍♀️

here's an example 🍓:

command1 --arg1 val1
command2
:/path/to/file
:/path/to/files* sizelimit

⚠️ WARNING ⚠️ be careful about what files you collect and what commands you run, bestie 😭 - avoid anything potentially dangerous or system altering, like: - chaining multiple commands on one line (with pipes, semicolons, etc.) - running commands in the background - setting env.variables (those get ignored anyway) - altering a system (and yes, that includes more than just rm -rf) - be aware that no secret obfuscation happens 🔓

👯 groups.d

this one stores host group config files for sos collect 🫂

these files can specify any or all of the primary, nodes, and cluster-type options 💜

users can make their own private host groups in $HOME/.config/sos/groups.d/ 🏡. if a host group has the same name in both your homedir and this directory, your homedir version wins 👑. when you run as non-root, sos collect saves host groups to your home dir, and it'll create the directory structure it needs if it's missing 🛠️

heads up: non-root users can load host groups defined under /etc/sos/groups.d/, but they can't write new groups or update existing ones saved there 🙅‍♀️

🎀 presets.d

this one stores preset config files for sos report 🎯

presets are how you save standard sets of options 💅. check out sos-report (see man sos-report) for more info 🧚

---

🌈 PARAMETERS 🌈

there are sections for each sos component, plus global values and plugin options 🧁. options are set as ini-style name = value pairs 📝. you turn a boolean option on or off the same way you would on the command line, like process.lsof=off 🔁

some options take a comma separated list of values 🍓

options that don't expect a value (like all-logs or no-report) get enabled no matter what value you set 🙃

sections get parsed in this order:

• [global] 🌍
• [component] 🧩
• [plugin_options] 🔌

🌍 [global]

• <option> — sets the (long) option value. short options (like z=auto) are not supported, so don't even try 🙅‍♀️

🧩 [component]

each component gets its own section, and it supports the options that particular component offers ✨. you can spot them easily in the --help output for each component, like sos report --help 👀

🔌 [plugin_options]

this lets you change available options for defined (and loaded) plugins 🔧

it takes the form plugin.option = value, for example rpm.rpmva = true 💜

---

🎀 EXAMPLES 🎀

okay here are some examples so you can see it in action 🫶

to use quiet and batch mode with 10 threads:

[global]
batch=yes
build=true
threads=10

to disable the host and filesys plugins:

[report]
skip-plugins = host,filesys

to disable rpm package verification in the RPM plugin:

[plugin_options]
rpm.rpmva = off

---

📁 FILES 📁

• /etc/sos/sos.conf 🏠
• $HOME/.config/sos/sos.conf (optional) 🙋‍♀️

---

👑 SEE ALSO 👑

• sos-report(1) 📋
• sos-collect(1) 🫂
• sos-clean(1) 🧽

---

okay that's the whole tea ☕ go configure something iconic, bestie 💅✨ sos configuration file · SOS · sos.conf(5) 🦋💖