diff options
| author | Jake Hunsaker <jhunsake@redhat.com> | 2023-02-27 12:36:39 -0500 |
|---|---|---|
| committer | Jake Hunsaker <jhunsake@redhat.com> | 2023-03-02 12:37:13 -0500 |
| commit | 9a460e920eef5cfb6d34c3f32d0f1c05740e45cd (patch) | |
| tree | faa427ae2c863cea323f046e8d25e6f6e335a3ea /man | |
| parent | ff5e73b29b1fcc4c5531654d4f67f808408aa989 (diff) | |
| download | sos-9a460e920eef5cfb6d34c3f32d0f1c05740e45cd.tar.gz | |
[report,plugin] Control journal size separate from log-size
Historically, journal sizes have been limited to the *higher* of 100MB
or `--log-size`. While this had the benefit of potentially controlling
both logs and journals with the same option, it was not immediately
intuitive to end users and downright prevented collecting less than
100MB of journals.
Address this by separating journal size limiting from `--log-size` by
adding a new `--journal-size` option (default 100). This will allow
users to individually control journal sizes without any "gotcha"
scenarios with relation to general log size limiting.
Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
Diffstat (limited to 'man')
| -rw-r--r-- | man/en/sos-report.1 | 14 |
1 files changed, 12 insertions, 2 deletions
diff --git a/man/en/sos-report.1 b/man/en/sos-report.1 index 5b2b1d58..4facd556 100644 --- a/man/en/sos-report.1 +++ b/man/en/sos-report.1 @@ -27,6 +27,7 @@ sos report \- Collect and package diagnostic and support data [--list-profiles]\fR [--verify]\fR [--log-size]\fR + [--journal-size]\fR [--all-logs]\fR [--since YYYYMMDD[HHMMSS]]\fR [--skip-commands commands]\fR @@ -185,14 +186,23 @@ Places a limit on the size of collected logs and output in MiB. Note that this causes sos to capture the last X amount of the file or command output collected. By default, this is set to 25 MiB and applies to all files and command output collected -with the exception of journal collections, which are limited to 100 MiB. +with the exception of journal collections, which are limited by the \fB--journal-size\fR +option instead. Setting this value to 0 removes all size limitations, and any files or commands collected will be collected in their entirety, which may drastically increase the size of the final sos report tarball and the memory usage of sos during collection -of commands, such as very large journals that may be several GiB in size. +of commands. .TP +.B \--journal-size +Places a limit on the size of journals collected in MiB. Note that this causes sos +to capture the last X amount of the journal. + +By default, this is set to 100 MiB. Setting this value to 0 removes all size limitations, +as does the use of the \fB--all-logs\fR option. This may drastically increase the size +of the final sos report tarball. +.TP .B \--all-logs Tell plugins to collect all possible log data ignoring any size limits and including logs in non-default locations. This option may significantly |