aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPavel Moravec <pmoravec@redhat.com>2022-01-05 10:33:58 +0100
committerJake Hunsaker <jhunsake@redhat.com>2022-01-05 10:46:23 -0500
commitc6a5bbb8d75aadd5c7f76d3f469929aba2cf8060 (patch)
treef2e7ea2d8268583cd0442c18c6b5d8a235f86ab7
parent18938b27197e1fa97a88b6768fbe8e3811c1daf9 (diff)
downloadsos-c6a5bbb8d75aadd5c7f76d3f469929aba2cf8060.tar.gz
[report] Provide better warning about estimate-mode
As --estimate-only calculates disk usage based on `stat` data that differs from outputs of other commands like `du`, enhance the warning about reliability of the calculated estimation. Also add a rule-of-thumb recommendation of real disk space requirements. Resolves: #2815 Signed-off-by: Pavel Moravec <pmoravec@redhat.com>
-rw-r--r--man/en/sos-report.110
-rw-r--r--sos/report/__init__.py3
2 files changed, 9 insertions, 4 deletions
diff --git a/man/en/sos-report.1 b/man/en/sos-report.1
index 464a77e5..e3477398 100644
--- a/man/en/sos-report.1
+++ b/man/en/sos-report.1
@@ -343,9 +343,13 @@ is available at the end.
Plugins will be collected sequentially, size of collected files and commands outputs
will be calculated and the plugin files will be immediatelly deleted prior execution
-of the next plugin. This still can consume whole free disk space, though. Please note,
-size estimations may not be accurate for highly utilized systems due to changes between
-an estimate and a real execution.
+of the next plugin. This still can consume whole free disk space, though.
+
+Please note, size estimations may not be accurate for highly utilized systems due to
+changes between an estimate and a real execution. Also some difference between
+estimation (using `stat` command) and other commands used (i.e. `du`).
+
+A rule of thumb is to reserve at least double the estimation.
.TP
.B \--upload
If specified, attempt to upload the resulting archive to a vendor defined location.
diff --git a/sos/report/__init__.py b/sos/report/__init__.py
index ef61fb34..e0617b45 100644
--- a/sos/report/__init__.py
+++ b/sos/report/__init__.py
@@ -1330,7 +1330,8 @@ class SoSReport(SoSComponent):
self.ui_log.info("Please note the estimation is relevant to the "
"current options.")
self.ui_log.info("Be aware that the real disk space requirements "
- "might be different.")
+ "might be different. A rule of thumb is to "
+ "reserve at least double the estimation.")
self.ui_log.info("")
# package up and compress the results