Add SOS_JOURNAL_SIZE parameter to limit journal collection size

Introduces a new SOS_JOURNAL_SIZE environment variable that allows users to limit
the size of collected journals in MiB for EDPM SOS reports. This helps control
storage usage when gathering large amounts of journal data from EDPM nodes.

Co-Authored-By: Claude <[email protected]>
Signed-off-by: Francesco Pantano <[email protected]>

Author: fmount

README.md

@@ -58,6 +58,8 @@ This is the list of available environmental variables:
 - `SOS_EDPM_PROFILES`: List of sos report profiles to use. Empty string to run
   them all. Defaults to: `container,openstack_edpm,system,storage,virt`
 - `SOS_EDPM_PLUGINS`: List of sos report plugins to use. This is optional.
+- `SOS_EDPM_JOURNAL_SIZE`: Limit the size of collected journals in MiB. Must be
+  a positive integer. If not set or invalid, journal size limiting is ignored.
 - `OPENSTACK_DATABASES`: comma separated list of OpenStack databases that should
   be dumped. It is possible to set it to `ALL` and dump all databases. By default
   this env var is unset, hence the database dump is skipped.

collection-scripts/gather_edpm_sos

@@ -12,7 +12,9 @@
 #                     plugins in the list are run.
 #   SOS_DECOMPRESS: bool to disable decompressing sos reports. Set to 0 to disable
 #                   or set to 1 to enable. Defaults to 1
-#
+#  SOS_EDPM_JOURNAL_SIZE: Limit the size of collected journals in MiB. Must be
+#                         a positive integer. If not set or invalid, journal
+#                         size limiting is ignored.
 
 # When called from the shell directly
 if [[ -z "$DIR_NAME" ]]; then
@@ -32,6 +34,15 @@ else
     IFS=',' read -r -a SOS_EDPM <<< "$SOS_EDPM"
 fi
 
+# --journal-size: Limit the size of collected journals in MiB
+if [[ -z "$SOS_EDPM_JOURNAL_SIZE" || ! "$SOS_EDPM_JOURNAL_SIZE" =~ ^[0-9]+$ ]]; then
+    echo "Journal size limit not set or invalid: ignoring"
+    SOS_JOURNAL=""
+else
+    echo "Setting journal size limit to ${SOS_EDPM_JOURNAL_SIZE} MiB"
+    SOS_JOURNAL="--journal-size $SOS_EDPM_JOURNAL_SIZE"
+fi
+
 # Default to some profiles if SOS_EDPM_PROFILES is not set
 SOS_EDPM_PROFILES="${SOS_EDPM_PROFILES-container,openstack_edpm,system,storage,virt}"
 if [[ -n "$SOS_EDPM_PROFILES" ]]; then
@@ -67,7 +78,7 @@ gather_edpm_sos () {
         done
     fi
 
-    SSH sudo "bash -c \"rm -rf $TMPDIR && mkdir $TMPDIR && sos report --batch --all-logs --tmp-dir=$TMPDIR $SOS_LIMIT\""
+    SSH sudo "bash -c \"rm -rf $TMPDIR && mkdir $TMPDIR && sos report --batch --all-logs --tmp-dir=$TMPDIR $SOS_JOURNAL $SOS_LIMIT\""
     # shellcheck disable=SC2181
     if [ $? -ne 0 ]; then
         echo "Failed to run sos report on ${node}, won't retrieve data"