starred/terminal
1
0
Fork 0
mirror of https://github.com/microsoft/terminal.git synced 2026-02-04 05:35:20 +00:00
Code Issues 19.0k Packages Projects Releases 20 Wiki Activity

[PR #19156] Add telemetry for settings UI traffic #31727

New Issue
Open
opened 2026-01-31 09:49:10 +00:00 by claunia · 0 comments
claunia commented 2026-01-31 09:49:10 +00:00
Owner
Copy Link

Original Pull Request: https://github.com/microsoft/terminal/pull/19156

State: closed
Merged: Yes

Summary of the Pull Request

Adds a telemetry provider to the Terminal.Settings.Editor project as well as new telemetry events to track traffic through the settings UI. Specifically, the following events were added:

  • NavigatedToPage: Event emitted when the user navigates to a page in the settings UI
    • Has a PageId parameter that includes the identifier of the page that was navigated to
    • (conditionally added when PageId = page.editColorScheme) SchemeName parameter tracks the name of the color scheme that's being edited
    • conditionally added when PageId = page.extensions:
      • ExtensionPackageCount: The number of extension packages displayed
      • ProfilesModifiedCount: The number of profiles modified by enabled extensions
      • ProfilesAddedCount: The number of profiles added by enabled extensions
      • ColorSchemesAddedCount: The number of color schemes added by enabled extensions
    • conditionally added when PageId = page.extensions.extensionView:
      • FragmentSource: The source of the fragment included in this extension package
      • FragmentCount: The number of fragments included in this extension package
      • Enabled: The enabled status of the extension
    • (conditionally added when PageID = page.newTabMenu) if the page is representing a folder view
    • conditionally added when PageID = page.profile.*:
      • IsProfileDefaults: if the modified profile is the profile.defaults object
      • ProfileGuid: the guid of the profile that was navigated to
      • ProfileSource: the source of the profile that was navigated to
      • conditionally added when PageID = page.profile (aka the base profile page):
        • Orphaned: tracks if the profile was orphaned
        • Hidden: tracks if the profile is hidden
      • (conditionally added when PageID = page.profile.appearance) HasBackgroundImage: if the profile has a background image defined
      • (conditionally added when PageID = page.profile.appearance) HasUnfocusedAppearance: if the profile has an unfocused appearance defined
  • AddNewProfile: Event emitted when the user adds a new profile IsExtensionView parameter tracks if the page is representing a view of an extension
    • Has a Type parameter that represents the type of the creation method (i.e. empty profile, duplicate)
  • ResetApplicationState: Event emitted when the user resets their application state (via the UI)
  • ResetToDefaultSettings: Event emitted when the user resets their settings to their default value (via the UI)
  • OpenJson: Event emitted when the user clicks the Open JSON button in the settings UI
    • Has a SettingsTarget parameter that represents the target settings file (i.e. settings.json vs defaults.json)
  • CreateUnfocusedAppearance: Event emitted when the user creates an unfocused appearance for a profile
    • IsProfileDefaults: if the modified profile is the profile.defaults object
    • ProfileGuid: the guid of the profile that was navigated to
    • ProfileSource: the source of the profile that was navigated to
  • DeleteProfile: Event emitted when the user deletes a profile
    • also includes ProfileGuid, ProfileSource, Orphaned from the NavigatedToPage section above

The page ids can be reused later as a serialized reference to the page. We already use the one for the extensions page for the "new" badge.

**Original Pull Request:** https://github.com/microsoft/terminal/pull/19156 **State:** closed **Merged:** Yes --- ## Summary of the Pull Request Adds a telemetry provider to the Terminal.Settings.Editor project as well as new telemetry events to track traffic through the settings UI. Specifically, the following events were added: - `NavigatedToPage`: Event emitted when the user navigates to a page in the settings UI - Has a `PageId` parameter that includes the identifier of the page that was navigated to - (conditionally added when PageId = `page.editColorScheme`) `SchemeName` parameter tracks the name of the color scheme that's being edited - conditionally added when PageId = `page.extensions`: - `ExtensionPackageCount`: The number of extension packages displayed - `ProfilesModifiedCount`: The number of profiles modified by enabled extensions - `ProfilesAddedCount`: The number of profiles added by enabled extensions - `ColorSchemesAddedCount`: The number of color schemes added by enabled extensions - conditionally added when PageId = `page.extensions.extensionView`: - `FragmentSource`: The source of the fragment included in this extension package - `FragmentCount`: The number of fragments included in this extension package - `Enabled`: The enabled status of the extension - (conditionally added when PageID = `page.newTabMenu`) if the page is representing a folder view - conditionally added when PageID = `page.profile.*`: - `IsProfileDefaults`: if the modified profile is the profile.defaults object - `ProfileGuid`: the guid of the profile that was navigated to - `ProfileSource`: the source of the profile that was navigated to - conditionally added when PageID = `page.profile` (aka the base profile page): - `Orphaned`: tracks if the profile was orphaned - `Hidden`: tracks if the profile is hidden - (conditionally added when PageID = `page.profile.appearance`) `HasBackgroundImage`: `if the profile has a background image defined` - (conditionally added when PageID = `page.profile.appearance`) `HasUnfocusedAppearance`: `if the profile has an unfocused appearance defined` - `AddNewProfile`: Event emitted when the user adds a new profile `IsExtensionView` parameter tracks if the page is representing a view of an extension - Has a `Type` parameter that represents the type of the creation method (i.e. empty profile, duplicate) - `ResetApplicationState`: Event emitted when the user resets their application state (via the UI) - `ResetToDefaultSettings`: Event emitted when the user resets their settings to their default value (via the UI) - `OpenJson`: Event emitted when the user clicks the Open JSON button in the settings UI - Has a `SettingsTarget` parameter that represents the target settings file (i.e. settings.json vs defaults.json) - `CreateUnfocusedAppearance`: Event emitted when the user creates an unfocused appearance for a profile - `IsProfileDefaults`: if the modified profile is the profile.defaults object - `ProfileGuid`: the guid of the profile that was navigated to - `ProfileSource`: the source of the profile that was navigated to - `DeleteProfile`: Event emitted when the user deletes a profile - also includes `ProfileGuid`, `ProfileSource`, `Orphaned` from the `NavigatedToPage` section above The page ids can be reused later as a serialized reference to the page. We already use the one for the extensions page for the "new" badge.
claunia added the pull-request label 2026-01-31 09:49:10 +00:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
⛺ Reserved
A11yCO
A11yMAS
A11ySev1
A11ySev2
A11ySev3
A11yTTValidated
A11yUsable
A11yVoiceAccess
A11yWCAG
Area-Accessibility
Area-AtlasEngine
Area-AzureShell
Area-Build
Area-Build
Area-Chat
Area-CmdPal
Area-CodeHealth
Area-Commandline
Area-CookedRead
Area-DefApp
Area-Extensibility
Area-Fonts
Area-GroupPolicy
Area-i18n
Area-Input
Area-Interaction
Area-Interop
Area-Localization
Area-Output
Area-Performance
Area-Portable
Area-Quality
Area-Remoting
Area-Rendering
Area-Schema
Area-Server
Area-Settings
Area-SettingsUI
Area-ShellExtension
Area-ShellExtension
Area-ShellExtension
Area-Suggestions
Area-Suggestions
Area-TerminalConnection
Area-TerminalControl
Area-Theming
Area-UserInterface
Area-VT
Area-Windowing
Area-WPFControl
AutoMerge
Blocking-Ingestion
Culprit-Centennial
Culprit-WinUI
Disability-All
Disability-Blind
Disability-LowVision
Disability-Mobility
External-Blocked-WinUI3
Fixed
Gathering-Data
good first issue
HCL-E+D
HCL-WindowsTerminal
Help Wanted
Impact-Compatibility
Impact-Compliance
Impact-Correctness
Impact-Visual
In-PR
InclusionBacklog
InclusionBacklog-Windows TerminalWin32
InclusionCommitted-202206
Issue-Bug
Issue-Docs
Issue-Feature
Issue-Feature
Issue-Question
Issue-Samples
Issue-Scenario
Issue-Task
Needs-Attention
Needs-Author-Feedback
Needs-Bisect
Needs-Discussion
Needs-Repro
Needs-Tag-Fix
Needs-Tag-Fix
Needs-Triage
No-Recent-Activity
Priority-0
Priority-1
Priority-2
Priority-3
Product-Cmd.exe
Product-Colortool
Product-Colortool
Product-Colortool
Product-Conhost
Product-Conpty
Product-Meta
Product-Powershell
Product-Terminal
Product-WSL
pull-request
Mirrored from GitHub Pull Request
 Resolution-Answered
Resolution-By-Design
Resolution-Duplicate
Resolution-External
Resolution-Fix-Available
Resolution-Fix-Committed
Resolution-No-Repro
Resolution-Won't-Fix
Severity-Blocking
Severity-Crash
Severity-DataLoss
spam
this-will-be-a-breaking-change
Tracking-External
WindowsTerminal_Win32
Work-Item
zAskModeBug
zInbox-Bug
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
claunia
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/terminal#31727
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?