Skip to content

Commit

Permalink
Merge pull request #229 from valtech/227-update-readme
Browse files Browse the repository at this point in the history
docs: Add documentation on logging running script details
  • Loading branch information
christinebaumann committed Apr 23, 2024
2 parents f1f20f6 + 44b8b14 commit 5fa7431
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -259,6 +260,17 @@ Once execution is done you will see if the script(s) succeeded. Click on the his

<img src="docs/images/run.png">

<a name="executionDetails"></a>

## 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.

<a name="history"></a>

# History of Past Runs
Expand Down

0 comments on commit 5fa7431

Please sign in to comment.