From 7b58b50c00b91c4a30496a58f5c80c896d415c8d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bal=C3=A1zs=20Sz=C3=BCcs?= <127139797+balazs-szucs@users.noreply.github.com> Date: Mon, 17 Nov 2025 13:01:29 +0100 Subject: [PATCH] feat(util): enhance logging behavior in ProcessExecutor (#4908) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit # Description of Changes TLDR: - Introduced `AtomicBoolean` to detect error messages dynamically - Changed logging to use `log.debug` for non-error lines and `log.info` for error-related lines during live updates - Improved error and output stream handling for better log verbosity and behaviour This pull request improves the logging behavior in the `ProcessExecutor` utility by making log output more informative and easier to follow, especially when errors occur. Now, lines containing "ERROR" (case-insensitive) and all subsequent lines are logged at the info level, while other lines are logged at the debug level. This helps to highlight errors during process execution without overwhelming the logs with less important information. **Logging improvements:** * Added an `AtomicBoolean` flag (`errorDetected`) to track when an error message appears in process output or error streams. * Modified both error and output stream handlers to: * Check if each line contains "ERROR" (case-insensitive) and set `errorDetected` if so. * Log lines at the info level if an error has been detected, otherwise log at the debug level. **Dependency update:** * Imported `AtomicBoolean` to support the new error tracking logic. --- ## Checklist ### General - [X] I have read the [Contribution Guidelines](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/CONTRIBUTING.md) - [X] I have read the [Stirling-PDF Developer Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/DeveloperGuide.md) (if applicable) - [ ] I have read the [How to add new languages to Stirling-PDF](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/HowToAddNewLanguage.md) (if applicable) - [X] I have performed a self-review of my own code - [X] My changes generate no new warnings ### Documentation - [ ] I have updated relevant docs on [Stirling-PDF's doc repo](https://github.com/Stirling-Tools/Stirling-Tools.github.io/blob/main/docs/) (if functionality has heavily changed) - [ ] I have read the section [Add New Translation Tags](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/HowToAddNewLanguage.md#add-new-translation-tags) (for new translation tags only) ### Translations (if applicable) - [ ] I ran [`scripts/counter_translation.py`](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/docs/counter_translation.md) ### UI Changes (if applicable) - [ ] Screenshots or videos demonstrating the UI changes are attached (e.g., as comments or direct attachments in the PR) ### Testing (if applicable) - [X] I have tested my changes locally. Refer to the [Testing Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/DeveloperGuide.md#6-testing) for more details. --------- Signed-off-by: Balázs Szücs --- .../software/common/util/ProcessExecutor.java | 25 +++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/app/common/src/main/java/stirling/software/common/util/ProcessExecutor.java b/app/common/src/main/java/stirling/software/common/util/ProcessExecutor.java index 9b260d9cf..d0cbbdc40 100644 --- a/app/common/src/main/java/stirling/software/common/util/ProcessExecutor.java +++ b/app/common/src/main/java/stirling/software/common/util/ProcessExecutor.java @@ -12,6 +12,7 @@ import java.util.Map; import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.Semaphore; import java.util.concurrent.TimeUnit; +import java.util.concurrent.atomic.AtomicBoolean; import io.github.pixee.security.BoundedLineReader; @@ -25,6 +26,7 @@ import stirling.software.common.model.ApplicationProperties; public class ProcessExecutor { private static final Map instances = new ConcurrentHashMap<>(); + private static final String ERROR_KEYWORD = "ERROR"; private static ApplicationProperties applicationProperties = new ApplicationProperties(); private final Semaphore semaphore; private final boolean liveUpdates; @@ -175,6 +177,7 @@ public class ProcessExecutor { String messages = ""; int exitCode = 1; semaphore.acquire(); + AtomicBoolean errorDetected = new AtomicBoolean(false); try { log.info("Running command: {}", String.join(" ", command)); @@ -204,7 +207,16 @@ public class ProcessExecutor { errorReader, 5_000_000)) != null) { errorLines.add(line); - if (liveUpdates) log.info(line); + if (liveUpdates) { + if (line.toUpperCase().contains(ERROR_KEYWORD)) { + errorDetected.set(true); + } + if (errorDetected.get()) { + log.info(line); + } else { + log.debug(line); + } + } } } catch (InterruptedIOException e) { log.warn("Error reader thread was interrupted due to timeout."); @@ -227,7 +239,16 @@ public class ProcessExecutor { outputReader, 5_000_000)) != null) { outputLines.add(line); - if (liveUpdates) log.info(line); + if (liveUpdates) { + if (line.toUpperCase().contains(ERROR_KEYWORD)) { + errorDetected.set(true); + } + if (errorDetected.get()) { + log.info(line); + } else { + log.debug(line); + } + } } } catch (InterruptedIOException e) { log.warn("Error reader thread was interrupted due to timeout.");