From 44b8b146ca689adb7bc85fa2cb7ee46ede3eb2f8 Mon Sep 17 00:00:00 2001 From: Christine Baumann Date: Mon, 22 Apr 2024 17:14:45 +0200 Subject: [PATCH] docs: Add documentation on logging running script details --- Readme.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/Readme.md b/Readme.md index 26729641..efd557c6 100644 --- a/Readme.md +++ b/Readme.md @@ -25,7 +25,8 @@ Table of contents 4. [Execution of Migration Scripts](#execution) 1. [Startup Hook](#startupHook) 2. [Install Hook](#installHook) - 2. [Manual Execution](#manualExecution) + 3. [Manual Execution](#manualExecution) + 4. [Execution Details](#executionDetails) 5. [History of Past Runs](#history) 6. [Extension to Groovy Console](#groovy) 1. [Content Upgrades](#content_upgrades) @@ -259,6 +260,17 @@ Once execution is done you will see if the script(s) succeeded. Click on the his + + +## Execution Details and Output +When executing, `de.valtech.aecu.core.service.AecuServiceImpl` will emit a log statement to inform script is currently being executed, and when execution is done, a second log statement including the result (success, failure, skipped if prechecks failed) is emitted. +To capture these logs, configure a logger on `de.valtech.aecu` with level `INFO` to append/emit logs as you desire. +These logs are helpful if you are executing scripts via hook. + +Additionally, as stated above, manual execution provides the UI to indicate which script is currently running. Please note however that if you leave the page while execution is in progress, you will not be able to go back to it to see the execution details again. + +In both cases, you can see more details on the execution in the history. See below for more information. + # History of Past Runs