-
Notifications
You must be signed in to change notification settings - Fork 0
feat(telemetry): add basic telemetry system #34
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
miguelsanchez-upsun
wants to merge
8
commits into
main
Choose a base branch
from
telemetry-integration-draft
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
829a990
feat(telemetry): add basic telemetry system
miguelsanchez-upsun 3a0b3e0
test(telemetry): fix version assertion to use actual CLI version
miguelsanchez-upsun d84e984
chore(telemetry): linting and cleanup fixes
miguelsanchez-upsun 4861115
chore(telemetry): minor test cleanup
miguelsanchez-upsun 1513c9f
chore(telemetry): remove extra trailing newline in telemetry_test.go
miguelsanchez-upsun 445e20f
chore(telemetry): add missing testing.T
miguelsanchez-upsun 11536a6
chore(telemetry): fix failing tests
miguelsanchez-upsun 1cd0d03
feat(telemetry): fix linting
miguelsanchez-upsun File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -11,6 +11,7 @@ import ( | |
| "regexp" | ||
| "slices" | ||
| "strings" | ||
| "time" | ||
|
|
||
| "github.com/fatih/color" | ||
| "github.com/platformsh/platformify/commands" | ||
|
|
@@ -22,6 +23,7 @@ import ( | |
| "github.com/upsun/cli/internal/config" | ||
| "github.com/upsun/cli/internal/config/alt" | ||
| "github.com/upsun/cli/internal/legacy" | ||
| "github.com/upsun/cli/internal/telemetry" | ||
| ) | ||
|
|
||
| // Execute is the main entrypoint to run the CLI. | ||
|
|
@@ -88,11 +90,23 @@ func newRootCommand(cnf *config.Config, assets *vendorization.VendorAssets) *cob | |
| }, | ||
| Run: func(cmd *cobra.Command, _ []string) { | ||
| c := makeLegacyCLIWrapper(cnf, cmd.OutOrStdout(), cmd.ErrOrStderr(), cmd.InOrStdin()) | ||
| if err := c.Exec(cmd.Context(), os.Args[1:]...); err != nil { | ||
| err := c.Exec(cmd.Context(), os.Args[1:]...) | ||
|
|
||
| if err != nil { | ||
| exitWithError(err) | ||
| } | ||
|
|
||
| waitForTelemetry(cmd.Context(), cnf, os.Args[1:]) | ||
| }, | ||
| PersistentPostRun: func(cmd *cobra.Command, _ []string) { | ||
| // Send telemetry for Go-native subcommands only | ||
| // Legacy commands send telemetry in Run before exitWithError | ||
| // cmd.Parent() != nil means this is a subcommand, not the root | ||
| if cmd.Parent() != nil { | ||
| telemetry.SendTelemetryEvent(cmd.Context(), cnf, cmd.Use) | ||
| // Fire and forget for native commands | ||
| } | ||
|
|
||
| checkShellConfigLeftovers(cmd.ErrOrStderr(), cnf) | ||
| select { | ||
| case rel := <-updateMessageChan: | ||
|
|
@@ -118,9 +132,13 @@ func newRootCommand(cnf *config.Config, assets *vendorization.VendorAssets) *cob | |
| } | ||
|
|
||
| c := makeLegacyCLIWrapper(cnf, cmd.OutOrStdout(), cmd.ErrOrStderr(), cmd.InOrStdin()) | ||
| if err := c.Exec(cmd.Context(), args...); err != nil { | ||
| err := c.Exec(cmd.Context(), args...) | ||
|
|
||
| if err != nil { | ||
| exitWithError(err) | ||
| } | ||
|
|
||
| // Don't send telemetry for help commands | ||
| }) | ||
|
|
||
| cmd.PersistentFlags().BoolP("version", "V", false, fmt.Sprintf("Displays the %s version", cnf.Application.Name)) | ||
|
|
@@ -276,3 +294,15 @@ func makeLegacyCLIWrapper(cnf *config.Config, stdout, stderr io.Writer, stdin io | |
| Stdin: stdin, | ||
| } | ||
| } | ||
|
|
||
| func waitForTelemetry(ctx context.Context, cnf *config.Config, args []string) { | ||
| command := telemetry.ExtractCommand(args) | ||
| done := telemetry.SendTelemetryEvent(ctx, cnf, command) | ||
|
|
||
| select { | ||
| case <-done: | ||
| // Telemetry completed | ||
| case <-time.After(2 * time.Second): | ||
| // Timeout - proceed anyway to avoid blocking user | ||
| } | ||
|
Comment on lines
+298
to
+307
|
||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In Cobra commands,
cmd.Usecan include placeholders like "init [flags]" (e.g.initis defined asUse: "init [flags]"), which won't match the exact strings inIsTracked(). As a result, telemetry won't be sent for tracked Go-native commands. Usecmd.Name()(orcmd.CommandPath()if you want full path) instead ofcmd.Usewhen reporting the command identifier.