Add telemetry for settings UI traffic #19156

carlos-zamora · 2025-07-21T17:28:22Z

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.

DHowett · 2025-07-21T23:01:04Z

we don't have a DllMain in the settings editor. Where is it supposed to go?

You'll need to add one! Crib init.cpp from TerminalSettingsModel.

src/cascadia/TerminalSettingsEditor/Extensions.cpp

DHowett · 2025-07-29T18:50:25Z

src/cascadia/TerminalSettingsEditor/AddProfile.cpp

+                "AddNewProfile",
+                TraceLoggingDescription("Event emitted when the user adds a new profile"),
+                TraceLoggingValue("Duplicate", "Type", "The type of the creation method (i.e. empty profile, duplicate)"),
+                TraceLoggingValue(to_hstring(profileGuid).c_str(), "SourceGuid", "The guid of the profile that was copied"),


please don't do that - use TraceLoggingGuid instead and cast profileGuid to GUID

also, is the source GUID meaningful? unless it's one of the ones we know about it's just noise.

may be worth checking the source source to see if people are cloning autogenerated or fragment profiles. not to leak the source, just a boolean confirming whether Source was not empty.

DHowett · 2025-07-29T18:53:01Z

src/cascadia/TerminalSettingsEditor/ColorSchemes.cpp

@@ -26,6 +26,8 @@ namespace winrt

 namespace winrt::Microsoft::Terminal::Settings::Editor::implementation
 {
+    static constexpr std::wstring_view ColorSchemesPageId{ L"page.colorSchemes" };


nit about the names: NavigatedToPage is an unambiguous namespace, right? so the page. part of page.foo is redundant

DHowett · 2025-07-29T18:53:14Z

src/cascadia/TerminalSettingsEditor/ColorSchemes.cpp

@@ -26,6 +26,8 @@ namespace winrt

 namespace winrt::Microsoft::Terminal::Settings::Editor::implementation
 {
+    static constexpr std::wstring_view ColorSchemesPageId{ L"page.colorSchemes" };


if you're only going to use these string views in one place, you could just inline the string into the telemetry event

DHowett · 2025-07-29T18:54:27Z

src/cascadia/TerminalSettingsEditor/Extensions.cpp

+            const auto& currentPkgVM = _ViewModel.CurrentExtensionPackage();
+            const auto& currentPkg = currentPkgVM.Package();


Suggested change

const auto& currentPkgVM = _ViewModel.CurrentExtensionPackage();

const auto& currentPkg = currentPkgVM.Package();

const auto currentPkgVM = _ViewModel.CurrentExtensionPackage();

const auto currentPkg = currentPkgVM.Package();

DHowett · 2025-07-29T18:55:30Z

src/cascadia/TerminalSettingsEditor/Extensions.cpp

@@ -41,6 +42,36 @@ namespace winrt::Microsoft::Terminal::Settings::Editor::implementation
        vmImpl->ExtensionPackageIdentifierTemplateSelector(_extensionPackageIdentifierTemplateSelector);
        vmImpl->LazyLoadExtensions();
        vmImpl->MarkAsVisited();
+
+        if (_ViewModel.IsExtensionView())


for consistency, here and below, go through vmImpl->. no point in calling the projected wrapper methods when you have the literal implementation type right here

DHowett · 2025-07-29T18:59:11Z

src/cascadia/TerminalSettingsEditor/Profiles_Appearance.cpp

+            TraceLoggingDescription("Event emitted when the user navigates to a page in the settings UI"),
+            TraceLoggingValue(ProfilesAppearancePageId.data(), "PageId", "The identifier of the page that was navigated to"),
+            TraceLoggingValue(_Profile.IsBaseLayer(), "IsProfileDefaults", "If the modified profile is the profile.defaults object"),
+            TraceLoggingValue(to_hstring(_Profile.Guid()).c_str(), "ProfileGuid", "The guid of the profile that was navigated to"),


same note about guid

DHowett · 2025-07-29T18:59:24Z

src/cascadia/TerminalSettingsEditor/Profiles_Appearance.cpp

+            "CreateUnfocusedAppearance",
+            TraceLoggingDescription("Event emitted when the user creates an unfocused appearance for a profile"),
+            TraceLoggingValue(_Profile.IsBaseLayer(), "IsProfileDefaults", "If the modified profile is the profile.defaults object"),
+            TraceLoggingValue(to_hstring(_Profile.Guid()).c_str(), "ProfileGuid", "The guid of the profile that was navigated to"),


same note about guid

DHowett · 2025-07-29T19:00:01Z

src/cascadia/TerminalSettingsEditor/Profiles_Base.cpp

+            TraceLoggingValue(_Profile.IsBaseLayer(), "IsProfileDefaults", "If the modified profile is the profile.defaults object"),
+            TraceLoggingValue(to_hstring(_Profile.Guid()).c_str(), "ProfileGuid", "The guid of the profile that was navigated to"),
+            TraceLoggingValue(_Profile.Source().c_str(), "ProfileSource", "The source of the profile that was navigated to"),
+            TraceLoggingValue(false, "Orphaned", "Tracks if the profile was orphaned"),


one could argue that the orphaned profile page is just a different type of page.

DHowett · 2025-07-29T19:00:30Z

src/cascadia/TerminalSettingsEditor/Profiles_Base.cpp

+            TraceLoggingDescription("Event emitted when the user navigates to a page in the settings UI"),
+            TraceLoggingValue(ProfilesBasePageId.data(), "PageId", "The identifier of the page that was navigated to"),
+            TraceLoggingValue(_Profile.IsBaseLayer(), "IsProfileDefaults", "If the modified profile is the profile.defaults object"),
+            TraceLoggingValue(to_hstring(_Profile.Guid()).c_str(), "ProfileGuid", "The guid of the profile that was navigated to"),


same note about guid

DHowett · 2025-07-29T19:01:08Z

src/cascadia/TerminalSettingsEditor/Profiles_Base_Orphaned.cpp

+            "NavigatedToPage",
+            TraceLoggingDescription("Event emitted when the user navigates to a page in the settings UI"),
+            TraceLoggingValue(ProfilesBaseOrphanedPageId.data(), "PageId", "The identifier of the page that was navigated to"),
+            TraceLoggingValue(_Profile.IsBaseLayer(), "IsProfileDefaults", "If the modified profile is the profile.defaults object"),


this is an impossibility

Add telemetry for settings UI traffic

9f494b0

This comment was marked as resolved.

Sign in to view

introduce init.cpp; add more metadata

3f3f2d7

carlos-zamora marked this pull request as ready for review July 22, 2025 00:27

carlos-zamora commented Jul 22, 2025

View reviewed changes

src/cascadia/TerminalSettingsEditor/Extensions.cpp Outdated Show resolved Hide resolved

add separate page id for extension subpage

559241c

carlos-zamora added this to 1.22 Servicing Pipeline and 1.23 Servicing Pipeline Jul 22, 2025

github-project-automation bot moved this to To Cherry Pick in 1.22 Servicing Pipeline Jul 22, 2025

github-project-automation bot moved this to To Cherry Pick in 1.23 Servicing Pipeline Jul 22, 2025

DHowett requested changes Jul 29, 2025

View reviewed changes

microsoft-github-policy-service bot added the Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something label Jul 29, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add telemetry for settings UI traffic #19156

Add telemetry for settings UI traffic #19156

Uh oh!

carlos-zamora commented Jul 21, 2025 •

edited

Loading

Uh oh!

This comment was marked as resolved.

DHowett commented Jul 21, 2025

Uh oh!

Uh oh!

DHowett Jul 29, 2025

Uh oh!

DHowett Jul 29, 2025

Uh oh!

DHowett Jul 29, 2025

Uh oh!

DHowett Jul 29, 2025

Uh oh!

DHowett Jul 29, 2025

Uh oh!

DHowett Jul 29, 2025

Uh oh!

DHowett Jul 29, 2025

Uh oh!

DHowett Jul 29, 2025

Uh oh!

DHowett Jul 29, 2025

Uh oh!

DHowett Jul 29, 2025

Uh oh!

DHowett Jul 29, 2025

Uh oh!

Uh oh!

		const auto& currentPkgVM = _ViewModel.CurrentExtensionPackage();
		const auto& currentPkg = currentPkgVM.Package();

Add telemetry for settings UI traffic #19156

Are you sure you want to change the base?

Add telemetry for settings UI traffic #19156

Uh oh!

Conversation

carlos-zamora commented Jul 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary of the Pull Request

Uh oh!

This comment was marked as resolved.

DHowett commented Jul 21, 2025

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

carlos-zamora commented Jul 21, 2025 •

edited

Loading