[devbox] Add anonymized telemetry #40
Merged
Conversation
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
loreto
force-pushed
the
daniel/telemetry
branch
from
12977c2 to
c86b0f2
Compare
gcurtis
approved these changes
Aug 30, 2022
boxcli/midcobra/telemetry.go
Outdated
|
|
||
| return &telemetryMiddleware{ | ||
| opts: *opts, | ||
| disabled: noTrackEnvVar == "1" || noTrackEnvVar == "true" || opts.TelemetryKey == "", |
There was a problem hiding this comment.
strconv.ParseBool will catch all the usual values.
| @@ -10,6 +10,7 @@ builds: | |||
| - -s -w -X go.jetpack.io/devbox/build.Version={{.Version}} | |||
| - -s -w -X go.jetpack.io/devbox/build.Commit={{.Commit}} | |||
| - -s -w -X go.jetpack.io/devbox/build.CommitDate={{.CommitDate}} | |||
| - -s -w -X go.jetpack.io/devbox/build.TelemetryKey={{ .Env.TELEMETRY_KEY }} | |||
There was a problem hiding this comment.
Does this actually need to be kept secret? It'll still be visible in the binary. Can we just put it in a const instead of a linker flag?
There was a problem hiding this comment.
I'm gonna leave as is for this PR since it's already working, but we can hard-code it in a follow up clean up.
I'm open either way, last time I asked on Slack, folks leaned towards hiding this, so that's why I implemented this way.
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.
Summary
Add anonymized telemetry to understand usage of devbox and further improve it. We allow users to opt-out via an environment variable.
To add telemetry I implemented a small "midcobra" framework, that make it possible to add "middlware" to cobra CLIs. The plan is to re-use the midcobra functionality in other binaries like
envsec.How was it tested?
Built locally, ran, and checked telemetry logs.