Add sampled command telemetry · cli/cli@18dc5e7 · GitHub
Skip to content

Commit 18dc5e7

Browse files
williammartinwilliammartin
committed
Add sampled command telemetry
1 parent 26d2302 commit 18dc5e7

38 files changed

Lines changed: 3337 additions & 18 deletions

‎.gitignore‎

Lines changed: 4 additions & 0 deletions

‎Makefile‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,10 @@ completions: bin/gh$(EXE)
3838
bin/gh$(EXE) completion -s fish > ./share/fish/vendor_completions.d/gh.fish
3939
bin/gh$(EXE) completion -s zsh > ./share/zsh/site-functions/_gh
4040

41+
.PHONY: lint
42+
lint:
43+
golangci-lint run ./...
44+
4145
# just convenience tasks around `go test`
4246
.PHONY: test
4347
test:

‎acceptance/acceptance_test.go‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -182,6 +182,15 @@ func TestWorkflows(t *testing.T) {
182182
testscript.Run(t, testScriptParamsFor(tsEnv, "workflow"))
183183
}
184184

185+
func TestTelemetry(t *testing.T) {
186+
var tsEnv testScriptEnv
187+
if err := tsEnv.fromEnv(); err != nil {
188+
t.Fatal(err)
189+
}
190+
191+
testscript.Run(t, testScriptParamsFor(tsEnv, "telemetry"))
192+
}
193+
185194
func testScriptParamsFor(tsEnv testScriptEnv, command string) testscript.Params {
186195
var files []string
187196
if tsEnv.script != "" {
@@ -226,6 +235,8 @@ func sharedSetup(tsEnv testScriptEnv) func(ts *testscript.Env) error {
226235

227236
ts.Setenv("RANDOM_STRING", randomString(10))
228237

238+
ts.Setenv("GH_TELEMETRY", "false")
239+
229240
// The sandbox overrides HOME, so git cannot find the user's global
230241
// config. Write a minimal identity so commits inside the sandbox
231242
// don't fail with "Author identity unknown".

‎acceptance/testdata/telemetry/command-invocation.txtar‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Telemetry log mode outputs command invocation event to stderr
2+
env GH_PRIVATE_ENABLE_TELEMETRY=1
3+
env GH_TELEMETRY=log
4+
env GH_TELEMETRY_SAMPLE_RATE=100
5+
6+
exec gh version
7+
stderr 'Telemetry payload:'
8+
stderr '"type": "command_invocation"'
9+
stderr '"command": "gh version"'

‎acceptance/testdata/telemetry/no-telemetry-for-completion.txtar‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# The completion command should not generate a telemetry event
2+
env GH_PRIVATE_ENABLE_TELEMETRY=1
3+
env GH_TELEMETRY=log
4+
env GH_TELEMETRY_SAMPLE_RATE=100
5+
6+
exec gh completion -s bash
7+
! stderr 'Telemetry payload:'

‎acceptance/testdata/telemetry/no-telemetry-for-extension.txtar‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Extensions should not generate telemetry events
2+
[!exec:bash] skip
3+
4+
env GH_PRIVATE_ENABLE_TELEMETRY=1
5+
env GH_TELEMETRY=log
6+
env GH_TELEMETRY_SAMPLE_RATE=100
7+
8+
# Create a local shell extension repository
9+
exec git init gh-hello
10+
cp gh-hello.sh gh-hello/gh-hello
11+
chmod 755 gh-hello/gh-hello
12+
exec git -C gh-hello add gh-hello
13+
exec git -C gh-hello commit -m 'init'
14+
15+
# Install it locally
16+
cd gh-hello
17+
exec gh ext install .
18+
cd $WORK
19+
20+
# Run the extension and verify no telemetry is logged
21+
exec gh hello
22+
stdout 'hello from extension'
23+
! stderr 'Telemetry payload:'
24+
25+
-- gh-hello.sh --
26+
#!/usr/bin/env bash
27+
echo "hello from extension"

‎acceptance/testdata/telemetry/no-telemetry-for-send-telemetry.txtar‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# The send-telemetry command should not itself generate a telemetry event
2+
env GH_PRIVATE_ENABLE_TELEMETRY=1
3+
env GH_TELEMETRY=log
4+
env GH_TELEMETRY_SAMPLE_RATE=100
5+
env GH_TELEMETRY_ENDPOINT_URL=http://localhost:1
6+
7+
# Provide a minimal valid payload on stdin so the command can run.
8+
# It will fail to connect but that's fine — we only care about telemetry logging.
9+
stdin payload.json
10+
! exec gh send-telemetry
11+
! stderr 'Telemetry payload:'
12+
13+
-- payload.json --
14+
{"events":[{"type":"test","dimensions":{},"measures":{}}]}

‎acceptance/testdata/telemetry/telemetry-failure-does-not-break-command.txtar‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Command completes successfully even when telemetry endpoint is unreachable
2+
env GH_PRIVATE_ENABLE_TELEMETRY=1
3+
env GH_TELEMETRY=enabled
4+
env GH_TELEMETRY_SAMPLE_RATE=100
5+
env GH_TELEMETRY_ENDPOINT_URL=http://localhost:1
6+
7+
exec gh version
8+
stdout 'gh version'

‎cmd/gen-docs/main.go‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ import (
1111
"github.com/cli/cli/v2/internal/docs"
1212
"github.com/cli/cli/v2/internal/gh"
1313
"github.com/cli/cli/v2/internal/ghrepo"
14+
"github.com/cli/cli/v2/internal/telemetry"
1415
"github.com/cli/cli/v2/pkg/cmd/root"
1516
"github.com/cli/cli/v2/pkg/cmdutil"
1617
"github.com/cli/cli/v2/pkg/extensions"
@@ -53,7 +54,7 @@ func run(args []string) error {
5354
return config.NewFromString(""), nil
5455
},
5556
ExtensionManager: &em{},
56-
}, "", "")
57+
}, &telemetry.NoOpService{}, "", "")
5758
rootCmd.InitDefaultHelpCmd()
5859

5960
if err := os.MkdirAll(*dir, 0755); err != nil {

‎go.mod‎

Lines changed: 2 additions & 1 deletion

0 commit comments

Comments
 (0)