[General]Add an option for telemetry opt-in and visualization(#34078)

* Data diagnostics opt-in * [c++] Drop DROP_PII flag * Bump telemtry package to 2.0.2 * Drop DropPii from custom actions * Cleanup * Do not start manually C# EtwTrace. FZ engine exit event. * ImageResizer, PowerRename, FileLocksmith prev handlers * Revert C# handlers exe logging * Revert "Revert C# handlers exe logging" This reverts commit 4c75a3953b. * Do not recreate EtwTrace * consume package * xaml formatting * Fix deps.json audit * Update telem package paths * Address PR comments * Fix AdvancedPaste close on PT close * Override etl file name for explorer loaded dlls Start/stop tracer when needed for explorer loaded dlls to prevent explorer overload * Fix setting desc * Fix missing events * Add infobar to restart when enable data viewing * Flush on timer every 30s * [Settings] Update View Data diagnostic description text [New+] Add tracer * Show Restart info bar for both enable/disable data viewer * Fix newplus * Fix stuck on restart and terminate AdvPaste exe on destroy() * [Installer] Add tracer * Address PR comment * Add missing tracers * Exclude etw dir from BugReport * Fix bad merge * [Hosts] Proper exit on initial dialog * [OOBE] Make Data diagnostic setting visible without scroll * [OOBE] Add hiperlynk to open general settings * Disable data view on disabling data diagnostics * Don't disable View data button * Fix disabling data viewing * Add missing dot * Revert formatting
2026-04-05 18:57:19 +02:00 · 2024-10-24 22:04:32 +02:00
parent f9127b63a5
commit 133aa85f2b
269 changed files with 2622 additions and 1256 deletions
--- a/src/settings-ui/Settings.UI/SettingsXAML/App.xaml.cs
+++ b/src/settings-ui/Settings.UI/SettingsXAML/App.xaml.cs
@@ -70,6 +70,8 @@ namespace Microsoft.PowerToys.Settings.UI

        public static Action<string> IPCMessageReceivedCallback { get; set; }

+        public ETWTrace EtwTrace { get; private set; } = new ETWTrace();
+
        /// <summary>
        /// Initializes a new instance of the <see cref="App"/> class.
        /// Initializes the singleton application object. This is the first line of authored code
@@ -88,6 +90,13 @@ namespace Microsoft.PowerToys.Settings.UI
            InitializeComponent();

            UnhandledException += App_UnhandledException;
+
+            NativeEventWaiter.WaitForEventLoop(
+                Constants.PowerToysRunnerTerminateSettingsEvent(), () =>
+            {
+                EtwTrace?.Dispose();
+                Environment.Exit(0);
+            });
        }

        private void App_UnhandledException(object sender, Microsoft.UI.Xaml.UnhandledExceptionEventArgs e)
--- a/src/settings-ui/Settings.UI/SettingsXAML/OOBE/Views/OobeOverview.xaml
+++ b/src/settings-ui/Settings.UI/SettingsXAML/OOBE/Views/OobeOverview.xaml
@@ -5,6 +5,8 @@
    xmlns:controls="using:Microsoft.PowerToys.Settings.UI.Controls"
    xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
    xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
+    xmlns:tkcontrols="using:CommunityToolkit.WinUI.Controls"
+    xmlns:ui="using:CommunityToolkit.WinUI"
    mc:Ignorable="d">

    <controls:OOBEPageControl x:Uid="Oobe_Overview" HeroImage="ms-appx:///Assets/Settings/Modules/OOBE/PTHero.png">
@@ -17,6 +19,35 @@
                        <TextBlock x:Uid="Oobe_Overview_DescriptionLinkText" TextWrapping="Wrap" />
                    </HyperlinkButton>
                </StackPanel>
+
+                <StackPanel
+                    Orientation="Vertical"
+                    Spacing="8"
+                    Visibility="{x:Bind ShowDataDiagnosticsSetting, Mode=OneWay, Converter={StaticResource BoolToVisibilityConverter}}">
+                    <TextBlock
+                        x:Uid="Oobe_Overview_Telemetry_Title"
+                        Margin="0,20,0,0"
+                        Style="{StaticResource SubtitleTextBlockStyle}" />
+                    <TextBlock x:Uid="Oobe_Overview_Telemetry_Desc" Foreground="{ThemeResource TextFillColorSecondaryBrush}" />
+
+                    <tkcontrols:SettingsCard
+                        x:Uid="Oobe_Overview_EnableDataDiagnostics"
+                        HeaderIcon="{ui:FontIcon Glyph=&#xE9D9;}"
+                        IsEnabled="{x:Bind ShowDataDiagnosticsSetting, Mode=OneWay}">
+                        <ToggleSwitch x:Uid="ToggleSwitch" IsOn="{x:Bind EnableDataDiagnostics, Mode=TwoWay}" />
+                    </tkcontrols:SettingsCard>
+
+                    <HyperlinkButton
+                        x:Uid="Oobe_Overview_DiagnosticsAndFeedback_Settings_Link"
+                        Margin="-8,0,0,0"
+                        Click="GeneralSettingsLaunchButton_Click" />
+
+                    <HyperlinkButton
+                        x:Uid="Oobe_Overview_DiagnosticsAndFeedback_Link"
+                        Margin="-8,0,0,0"
+                        NavigateUri="https://aka.ms/powertoys-data-and-privacy-documentation" />
+
+                </StackPanel>
            </StackPanel>
        </controls:OOBEPageControl.PageContent>
    </controls:OOBEPageControl>
--- a/src/settings-ui/Settings.UI/SettingsXAML/OOBE/Views/OobeOverview.xaml.cs
+++ b/src/settings-ui/Settings.UI/SettingsXAML/OOBE/Views/OobeOverview.xaml.cs
@@ -2,9 +2,11 @@
 // The Microsoft Corporation licenses this file to you under the MIT license.
 // See the LICENSE file in the project root for more information.

+using global::PowerToys.GPOWrapper;
 using Microsoft.PowerToys.Settings.UI.OOBE.Enums;
 using Microsoft.PowerToys.Settings.UI.OOBE.ViewModel;
 using Microsoft.PowerToys.Settings.UI.Views;
+using Microsoft.PowerToys.Telemetry;
 using Microsoft.UI.Xaml.Controls;
 using Microsoft.UI.Xaml.Navigation;

@@ -14,9 +16,46 @@ namespace Microsoft.PowerToys.Settings.UI.OOBE.Views
    {
        public OobePowerToysModule ViewModel { get; set; }

+        private bool _enableDataDiagnostics;
+
+        public bool EnableDataDiagnostics
+        {
+            get
+            {
+                return _enableDataDiagnostics;
+            }
+
+            set
+            {
+                if (_enableDataDiagnostics != value)
+                {
+                    _enableDataDiagnostics = value;
+
+                    DataDiagnosticsSettings.SetEnabledValue(_enableDataDiagnostics);
+
+                    this.DispatcherQueue.TryEnqueue(Microsoft.UI.Dispatching.DispatcherQueuePriority.Normal, () =>
+                    {
+                        ShellPage.ShellHandler?.SignalGeneralDataUpdate();
+                    });
+                }
+            }
+        }
+
+        public bool ShowDataDiagnosticsSetting => GetIsDataDiagnosticsInfoBarEnabled();
+
+        private bool GetIsDataDiagnosticsInfoBarEnabled()
+        {
+            var isDataDiagnosticsGpoDisallowed = GPOWrapper.GetAllowDataDiagnosticsValue() == GpoRuleConfigured.Disabled;
+
+            return !isDataDiagnosticsGpoDisallowed;
+        }
+
        public OobeOverview()
        {
            this.InitializeComponent();
+
+            _enableDataDiagnostics = DataDiagnosticsSettings.GetEnabledValue();
+
            ViewModel = new OobePowerToysModule(OobeShellPage.OobeShellHandler.Modules[(int)PowerToysModules.Overview]);
            DataContext = ViewModel;
        }
@@ -31,6 +70,16 @@ namespace Microsoft.PowerToys.Settings.UI.OOBE.Views
            ViewModel.LogOpeningSettingsEvent();
        }

+        private void GeneralSettingsLaunchButton_Click(object sender, Microsoft.UI.Xaml.RoutedEventArgs e)
+        {
+            if (OobeShellPage.OpenMainWindowCallback != null)
+            {
+                OobeShellPage.OpenMainWindowCallback(typeof(GeneralPage));
+            }
+
+            ViewModel.LogOpeningSettingsEvent();
+        }
+
        protected override void OnNavigatedTo(NavigationEventArgs e)
        {
            ViewModel.LogOpeningModuleEvent();
--- a/src/settings-ui/Settings.UI/SettingsXAML/OOBE/Views/OobeWhatsNew.xaml
+++ b/src/settings-ui/Settings.UI/SettingsXAML/OOBE/Views/OobeWhatsNew.xaml
@@ -6,18 +6,66 @@
    xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
    xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
    xmlns:tk7controls="using:CommunityToolkit.WinUI.UI.Controls"
+    xmlns:tkcontrols="using:CommunityToolkit.WinUI.Controls"
+    xmlns:ui="using:CommunityToolkit.WinUI"
    Loaded="Page_Loaded"
    mc:Ignorable="d">


    <Grid Margin="0,24,0,0">
        <Grid.RowDefinitions>
+            <RowDefinition Height="Auto" />
            <RowDefinition Height="Auto" />
            <RowDefinition Height="*" />
        </Grid.RowDefinitions>

+        <tkcontrols:SettingsCard
+            x:Name="WhatsNewDataDiagnosticsInfoBar"
+            x:Uid="Oobe_WhatsNew_DataDiagnostics_InfoBar"
+            Margin="0,-24,0,0"
+            Background="{ThemeResource InfoBarInformationalSeverityBackgroundBrush}"
+            IsTabStop="{x:Bind ShowDataDiagnosticsInfoBar, Mode=OneWay}"
+            Visibility="{x:Bind ShowDataDiagnosticsInfoBar, Mode=OneWay, Converter={StaticResource BoolToVisibilityConverter}}">
+            <tkcontrols:SettingsCard.HeaderIcon>
+                <FontIcon Foreground="{ThemeResource InfoBarInformationalSeverityIconBackground}" Glyph="&#xF167;" />
+            </tkcontrols:SettingsCard.HeaderIcon>
+            <tkcontrols:SettingsCard.Description>
+                <StackPanel>
+                    <TextBlock x:Name="WhatsNewDataDiagnosticsInfoBarDescText">
+                        <Hyperlink NavigateUri="https://aka.ms/powertoys-data-and-privacy-documentation">
+                            <Run x:Uid="Oobe_WhatsNew_DataDiagnostics_InfoBar_Desc" />
+                        </Hyperlink>
+                    </TextBlock>
+                    <TextBlock x:Name="WhatsNewDataDiagnosticsInfoBarDescTextYesClicked" Visibility="Collapsed">
+                        <Run x:Uid="Oobe_WhatsNew_DataDiagnostics_Yes_Click_InfoBar_Desc" />
+                        <Hyperlink Click="DataDiagnostics_OpenSettings_Click">
+                            <Run x:Uid="Oobe_WhatsNew_DataDiagnostics_Yes_Click_OpenSettings_Text" />
+                        </Hyperlink>
+                    </TextBlock>
+                </StackPanel>
+            </tkcontrols:SettingsCard.Description>
+            <StackPanel Orientation="Horizontal" Spacing="8">
+                <Button
+                    x:Name="DataDiagnosticsButtonYes"
+                    x:Uid="Oobe_WhatsNew_DataDiagnostics_Button_Yes"
+                    Click="DataDiagnostics_InfoBar_YesNo_Click"
+                    CommandParameter="Yes" />
+                <HyperlinkButton
+                    x:Name="DataDiagnosticsButtonNo"
+                    x:Uid="Oobe_WhatsNew_DataDiagnostics_Button_No"
+                    Click="DataDiagnostics_InfoBar_YesNo_Click"
+                    CommandParameter="No" />
+                <Button
+                    Margin="16,0,0,0"
+                    Click="DataDiagnostics_InfoBar_Close_Click"
+                    Content="{ui:FontIcon Glyph=&#xE894;,
+                                          FontSize=16}"
+                    Style="{StaticResource SubtleButtonStyle}" />
+            </StackPanel>
+        </tkcontrols:SettingsCard>
+
        <StackPanel
-            Grid.Row="0"
+            Grid.Row="1"
            Margin="32,0,0,16"
            VerticalAlignment="Top"
            Orientation="Vertical">
@@ -33,7 +81,7 @@
        <InfoBar
            x:Name="ErrorInfoBar"
            x:Uid="Oobe_WhatsNew_LoadingError"
-            Grid.Row="1"
+            Grid.Row="2"
            VerticalAlignment="Top"
            IsClosable="False"
            IsOpen="False"
@@ -42,14 +90,14 @@
        <InfoBar
            x:Name="ProxyWarningInfoBar"
            x:Uid="Oobe_WhatsNew_ProxyAuthenticationWarning"
-            Grid.Row="1"
+            Grid.Row="2"
            VerticalAlignment="Top"
            IsClosable="False"
            IsOpen="False"
            IsTabStop="True"
            Severity="Warning" />

-        <ScrollViewer Grid.Row="1" VerticalScrollBarVisibility="Auto">
+        <ScrollViewer Grid.Row="2" VerticalScrollBarVisibility="Auto">
            <Grid Margin="32,24,32,24">
                <ProgressRing
                    x:Name="LoadingProgressRing"
--- a/src/settings-ui/Settings.UI/SettingsXAML/OOBE/Views/OobeWhatsNew.xaml.cs
+++ b/src/settings-ui/Settings.UI/SettingsXAML/OOBE/Views/OobeWhatsNew.xaml.cs
@@ -15,9 +15,13 @@ using System.Text.RegularExpressions;
 using System.Threading.Tasks;

 using CommunityToolkit.WinUI.UI.Controls;
+using global::PowerToys.GPOWrapper;
 using ManagedCommon;
+using Microsoft.PowerToys.Settings.UI.Helpers;
 using Microsoft.PowerToys.Settings.UI.OOBE.Enums;
 using Microsoft.PowerToys.Settings.UI.OOBE.ViewModel;
+using Microsoft.PowerToys.Settings.UI.Views;
+using Microsoft.PowerToys.Telemetry;
 using Microsoft.UI.Xaml.Controls;
 using Microsoft.UI.Xaml.Navigation;

@@ -43,6 +47,8 @@ namespace Microsoft.PowerToys.Settings.UI.OOBE.Views

        public OobePowerToysModule ViewModel { get; set; }

+        public bool ShowDataDiagnosticsInfoBar => GetShowDataDiagnosticsInfoBar();
+
        /// <summary>
        /// Initializes a new instance of the <see cref="OobeWhatsNew"/> class.
        /// </summary>
@@ -53,6 +59,33 @@ namespace Microsoft.PowerToys.Settings.UI.OOBE.Views
            DataContext = ViewModel;
        }

+        private bool GetShowDataDiagnosticsInfoBar()
+        {
+            var isDataDiagnosticsGpoDisallowed = GPOWrapper.GetAllowDataDiagnosticsValue() == GpoRuleConfigured.Disabled;
+
+            if (isDataDiagnosticsGpoDisallowed)
+            {
+                return false;
+            }
+
+            bool userActed = DataDiagnosticsSettings.GetUserActionValue();
+
+            if (userActed)
+            {
+                return false;
+            }
+
+            bool registryValue = DataDiagnosticsSettings.GetEnabledValue();
+
+            bool isFirstRunAfterUpdate = (App.Current as Microsoft.PowerToys.Settings.UI.App).ShowScoobe;
+            if (isFirstRunAfterUpdate && registryValue == false)
+            {
+                return true;
+            }
+
+            return false;
+        }
+
        /// <summary>
        /// Regex to remove installer hash sections from the release notes.
        /// </summary>
@@ -166,5 +199,65 @@ namespace Microsoft.PowerToys.Settings.UI.OOBE.Views
                });
            }
        }
+
+        private void DataDiagnostics_InfoBar_YesNo_Click(object sender, Microsoft.UI.Xaml.RoutedEventArgs e)
+        {
+            string commandArg = string.Empty;
+            if (sender is Button senderBtn)
+            {
+                commandArg = senderBtn.CommandParameter.ToString();
+            }
+            else if (sender is HyperlinkButton senderLink)
+            {
+                commandArg = senderLink.CommandParameter.ToString();
+            }
+
+            if (string.IsNullOrEmpty(commandArg))
+            {
+                return;
+            }
+
+            // Update UI
+            if (commandArg == "Yes")
+            {
+                WhatsNewDataDiagnosticsInfoBar.Header = ResourceLoaderInstance.ResourceLoader.GetString("Oobe_WhatsNew_DataDiagnostics_Yes_Click_InfoBar_Title");
+            }
+            else
+            {
+                WhatsNewDataDiagnosticsInfoBar.Header = ResourceLoaderInstance.ResourceLoader.GetString("Oobe_WhatsNew_DataDiagnostics_No_Click_InfoBar_Title");
+            }
+
+            WhatsNewDataDiagnosticsInfoBarDescText.Visibility = Microsoft.UI.Xaml.Visibility.Collapsed;
+            WhatsNewDataDiagnosticsInfoBarDescTextYesClicked.Visibility = Microsoft.UI.Xaml.Visibility.Visible;
+            DataDiagnosticsButtonYes.Visibility = Microsoft.UI.Xaml.Visibility.Collapsed;
+            DataDiagnosticsButtonNo.Visibility = Microsoft.UI.Xaml.Visibility.Collapsed;
+
+            // Set Data Diagnostics registry values
+            if (commandArg == "Yes")
+            {
+                DataDiagnosticsSettings.SetEnabledValue(true);
+            }
+            else
+            {
+                DataDiagnosticsSettings.SetEnabledValue(false);
+            }
+
+            DataDiagnosticsSettings.SetUserActionValue(true);
+
+            this.DispatcherQueue.TryEnqueue(Microsoft.UI.Dispatching.DispatcherQueuePriority.Normal, () =>
+            {
+                ShellPage.ShellHandler?.SignalGeneralDataUpdate();
+            });
+        }
+
+        private void DataDiagnostics_InfoBar_Close_Click(object sender, Microsoft.UI.Xaml.RoutedEventArgs e)
+        {
+            WhatsNewDataDiagnosticsInfoBar.Visibility = Microsoft.UI.Xaml.Visibility.Collapsed;
+        }
+
+        private void DataDiagnostics_OpenSettings_Click(Microsoft.UI.Xaml.Documents.Hyperlink sender, Microsoft.UI.Xaml.Documents.HyperlinkClickEventArgs args)
+        {
+            Common.UI.SettingsDeepLink.OpenSettings(Common.UI.SettingsDeepLink.SettingsWindow.Overview, true);
+        }
    }
 }
--- a/src/settings-ui/Settings.UI/SettingsXAML/Views/GeneralPage.xaml
+++ b/src/settings-ui/Settings.UI/SettingsXAML/Views/GeneralPage.xaml
@@ -381,6 +381,56 @@
                        IsTabStop="{x:Bind ViewModel.IsExperimentationGpoDisallowed, Mode=OneWay}"
                        Severity="Informational" />
                </controls:SettingsGroup>
+                <controls:SettingsGroup x:Uid="General_DiagnosticsAndFeedback" Visibility="Visible">
+                    <StackPanel>
+                        <HyperlinkButton
+                            x:Uid="GeneralPage_DiagnosticsAndFeedback_Link"
+                            Margin="-8,0,0,0"
+                            NavigateUri="https://aka.ms/powertoys-data-and-privacy-documentation" />
+                        <tkcontrols:SettingsCard
+                            x:Uid="GeneralPage_EnableDataDiagnostics"
+                            HeaderIcon="{ui:FontIcon Glyph=&#xE9D9;}"
+                            IsEnabled="{x:Bind ViewModel.IsDataDiagnosticsGPOManaged, Mode=OneWay, Converter={StaticResource BoolNegationConverter}}">
+                            <ToggleSwitch x:Uid="ToggleSwitch" IsOn="{x:Bind ViewModel.EnableDataDiagnostics, Mode=TwoWay}" />
+                        </tkcontrols:SettingsCard>
+                        <tkcontrols:SettingsExpander
+                            x:Uid="GeneralPage_ViewDiagnosticData"
+                            HeaderIcon="{ui:FontIcon Glyph=&#xE7EF;}"
+                            IsEnabled="{x:Bind ViewModel.IsDataDiagnosticsGPOManaged, Mode=OneWay, Converter={StaticResource BoolNegationConverter}}"
+                            IsExpanded="True">
+                            <tkcontrols:SettingsExpander.Items>
+                                <tkcontrols:SettingsCard x:Uid="GeneralPage_EnableViewDiagnosticData">
+                                    <ToggleSwitch
+                                        x:Uid="ToggleSwitch"
+                                        IsEnabled="{x:Bind ViewModel.EnableDataDiagnostics, Mode=TwoWay}"
+                                        IsOn="{x:Bind ViewModel.EnableViewDataDiagnostics, Mode=TwoWay}" />
+                                </tkcontrols:SettingsCard>
+                                <tkcontrols:SettingsCard
+                                    x:Uid="GeneralPage_ViewDiagnosticDataViewer"
+                                    ActionIcon="{ui:FontIcon Glyph=&#xE8A7;}"
+                                    Click="ViewDiagnosticData_Click"
+                                    IsClickEnabled="True" />
+                            </tkcontrols:SettingsExpander.Items>
+                        </tkcontrols:SettingsExpander>
+                        <InfoBar
+                            x:Uid="GeneralPage_ViewDiagnosticDataViewerInfo"
+                            IsClosable="False"
+                            IsOpen="{x:Bind Mode=OneWay, Path=ViewModel.ViewDiagnosticDataViewerChanged}"
+                            IsTabStop="{x:Bind Mode=OneWay, Path=ViewModel.ViewDiagnosticDataViewerChanged}"
+                            Severity="Informational">
+                            <InfoBar.ActionButton>
+                                <Button x:Uid="GeneralPage_ViewDiagnosticDataViewerInfoButton" Click="Click_ViewDiagnosticDataViewerRestart" />
+                            </InfoBar.ActionButton>
+                        </InfoBar>
+                        <InfoBar
+                            x:Uid="GPO_SettingIsManaged"
+                            IsClosable="False"
+                            IsOpen="{x:Bind ViewModel.IsDataDiagnosticsGPOManaged, Mode=OneWay}"
+                            IsTabStop="{x:Bind ViewModel.IsDataDiagnosticsGPOManaged, Mode=OneWay}"
+                            Severity="Informational" />
+
+                    </StackPanel>
+                </controls:SettingsGroup>
            </StackPanel>

        </controls:SettingsPageControl.ModuleContent>
--- a/src/settings-ui/Settings.UI/SettingsXAML/Views/GeneralPage.xaml.cs
+++ b/src/settings-ui/Settings.UI/SettingsXAML/Views/GeneralPage.xaml.cs
@@ -18,7 +18,7 @@ namespace Microsoft.PowerToys.Settings.UI.Views
    /// <summary>
    /// General Settings Page.
    /// </summary>
-    public sealed partial class GeneralPage : Page
+    public sealed partial class GeneralPage : Page, IRefreshablePage
    {
        private static DateTime OkToHideBackupAndRestoreMessageTime { get; set; }

@@ -99,6 +99,18 @@ namespace Microsoft.PowerToys.Settings.UI.Views
            }
        }

+        private void OpenDiagnosticsAndFeedbackSettings_Click(object sender, RoutedEventArgs e)
+        {
+            try
+            {
+                Helpers.StartProcessHelper.Start(Helpers.StartProcessHelper.DiagnosticsAndFeedback);
+            }
+            catch (Exception ex)
+            {
+                Logger.LogError("Error while trying to open the system Diagnostics & Feedback settings", ex);
+            }
+        }
+
        private void RefreshBackupRestoreStatus(int delayMs = 0)
        {
            Task.Run(() =>
@@ -136,5 +148,20 @@ namespace Microsoft.PowerToys.Settings.UI.Views
        {
            ViewModel.Restart();
        }
+
+        private void Click_ViewDiagnosticDataViewerRestart(object sender, RoutedEventArgs e)
+        {
+            ViewModel.Restart();
+        }
+
+        public void RefreshEnabledState()
+        {
+            ViewModel.RefreshSettingsOnExternalChange();
+        }
+
+        private void ViewDiagnosticData_Click(object sender, RoutedEventArgs e)
+        {
+            ViewModel.ViewDiagnosticData();
+        }
    }
 }