Explore adding logging to the Orchestrator

Use Case

Explore adding logging to the Orchestrator to be able to debug any possible customers' issues.

Use case: customer ran the deployment script and something failed, they could share the log file that contains all the needed information to debug the problem, for example the version of Orchestrator they've used, logs of deployment scripts they ran, configs they've passed, etc.

Scope of Work

• Investigate if logging could be added to the Orchestrator
• Determine what data should be logged.
  • Question: What data will help to investigate failures?
    • Suggestion: Orchestrator version, script logs, configuration variables.
    • What additional system data should be collected if something fails.

How fast do we need this

Logging probably should be added before the Orchestrator faces real customers to facilitate debugging issues.

Contextual Information

We need a way to debug customers' issues efficiently by looking into the logs they've provided. When users create issues, something could be omitted and so it could be hard to reproduce bugs. With enhanced logging this problem could be alleviated.

Risks

Ensure that no confidential data is being collected (passwords, credentials, etc.)

Acceptance Criteria

We have all the data set to help analyze possible script failures.