[CI-2937] CLI command logging #955
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tothszabi
force-pushed
the
CI-2937-cli-command-logging
branch
3 times, most recently
from
8387743
to
d7ee4ce
Compare
ofalvai
reviewed
May 17, 2024
| @@ -113,6 +124,41 @@ func Run() { | |||
| } | |||
| } | |||
|
|
|||
| func commandExecutionInfo(args []string) (string, string, []string) { | |||
There was a problem hiding this comment.
Can we have some tests for this logic? 👀
I see that it correctly filters out flag values (which could be sensitive), but we should also enforce this to prevent a future regression
There was a problem hiding this comment.
Great tip. I have added tests for this part.
tothszabi
force-pushed
the
CI-2937-cli-command-logging
branch
from
d7ee4ce
to
0743e37
Compare
ofalvai
approved these changes
May 17, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Checklist
README.mdis updated with the changes (if needed)Version
Requires a MINOR version update
Context
We want to better understand how our users are using the CLI so we will be collecting what commands are executed and which flags are used.
Implementation
I have extended the existing logger with a new event.
At the moment the run command was initialising the tracker and it was the only user of it. This was not good because we need to log the command info much earlier. So I moved the tracker initialisation where the CLI execution starts. With this there was a new problem with how to share this tracker with the run command.
We are using the urfave cli package to parse and execute the tasks. This package has a
Context(not the same as the GoContextone) struct which will trickle down to the commands. But you can only add strings to it. So the simplest solution seemed to put the tracker into a global variable and inject that into the execution flow.