Log when there is no telemetry by williammartin · Pull Request #13255 · cli/cli

williammartin · 2026-04-21T16:15:24Z

Description

Logs telemetry state even when there are no events.

➜  GH_PRIVATE_ENABLE_TELEMETRY=true GH_TELEMETRY_SAMPLE_RATE=100 GH_TELEMETRY=log ./bin/gh version
gh version 2.90.0-25-ge52070e07 (2026-04-21)
https://github.com/cli/cli/releases/latest
Telemetry payload:
{
  "events": [
    {
      "type": "command_invocation",
      "dimensions": {
        "agent": "",
        "architecture": "arm64",
        "ci": "false",
        "command": "gh version",
        "device_id": "1e9a73a6-c8bd-4e1e-be02-78f4b11de4e1",
        "flags": "",
        "github_actions": "false",
        "invocation_id": "bc524d06-8e59-4276-bcf9-7ad719bac391",
        "is_tty": "true",
        "os": "darwin",
        "timestamp": "2026-04-21T16:14:27.400Z",
        "version": "2.90.0-25-ge52070e07"
      }
    }
  ]
}

// Force enterprise disable
➜  GH_ENTERPRISE_TOKEN=foo GH_PRIVATE_ENABLE_TELEMETRY=true GH_TELEMETRY_SAMPLE_RATE=100 GH_TELEMETRY=log ./bin/gh version
gh version 2.90.0-25-ge52070e07 (2026-04-21)
https://github.com/cli/cli/releases/latest
Telemetry payload: none

williammartin · 2026-04-21T16:16:41Z

+	// When the service has been disabled mid-invocation (e.g. an enterprise host
+	// was contacted), discard any recorded events. We still call the flusher
+	// with an empty payload so that the log-mode flusher can surface the
+	// absence of telemetry rather than leaving the user staring at silence.
+	events := s.events
+	if s.disabled {
+		events = nil
 	}


I dunno about this. I mean, it's correct, it just seems kind of scary and easy to mistake in future!

Signed-off-by: Babak K. Shandiz <babakks@github.com>

babakks

LGTM. Just lowered the bias in selecting sample bucket by incorporating 4 bytes of the SHA1 sum.

babakks · 2026-04-21T16:37:37Z

-		telemetryService = &telemetry.NoOpService{}
 	default:
 		telemetryState := telemetry.ParseTelemetryState(cfg.Telemetry().Value)
+		telemetryDisabled := os.Getenv("GH_PRIVATE_ENABLE_TELEMETRY") == "" || mightBeGHESUser(cfg)


The env var is irrelevant now.

Suggested change

telemetryDisabled := os.Getenv("GH_PRIVATE_ENABLE_TELEMETRY") == "" || mightBeGHESUser(cfg)

telemetryDisabled := mightBeGHESUser(cfg)

nvm, we'll rebase #13254 after this is merged.

Copilot

Pull request overview

This PR makes telemetry “log” mode produce an explicit output even when no telemetry events are emitted, so users can distinguish “telemetry disabled/no events” from “telemetry not wired up.”

Changes:

Update LogFlusher to print Telemetry payload: none for empty payloads, and adjust service flush behavior to invoke the flusher even with zero events (while dropping events when disabled).
Avoid spawning gh send-telemetry for empty payloads in enabled mode.
Update command wiring and acceptance/unit tests to expect the explicit “none” marker.

Show a summary per file

File	Description
internal/telemetry/telemetry.go	Print a “none” marker for empty log payloads; call flush with empty payloads; drop events when disabled; skip subprocess spawn for empty payloads.
internal/telemetry/telemetry_test.go	Add/adjust tests to validate empty-payload flushing and disabled behavior.
internal/ghcmd/cmd.go	Always instantiate the real telemetry service in log mode, disabling it when telemetry is otherwise gated, to ensure “none” is surfaced.
acceptance/testdata/telemetry/no-telemetry-for-send-telemetry.txtar	Expect `Telemetry payload: none` instead of silence.
acceptance/testdata/telemetry/no-telemetry-for-ghes-user.txtar	Expect `Telemetry payload: none` for GHES-disabled telemetry.
acceptance/testdata/telemetry/no-telemetry-for-extension.txtar	Expect `Telemetry payload: none` when extensions suppress events.
acceptance/testdata/telemetry/no-telemetry-for-completion.txtar	Expect `Telemetry payload: none` when completion suppresses events.

Copilot's findings

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Files reviewed: 7/7 changed files
Comments generated: 1

Copilot · 2026-04-21T17:34:34Z

+	// with an empty payload so that the log-mode flusher can surface the
+	// absence of telemetry rather than leaving the user staring at silence.
+	events := s.events
+	if s.disabled {


When s.disabled is true, Flush discards events by setting the local events to nil, but any already-recorded s.events are still retained. Since Record continues appending after Disable(), this can keep event/dimension data alive unnecessarily (and do extra allocations) even though it will never be sent. Consider clearing s.events when disabled (or otherwise preventing accumulation) so the data can be GC’d sooner.

Suggested change

if s.disabled {

if s.disabled {

s.events = nil

This MR contains the following updates: | Package | Update | Change | |---|---|---| | [cli/cli](https://github.com/cli/cli) | minor | `v2.90.0` → `v2.92.0` | MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot). **Proposed changes to behavior should be submitted there as MRs.** --- ### Release Notes <details> <summary>cli/cli (cli/cli)</summary> ### [`v2.92.0`](https://github.com/cli/cli/releases/tag/v2.92.0): GitHub CLI 2.92.0 [Compare Source](cli/cli@v2.91.0...v2.92.0) #### Support GitHub Enterprise Cloud (GHEC) in `skill` commandset Now `gh skill` subcommands (`install`, `preview`, `publish`, `search`, `update`) are able to work with [GHEC](https://docs.github.com/en/enterprise-cloud@latest/admin/overview/about-github-enterprise-cloud) hosts with data residency. #### Add `--allow-hidden-dirs` flag to `skill preview` Following the addition of `--allow-hidden-dirs` to `skill install` in the previous release, now the flag is also supported in `skill preview`, allowing users to preview skills located in hidden (dot-prefixed) directories such as `.claude/skills/`, `.agents/skills/`, and `.github/skills/`. #### What's Changed ##### ✨ Features - feat(skills): add --allow-hidden-dirs flag to preview command by [@SamMorrowDrums](https://github.com/SamMorrowDrums) in [#13265](cli/cli#13265) - feat(skills): support GHEC with data residency hosts by [@SamMorrowDrums](https://github.com/SamMorrowDrums) in [#13264](cli/cli#13264) ##### 🐛 Fixes - Fix SetSampleRate not updating sample\_rate dimension by [@williammartin](https://github.com/williammartin) in [#13259](cli/cli#13259) - Fix log terminal injection by [@williammartin](https://github.com/williammartin) in [#13272](cli/cli#13272) - Add "Resource not accessible" to ProjectsV2IgnorableError by [@maxbeizer](https://github.com/maxbeizer) in [#13281](cli/cli#13281) ##### 📚 Docs & Chores - fix: using variable interpolation \`${{ in deployment.yml... by [@orbisai0security](https://github.com/orbisai0security) in [#13258](cli/cli#13258) - docs: correct typo in Linux Homebrew copy by [@cassidyjames](https://github.com/cassidyjames) in [#13273](cli/cli#13273) - Install skills flat by Name, not namespaced InstallName by [@SamMorrowDrums](https://github.com/SamMorrowDrums) in [#13266](cli/cli#13266) - chore: fix zsh completion on debian by [@babakks](https://github.com/babakks) in [#13274](cli/cli#13274) - Add trust disclaimer to extension help text by [@travellertales](https://github.com/travellertales) in [#13296](cli/cli#13296) - Bump Go to 1.26.2 by [@github-actions](https://github.com/github-actions)\[bot] in [#13301](cli/cli#13301) #####

Dependencies - chore(deps): bump github.com/mattn/go-isatty from 0.0.20 to 0.0.21 by [@dependabot](https://github.com/dependabot)\[bot] in [#13161](cli/cli#13161) - chore(deps): bump github.com/google/go-containerregistry from 0.21.4 to 0.21.5 by [@dependabot](https://github.com/dependabot)\[bot] in [#13162](cli/cli#13162) - chore(deps): bump charm.land/lipgloss/v2 from 2.0.2 to 2.0.3 by [@dependabot](https://github.com/dependabot)\[bot] in [#13163](cli/cli#13163) - chore(deps): bump charm.land/bubbletea/v2 from 2.0.2 to 2.0.6 by [@dependabot](https://github.com/dependabot)\[bot] in [#13206](cli/cli#13206) - chore(deps): bump github.com/gdamore/tcell/v2 from 2.13.8 to 2.13.9 by [@dependabot](https://github.com/dependabot)\[bot] in [#13241](cli/cli#13241) - chore(deps): bump github.com/mattn/go-isatty from 0.0.21 to 0.0.22 by [@dependabot](https://github.com/dependabot)\[bot] in [#13298](cli/cli#13298) #### New Contributors - [@orbisai0security](https://github.com/orbisai0security) made their first contribution in [#13258](cli/cli#13258) - [@cassidyjames](https://github.com/cassidyjames) made their first contribution in [#13273](cli/cli#13273) - [@travellertales](https://github.com/travellertales) made their first contribution in [#13296](cli/cli#13296) **Full Changelog**: <cli/cli@v2.91.0...v2.92.0> ### [`v2.91.0`](https://github.com/cli/cli/releases/tag/v2.91.0): GitHub CLI 2.91.0 [Compare Source](cli/cli@v2.90.0...v2.91.0) #### GitHub CLI now collects pseudonymous telemetry To better understand how features are used in practice, especially as agentic adoption grows, GitHub CLI now sends pseudonymous telemetry. See [Telemetry](https://cli.github.com/telemetry) for more details on what's collected, why, and how to opt out. #### Support more agents in `gh skill` Thanks to community feedback, `gh` now supports a large number of agent hosts. Run `gh skill install --help` for the list of available agents. #### Improve skill discovery `gh skill install` now adds the `--allow-hidden-dirs` flag to support discovering skills in hidden (dot-prefixed) directories such as `.claude/skills/`, `.agents/skills/`, and `.github/skills/`. #### Detect skills re-published from other sources GitHut CLI now detects if the skill to be installed is re-published from an upstream source and offers the option to install it from there. The `--upstream` flag is also added for non-interactive use cases. #### What's Changed ##### ✨ Features - Add support for installation in multiple agent hosts in `gh skills install` by [@tommaso-moro](https://github.com/tommaso-moro) in [#13209](cli/cli#13209) - Add --allow-hidden-dirs flag to gh skill install by [@SamMorrowDrums](https://github.com/SamMorrowDrums) in [#13213](cli/cli#13213) - Make skill discovery less strict: support nested `skills/` directories by [@SamMorrowDrums](https://github.com/SamMorrowDrums) in [#13235](cli/cli#13235) - feat(skills): detect re-published skills and offer upstream install by [@SamMorrowDrums](https://github.com/SamMorrowDrums) in [#13236](cli/cli#13236) ##### 🐛 Fixes - Fix `skills publish --fix` to not publish by [@SamMorrowDrums](https://github.com/SamMorrowDrums) in [#13237](cli/cli#13237) - fix(skills): match skills by install name in preview command by [@SamMorrowDrums](https://github.com/SamMorrowDrums) in [#13249](cli/cli#13249) ##### 📚 Docs & Chores - Remove misleading text by [@tommaso-moro](https://github.com/tommaso-moro) in [#13203](cli/cli#13203) - Add sampled command telemetry by [@williammartin](https://github.com/williammartin) in [#13191](cli/cli#13191) - Do not send telemetry for aliases by [@williammartin](https://github.com/williammartin) in [#13192](cli/cli#13192) - Add skills specific telemetry by [@williammartin](https://github.com/williammartin) in [#13204](cli/cli#13204) - Record CI context in telemetry by [@williammartin](https://github.com/williammartin) in [#13210](cli/cli#13210) - Record official extension telemetry by [@williammartin](https://github.com/williammartin) in [#13205](cli/cli#13205) - Add telemetry command by [@williammartin](https://github.com/williammartin) in [#13253](cli/cli#13253) - Log when there is no telemetry by [@williammartin](https://github.com/williammartin) in [#13255](cli/cli#13255) - docs(skills): add gh and gh-skill agent skills by [@BagToad](https://github.com/BagToad) in [#13244](cli/cli#13244) - Enable telemetry without env var by [@williammartin](https://github.com/williammartin) in [#13254](cli/cli#13254) **Full Changelog**: <cli/cli@v2.90.0...v2.91.0> </details> --- ### Configuration 📅 **Schedule**: (UTC) - Branch creation - At any time (no schedule defined) - Automerge - At any time (no schedule defined) 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this MR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this MR, check this box --- This MR has been generated by [Mend Renovate](https://github.com/renovatebot/renovate).

Log when there is no telemetry

571bb1c

williammartin commented Apr 21, 2026

View reviewed changes

williammartin requested a review from babakks April 21, 2026 16:16

babakks added 2 commits April 21, 2026 17:49

fix(telemetry): lower bias in sample bucket calc

ec4a3ed

Signed-off-by: Babak K. Shandiz <babakks@github.com>

test(telemetry): assert ANSI escape chars for color codes

0467ed4

Signed-off-by: Babak K. Shandiz <babakks@github.com>

babakks approved these changes Apr 21, 2026

View reviewed changes

williammartin marked this pull request as ready for review April 21, 2026 17:30

williammartin requested a review from a team as a code owner April 21, 2026 17:30

williammartin requested review from BagToad and Copilot April 21, 2026 17:30

Copilot started reviewing on behalf of williammartin April 21, 2026 17:30 View session

williammartin merged commit 3a6d4de into trunk Apr 21, 2026
19 checks passed

williammartin deleted the wm/log-no-events branch April 21, 2026 17:30

Copilot AI reviewed Apr 21, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Log when there is no telemetry#13255

Log when there is no telemetry#13255
williammartin merged 3 commits into
trunkfrom
wm/log-no-events

williammartin commented Apr 21, 2026 •

edited

Loading

Uh oh!

williammartin Apr 21, 2026

Uh oh!

babakks left a comment

Uh oh!

babakks Apr 21, 2026

Uh oh!

babakks Apr 21, 2026

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Apr 21, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	telemetryDisabled := os.Getenv("GH_PRIVATE_ENABLE_TELEMETRY") == "" \|\| mightBeGHESUser(cfg)
	telemetryDisabled := mightBeGHESUser(cfg)

Conversation

williammartin commented Apr 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Uh oh!

williammartin Apr 21, 2026

Choose a reason for hiding this comment

Uh oh!

babakks left a comment

Choose a reason for hiding this comment

Uh oh!

babakks Apr 21, 2026

Choose a reason for hiding this comment

Uh oh!

babakks Apr 21, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Copilot's findings

Uh oh!

Copilot AI Apr 21, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

williammartin commented Apr 21, 2026 •

edited

Loading