aboutsummaryrefslogtreecommitdiffstats
path: root/man/en
Commit message (Collapse)AuthorAgeFilesLines
* [Policy] Correct and clarify https upload internalsJake Hunsaker2021-05-141-0/+7
| | | | | | | | | | | | | | | | | | | | | | | | The python requests module does not provide actual support for streaming, that is provided by requests-toolchain. The support in requests is for easy multipart uploads. The internal methods and variables for https uploads within `Policy` however revolve around streaming enablement, but don't actually influence the use of streaming or not. This was due to placeholders during development just being carried forward rather than corrected before merge. This was largely forgotten about, until recent reports of upload issues for user-provided endpoints. This commit serves to correct the language around the currently supported https upload functionality. That is, we either use a 'put' or 'post' based on the loaded policy defaults. Further, allow users to control this setting with a new `--upload-method` option. This will allow users to specify upload urls that may require the opposite HTTP method than what the policy defaults dictate. Related: #2497 Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
* [man] Add missing log-size report option to collect manpageJake Hunsaker2021-04-301-0/+13
| | | | | | | | | The `collect` component supports `--log-size` as a passthru option for report. Add it to the `collect` manpage for completeness. Related: #2510 Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
* [man] Properly document size limits in manpageJake Hunsaker2021-04-301-3/+11
| | | | | | | | | | | Updates the description of `--log-size` in the manpage for `report` so that it accurately reflects how size limitations are determined and imposed during collections. Closes: #1900 Resolves: #2513 Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
* [logging] Fix archive debug logging, adjust verbosity levelsJake Hunsaker2021-04-281-0/+8
| | | | | | | | | | | | | | | | | Fixes an issue where archive debug logging was controlled by the use of `--debug` rather than `--verbose`. Removes a superfluous log in `FileCacheArchive.add_link()`. Also, adjusts the different verbosity levels to be more meaninful. Now, the use of `-v` will enable debug logging but will not print those messages to console, `-vv` will print debug logging to console, while `-vvv` will enable archive debug logging which is expected to be significant due to most file operations being logging at some point with archive debug logging. Resolves: #2507 Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
* [report] add --cmd-timeout optionPavel Moravec2021-04-051-1/+17
| | | | | | | | | | | | | | Add --cmd-timeout option to configure command timeout. Plugin-specific option of the same name (i.e. -k logs.cmd-timeout=60) can control the timeout per plugin. Option defaults and global/plugin-specific option preference follows the --plugin-timeout rules. Resolves: #2466 Signed-off-by: Pavel Moravec <pmoravec@redhat.com> Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
* [man] Multiple fixes in man pagesJose Castillo2021-03-043-8/+20
| | | | | | | | | | | This patch fixes references to sosreport, to the preferred 'sos report'. Also adds "SEE ALSO" consistently for all man pages, and fixes a MAINTAINER line. Resolves: #2432 Signed-off-by: Jose Castillo <jcastillo@redhat.com> Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
* Clarify default timeout for all pluginsJose Castillo2021-02-221-1/+2
| | | | | | | | | | | | | | | The default timeout for all plugins is 300, but the global timeout is set as -1 in the option list. This is because this timeout is unset by default. This patch attempts to clarify the -1 exposed to the user when using commands like 'sos report -l', via the option description as well as a note clarifying it in the man page. Closes: #2003 Resolves: #2415 Signed-off-by: Jose Castillo <jcastillo@redhat.com> Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
* [clean] Allow specifying keywords in a text fileJake Hunsaker2021-02-221-0/+6
| | | | | | | | | | | | | | | This commit adds the ability for users to provide a text file with a list of newline-delimited keywords that should be obfuscated, rather than requiring all keywords be specified either by the `--keywords` option or configuration file settings. Files may be provided via the new `--keyword-file` option which is available to `clean`, `collect`, and `report`. Closes: #2401 Resolves: #2408 Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
* [cleaner] Add 'cleaner' alias functionalityJose Castillo2021-02-091-2/+3
| | | | | | | | | | | The option 'cleaner' was not implemented as an alias. This patch enables it for both 'sos report' and 'sos collect'. Resolves: #2405 Signed-off-by: Jose Castillo <jcastillo@redhat.com> Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
* [sos] Align plugin options with destination namesJake Hunsaker2021-02-032-3/+3
| | | | | | | | | | | | | This commit alters several option long-form names or destination names to align those values in a sensible way. This serves to not only remove some abiguity in option naming in code, but also to make it so that the "effective options" line logged in every sos execution can be direction copy-pasted as a working command. Closes: #2288 Resolves: #2398 Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
* [report] clean up references to ticket-numberPavel Moravec2021-01-191-7/+1
| | | | | | | | | | | | | Cleaning up references of --ticket-number, as it was fully replaced by --case-id. The credit goes to @mamatha4 . Resolves: #2375 Relates to: #2374 Signed-off-by: Pavel Moravec <pmoravec@redhat.com> Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
* [report] Allow users to specify commands and files to skipJake Hunsaker2020-11-032-0/+28
| | | | | | | | | | | | | | | Adds two new options, `--skip-commands` and `--skip-files`, that allow users to selectively skip specific command or file collection instead of having to disable whole plugins to skip those collections. These options are also exposed via `sos collect`, being gated by a version of 4.1 since that is the next scheduled release where we can guarantee this functionality will be present. Closes: #2203 Resolves: #2271 Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
* [Policy] Allow upload username/password provided via environment varsJake Hunsaker2020-09-021-0/+11
| | | | | | | | | | | | | | | The username and password used by `Policy` when `--upload` is used may now be read via environment variables to avoid sensitive information from being included in `ps` output if they were provided via command-line options instead of the interactive prompts. Upload username may now be provided via the SOSUPLOADUSER variable. Upload password may now be provided via the SOSUPLOADPASSWORD variable. Resolves: #2216 Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
* [docs] Update man page for sos.conf after configuration redesignJake Hunsaker2020-07-212-2/+76
| | | | | | | | | | | | | Updates the manpage for further changes to the configuration design of sos. `man sos.conf` now includes information on non-root user overrides, as well as information regarding the subdirectories under `/etc/sos/` or `$HOME/.config/sos/`. The `sos_extras` plugin docstring has been copied into the man page as well for better coverage of how users are expected to use that plugin. The docstring remains in place in the actual plugin as well. Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
* [global] Update config file location and layoutJake Hunsaker2020-07-211-21/+23
| | | | | | | | | | | | | | | | | | | Moves the default config file we look for to /etc/sos/sos.conf instead of /etc/sos.conf. Extends the config file to look for a section matching the name of the component being used. Renames the "general" section to "global" and the "tunables" section to "plugin_options". Updates the default sos.conf to this style and adds some comments to the file. Update the man page for sos.conf. Note that this commit does NOT update sos.spec to drop the default configuration file in the new location, as that will be handled by a later commit to update the specfile wholesale. Closes: #2125 Resolves: #2136 Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
* [man] Fix typos in man pagesPonnuvel Palaniyappan2020-06-293-4/+4
| | | | | | | | | Fix several typos within the manpage Resolves: #2133 Signed-off-by: Ponnuvel Palaniyappan <ponnuvel.palaniyappan@canonical.com> Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
* [man] fix a typo in default_mapping filenamePavel Moravec2020-06-181-1/+1
| | | | Signed-off-by: Pavel Moravec <pmoravec@redhat.com>
* [cleaner] Add user-provided keyword obfuscationJake Hunsaker2020-06-171-0/+7
| | | | | | | | | Adds a new parser and map to allow user defined keyword obfuscation. Users may now use the `--keywords` option to have `SoSCleaner` scan lines for matching keywords, and replace them in place like we do for other parsers. Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
* [cleaner] Add hostname parserJake Hunsaker2020-06-171-0/+8
| | | | | | | | | | | | Adds a hostname parser to `sos clean` that will attempt to obfuscate FQDNs matching the hostname of the system that generated the sosreport, as found in sos_commands/host/hostname. Additionally, any domains added via the `--domains` option will also be obfuscated, including any subdomains of the domain(s) specified by the option. Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
* [docs] Add manpage for sos cleanJake Hunsaker2020-06-173-0/+115
| | | | | | | | | | | Adds a manpage for `sos clean`, with a link for `sos mask`. Updates `man sos` as well to include the options moved into the global group as part of the SoSCleaner patchset. Related: #1987 Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
* [man] update references to 'general' pluginPavel Moravec2020-05-191-2/+2
| | | | | | | | | | | 'general' plugin was replaced by 'host' plugin years ago. Let update an example in man pages accordingly. Resolves: #2072 Signed-off-by: Pavel Moravec <pmoravec@redhat.com> Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
* [collector] Passthru --threads, replace with --jobs for collectJake Hunsaker2020-04-221-6/+15
| | | | | | | | | | Replaces the previous `--threads` option in collect with a `--jobs` option to determine the number of concurrent collections to run. Uses `--threads` as a passthru option now if the node supports it (sos-3.6+), in an effort to unify option meanings between components. Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
* [options] Rename insecure-sudo to nopasswd-sudoJake Hunsaker2020-04-221-2/+2
| | | | Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
* [docs] Add general sos manpage, rename sosreport.1, add symlinksJake Hunsaker2020-04-224-334/+418
| | | | | | | | | | | | Adds a general manpage for the sos command that then points to the available components. Renames sosreport.1 to sos-report.1 to match the component style, and then symlinks sosreport.1 to it. Adds a symlink from sos-collector.1 to sos-collect.1. Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
* [docs] Add manpage for sos collectJake Hunsaker2020-04-221-0/+312
| | | | | | | | | | Adds the manpage from sos-collector to the tree as 'sos-collect', and updates the instances of 'sos-collector' to 'sos collect' within the manpage. Additionally updates the man page to include newly available options. Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
* [man] Update manpage for --upload and related optionsJake Hunsaker2020-02-141-0/+56
| | | | | | | Adds manage entries for the various --upload options added as part of the previous patches adding upload functionality. Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
* [Plugin] Allow selectively disabling postprocessingJake Hunsaker2020-01-281-0/+11
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Adds two mechanisms by which users can choose to disable postprocessing of collected information. First, is a global method exposed via the `--no-postproc` option. Using this option will skip postprocessing for all plugins. Second, is a per-plugin option exposed via a new 'postproc' plugin option. This is set to _True_ by default (meaning yes, perform postprocessing), which users can set to False or off to disable postprocessing for that plugin only; e.g. `-k podman.postproc=off` Closes: #286 Resolves: #1862 Signed-off-by: Jake Hunsaker <jhunsake@redhat.com> Signed-off-by: Pavel Moravec <pmoravec@redhat.com>
| * [Plugin] Allow selectively disabling postprocessingJake Hunsaker2019-11-191-0/+11
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Adds two mechanisms by which users can choose to disable postprocessing of collected information. First, is a global method exposed via the `--no-postproc` option. Using this option will skip postprocessing for all plugins. Second, is a per-plugin option exposed via a new 'postproc' plugin option. This is set to _True_ by default (meaning yes, perform postprocessing), which users can set to False or off to disable postprocessing for that plugin only; e.g. `-k podman.postproc=off` Closes: #286 Resolves: #1862 Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
* | [plugins] improve heuristic for applying --since to logarchivesPavel Moravec2019-12-111-2/+5
|/ | | | | | | | | | | | logarchive_pattern treats some configs (e.g. /etc/dbus-1) as log archives, causing --since option will skip collecting them. This patch just improves the heuristic by claiming nothing under /etc is a logarchive, and adds a warning to sosreport help. Improves: #1847 Signed-off-by: Pavel Moravec <pmoravec@redhat.com>
* [man] describe --allow-system-changes (#1850)Pavel Moravec2019-11-121-0/+4
| | | | | | | | | In #1435, --allow-system-changes option was added that is documented in sosreport --help but not in manpages. Resolves: #1850 Signed-off-by: Pavel Moravec <pmoravec@redhat.com> Signed-off-by: Bryan Quigley <bryan.quigley@canonical.com>
* [man] remove obolete references to XML reportsPavel Moravec2019-08-251-3/+3
| | | | | | | | | As XML reports were removed from sos, manpages should not refer to them further. Resolves: #1669 Signed-off-by: Pavel Moravec <pmoravec@redhat.com>
* [manpages] describe --note optionPavel Moravec2019-08-251-1/+3
| | | | | | Resolves: #1724 Signed-off-by: Pavel Moravec <pmoravec@redhat.com>
* [sosreport] grab logs since datePavel Moravec2019-08-251-0/+5
| | | | | | | | | | | | Adds a --since switch that takes a date as an argument. This switch will skip the archive files with a mtime older than the date. Also, --since affects journalctl execution for --all. Resolves: #1678 Signed-off-by: David Vallee Delisle <dvd@redhat.com> Signed-off-by: Pavel Moravec <pmoravec@redhat.com>
* [sosreport] update sos.conf manpages by [general] section descriptionPavel Moravec2019-04-301-4/+34
| | | | | | | | | Since PR #1530, sosreport supports all command line options. Man pages should document the enhancement. Resolves: #1652 Signed-off-by: Pavel Moravec <pmoravec@redhat.com>
* [man] add --dry-run to sosreport.1Bryn M. Reeves2019-03-221-3/+9
| | | | Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [manpages] Fix path for docs in /usr/share/docJose Castillo2019-03-191-1/+1
| | | | | | | | | | | | | | | | In the Makefile we have specified the path for sosreport docs as: install -m644 AUTHORS README.md $(DESTDIR)/usr/share/$(NAME)/. And NAME is 'sos'. But in the manpage we have the path as /usr/share/doc/sosreport. This fix removes the path and directs to the package documentation. Fixes: #1531 Resolves: #1532 Signed-off-by: Jose Castillo <jose.mfcastillo@gmail.com> Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [man] Update manpage for presetsJake Hunsaker2019-03-191-0/+33
| | | | | | | | | | | | | The manpage for sosreport was previously missing documentation for the new preset feature in 3.6. This updates the manpage to include entries for add-preset, del-preset, list-presets, and the --desc options. Resolves: #1479 Signed-off-by: Jake Hunsaker <jhunsake@redhat.com> Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [sosreport] Allow user-controllable plugin timeoutsJake Hunsaker2019-03-121-0/+13
| | | | | | | | | | | | | | | | | | | | Allows users to specify a timeout for each plugin using the '-k plugin.timeout=value' syntax by adding the 'timeout' option to every plugin. Additionally, adds the --plugin-timeout option to set a timeout for _all_ plugins. If --plugin-timeout and a specific -k timeout option is provided, the -k timeout option will be applied for those specific plugins, with --plugin-timeout being applied to all others. In either case, specifying a timeout of 0 seconds results in no timeout being applied. In the event that an invalid timeout is set, the timeout will be set to the default value for the plugin. Resolves: #1499 Signed-off-by: Jake Hunsaker <jhunsake@redhat.com> Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [sosreport] Add mechanism to encrypt final archiveJake Hunsaker2018-07-121-0/+28
| | | | | | | | | | | | | | | | | | | | | Adds an option to encrypt the resulting archive that sos generates. There are two methods for doing so: --encrypt-key Uses a key-pair for asymmetric encryption --encrypt-pass Uses a password for symmetric encryption For key-pair encryption, the key-to-be-used must be imported into the root user's keyring, as gpg does not allow for the use of keyfiles. If the encryption process fails, sos will not abort as the unencrypted archive will have already been created. The assumption being that the archive is still of use and/or the user has another means of encrypting it. Resolves: #1320 Signed-off-by: Jake Hunsaker <jhunsake@redhat.com> Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [sosreport] Concurrently run pluginsJake Hunsaker2018-06-061-0/+4
| | | | | | | | | | | | | | | | | | | | | Changes sos to run plugins concurrently. By default sos will now use four (4) threads to run plugins, allowing for faster overall execution of sosreport. The number of threads can be changed using the --threads commandline option. Plugins now also have a timeout applied to them as a whole to avoid situations where sosreport appears to be hung. If a plugin exceeds the timeout threshold, the plugin will be terminated immediately. - this allows sos to not only continue running normally, but should still allow for collection of commands run by the plugin up until it was terminated. The timeout is plugin controlled, and defaults to 300 seconds if not set. Note that for python2 environments, this adds a dependency on python-futures. The futures module is present in the standard library for python3 environments. Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
* [sosreport] Allow policies to change report name generationJake Hunsaker2018-04-171-2/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | | | This changes the way sos generates the name for the final archive. Policies may now control the naming pattern by changing the new 'name_pattern' attribute. By default, this is set to 'legacy' for all policies, and maintains the naming pattern that sos has used up until this point. A policy may also set name_pattern to 'friendly' which will result in a more user-friendly name for the archive. Additionally, a policy may set name_pattern to a format() parsable string to explicitly set how the tarball should be named. Additionally, this removes the prompt for a 'customer name' on the report when running interactively. Instead, the short hostname of the system is now always used in place of the 'customer name'. A new option, --label, has been added (and which --name will now map to) which if provided will append a user-given string to the archive name after the hostname. This also sets the Red Hat policy to use the new 'friendly' pattern. Closes: #469 Resolves: #1175 Signed-off-by: Jake Hunsaker <jhunsake@redhat.com> Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [man/sosreport] fix typo in chroot description (#1036)Adam Stokes2017-06-291-1/+1
| | | | | | | Fix small typo in the chroot section of the man page (alwyas -> always) Fixes #1035 Signed-off-by: Adam Stokes <battlemidget@users.noreply.github.com>
* [sosreport] clarify in man and help that --logsize is in MiBPavel Moravec2017-02-201-1/+1
| | | | | | | | | Neither sosreport --help or man pages specify the units of --logsize parameter. Let it clarify. Resolves: #916 Signed-off-by: Pavel Moravec <pmoravec@redhat.com>
* [docs] fix documentation of --sysroot parameterBryn M. Reeves2015-07-081-1/+1
| | | | Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [docs] add --chroot to sosreport.1Bryn M. Reeves2015-07-081-0/+8
| | | | Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [docs] add -s/--sysroot to sosreport.1Bryn M. Reeves2015-07-071-0/+5
| | | | Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [docs] add --experimental to sosreport.1Bryn M. Reeves2015-02-111-0/+5
| | | | Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [docs] update man page for new optionsBryn M. Reeves2014-12-171-4/+25
| | | | | | | | | | | | | The man page was missing: --verify --all-logs --log-size --plugin-option And listed the old '--ticket' (now --ticket-number). Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [docs] update references to report optionsBryn M. Reeves2014-09-171-3/+3
| | | | | | | | | The --report switch was changed to --no-report a while back. Update the docs to reflect the new option. Fixes #396. Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
* [sosreport] initial profiles supportBryn M. Reeves2014-09-161-6/+18
| | | | | | | | | | | | | | | | | | | Add simple profile support. Plugins can define a 'profiles' attribute that contains a list of profile names that this plugin belongs to. If a profile is given on the command line only plugins belonging to that profile will run. Two new command-line options are introduced in thie commit: --list-profiles --profile=NAME Profiles can be combined with -l/--list-plugins in order to see the effect of the profile on the set of enabled plugins. Fixes #247. Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
generated by cgit (git 2.34.1) at 2024-11-09 01:42:50 +0000