Investigate ScubaGear logging capability

[tkol2022]

💡 Summary

Based on recent changes to the AAD provider code the Get-PrivilegedUser was refactored and I added Write-Warning statements to display debug/trace messages to the console. I added these statements as a temporary method to track the detailed execution of the AAD provider which is impossible to do otherwise. I recommend that we add a permanent logging / trace capability to ScubaGear that would support:

• Displaying trace messages that would support testing. The developer / tester can view the detailed execution of the AAD functions, including the specific users and groups being processed by the code.
• Help the Scuba team troubleshoot bugs when users report that the tool is either crashing or not behaving as expected. For example, if the user reports that the tool is not detecting the expected users or groups configured in their environment, the Scuba team would have a method of examining the output from the tool to assist in analyzing the situation.

The scope of this issue is to perform a hands-on exploration of various technical solutions that could be added to ScubaGear to support the capability described above. This could be a logger, a new command line parameter, etc.

Acceptance criteria

How do we know when this work is done?

• Develop a list of potential options
• Try them out in the ScubaGear code
• Determine which ones seem to be the most feasible
• Present the findings to the team at the stand-up meeting
• Document the team's feedback and add final notes to the issue
• Create a new coding issue to implement the new capability