[FEATURE] Support user name as a logging parameter

[GingerGraham]

Problem / Use Case

Support passing of user as an argument.

For scripts where we may want to log the user who logged a specific action, especially in multi-user environments with long running or user launched actions.

Ideally would be exposed such that %u could be available defining logging format

Proposed Solution

TBC

Alternatives Considered

N/A

Additional Context

Taken from a partial modification of the original source gist that be found here: https://gist.github.com/meirlazar/b22271ddd2174291aaa17946e94b02f3/revisions

[GingerGraham]

• [FEATURE] Support passing caller name as an argument #28 which was merged under feat: add custom script name functionality and update documentation #33 introduced the 'set_script_name' function
  • An alternative to adding a further argument and custom string calling scripts can build a
    caller name however they like
  • As an example see demo_script_name.sh, e.g.

  # Demonstrate changing script name for different phases
  echo -e "\n========== Changing Script Name for Init Phase =========="
  set_script_name "my-application:init"
  
  log_info "Loading configuration..."
  log_info "Connecting to database..."
  log_info "Initialization complete"
  
  echo -e "\n========== Changing Script Name for Main Phase =========="
  set_script_name "my-application:main"
  
  log_info "Processing data..."
  log_info "Performing calculations..."
  log_info "Main processing complete"
  
  echo -e "\n========== Changing Script Name for Cleanup Phase =========="
  set_script_name "my-application:cleanup"
  
  log_info "Closing connections..."
  log_info "Releasing resources..."
  log_info "Cleanup complete"
  
  # Restore original name
  echo -e "\n========== Restoring Original Script Name =========="
  set_script_name "my-application"
  
  log_info "Application finished"

The calling script would be responsible for building the required "script name" including the user as necessary and then passing to set_script_name