Skip to content

Commit

Permalink
vdk-core: create config option for logging execution result (#2850)
Browse files Browse the repository at this point in the history
## Why?

User reasearch indicates that the execution result is too verbose for
local runs. Users don't expect a lot of output for successful jobs and
expect error output for failing jobs.

## What?

Introduce the LOG_EXECUTION_RESULT config option that enables/disables
displaying the end result. Enabling and disabling the end result will be
implemented in a separate PR.

#2831

## How was this tested?

CI

## What kind of change is this?

Feature/non-breaking

Signed-off-by: Dilyan Marinov <mdilyan@vmware.com>
  • Loading branch information
DeltaMichael authored Oct 30, 2023
1 parent 2764a38 commit 0e04cc9
Showing 1 changed file with 8 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
LOG_LEVEL_VDK = "LOG_LEVEL_VDK"
LOG_LEVEL_MODULE = "LOG_LEVEL_MODULE"
LOG_STACK_TRACE_ON_EXIT = "LOG_STACK_TRACE_ON_EXIT"
LOG_EXECUTION_RESULT = "LOG_EXECUTION_RESULT"
LOG_EXCEPTION_FORMATTER = "LOG_EXCEPTION_FORMATTER"
WORKING_DIR = "WORKING_DIR"
ATTEMPT_ID = "ATTEMPT_ID"
Expand Down Expand Up @@ -95,6 +96,13 @@ def vdk_configure(self, config_builder: ConfigurationBuilder) -> None:
"Controls whether the full stack trace is displayed again on exit code 1. "
"False by default, shoud be set to true in production environments for more debug output. ",
)
config_builder.add(
LOG_EXECUTION_RESULT,
False,
True,
"Controls whether the job execution result is logged on job completion. "
"False by default, shoud be set to true in production environments for more debug output. ",
)
config_builder.add(
LOG_EXCEPTION_FORMATTER,
"pretty",
Expand Down

0 comments on commit 0e04cc9

Please sign in to comment.