feat: track help cmd #245
Merged
feat: track help cmd #245
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
dbolson
commented
May 6, 2024
| func CmdRunEventProperties( | ||
| cmd *cobra.Command, | ||
| name string, | ||
| overrides map[string]interface{}, |
There was a problem hiding this comment.
Add overrides so we can pass in an optional "action: help". We could make this functional options if we want to use it for more than the one-off case this introduces.
| cmdAnalytics.CmdRunEventProperties(cmd, "config"), | ||
| ) | ||
| // only track event if there are flags | ||
| if len(os.Args[1:]) > 1 { |
There was a problem hiding this comment.
I'm not sure if there's a better way to do this. Since we define config --list/--set/--unset with no action, we only want to send this if we're not showing help.
| @@ -53,6 +56,19 @@ func NewConfigCmd(analyticsTracker analytics.Tracker) *cobra.Command { | |||
| sb.WriteString(fmt.Sprintf("- `%s`: %s\n", s, cliflags.AllFlagsHelp()[s])) | |||
| } | |||
| cmd.Long += sb.String() | |||
|
|
|||
| analyticsTracker.SendCommandRunEvent( | |||
There was a problem hiding this comment.
This is similar to what we do in the root command.
| // getResourceCommand returns the command for a resource or an action's parent resource. | ||
| // ldcli projects // returns projects command | ||
| // ldcli projects list // returns projects command | ||
| func getResourceCommand(c *cobra.Command) *cobra.Command { |
There was a problem hiding this comment.
We need this since a user could call help in various ways.
| ID string | ||
| HTTPClient *http.Client | ||
| Version string | ||
| sentHelpEvent bool |
There was a problem hiding this comment.
We need to keep state here to know if we already tracked a help event.
k3llymariee
approved these changes
May 7, 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.
Send analytics when showing help, either when the user asks (--help) or if it's an error and we show the help.
Here are example inputs with their respective analytics output:
These also send "CLI Command Completed" with an outcome of "help."
Requirements
Related issues
Provide links to any issues in this repository or elsewhere relating to this pull request.
Describe the solution you've provided
Provide a clear and concise description of what you expect to happen.
Describe alternatives you've considered
Provide a clear and concise description of any alternative solutions or features you've considered.
Additional context
Add any other context about the pull request here.