[User Education] Meta-histograms never expire

Meta-histograms instantiated for individual promos, "New" Badges, tutorials, and "What's New" page modules should not expire, as the roster of promos, badges, tutorials, and modules changes from release to release and the feature teams rolling out those promotional items need to be able to track their performance. In addition, certain overall health metrics which could be affected by changes in the active promos and modules should continue to be tracked indefinitely, as these can change drastically with the profile of active promotions from milestone to milestone. Change-Id: I83e9048f31fe3ac6367705bdc707885182160c58 Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/5980389 Commit-Queue: Dana Fried <dfried@chromium.org> Reviewed-by: Mark Pearson <mpearson@chromium.org> Cr-Commit-Position: refs/heads/main@{#1376676}
blueboxd · Nov 5, 2024 · b3526ca · b3526ca
1 parent 1db047c
commit b3526ca
Show file tree

Hide file tree

Showing 2 changed files with 124 additions and 22 deletions.
diff --git a/tools/metrics/histograms/metadata/feature_engagement/histograms.xml b/tools/metrics/histograms/metadata/feature_engagement/histograms.xml
@@ -757,16 +757,26 @@ In the future, Desktop IPH may be completely moved to the user_education folder.
 
 -->
 
+<!-- expires-never: this is a meta-histogram that provides performance
+     information about each feature promo as it rolls out to users. Since new
+     promos roll out all the time, and feature teams want to track the
+     performance of their promos, this histogram must never expire. -->
+
 <histogram name="UserEducation.MessageAction.{IPHFeature}" enum="MessageAction"
-    expires_after="2025-04-30">
+    expires_after="never">
   <owner>mickeyburks@chromium.org</owner>
   <owner>frizzle-team@google.com</owner>
   <summary>Records what action was taken to close the In-Product Help.</summary>
   <token key="IPHFeature" variants="IPHFeature"/>
 </histogram>
 
+<!-- expires-never: this is a meta-histogram that provides performance
+     information about each feature promo as it rolls out to users. Since new
+     promos roll out all the time, and feature teams want to track the
+     performance of their promos, this histogram must never expire. -->
+
 <histogram name="UserEducation.MessageNotShown.{IPHFeature}"
-    enum="PromoFailure" expires_after="2025-04-30">
+    enum="PromoFailure" expires_after="never">
   <owner>mickeyburks@chromium.org</owner>
   <owner>frizzle-team@google.com</owner>
   <summary>
@@ -778,8 +788,13 @@ In the future, Desktop IPH may be completely moved to the user_education folder.
   <token key="IPHFeature" variants="IPHFeature"/>
 </histogram>
 
+<!-- expires-never: this is a meta-histogram that provides performance
+     information about rotating feature promos as they roll out to users. Since
+     new promos roll out all the time, and feature teams want to track the
+     performance of their promos, this histogram must never expire. -->
+
 <histogram name="UserEducation.RotatingPromoIndex.{IPHFeature}" units="Index"
-    expires_after="2025-04-30">
+    expires_after="never">
   <owner>dfried@chromium.org</owner>
   <owner>frizzle-team@google.com</owner>
   <summary>

diff --git a/tools/metrics/histograms/metadata/user_education/histograms.xml b/tools/metrics/histograms/metadata/user_education/histograms.xml
@@ -105,8 +105,12 @@ chromium-metrics-reviews@google.com.
   </summary>
 </histogram>
 
+<!-- expires-never: this is a meta-histogram for tracking the performance of
+     individual tutorials. Since tutorials are periodically added, this cannot
+     be allowed to expire. -->
+
 <histogram name="Tutorial.{TutorialID}.AbortStep" units="int"
-    expires_after="2025-04-30">
+    expires_after="never">
   <owner>dpenning@chromium.org</owner>
   <owner>dfried@chromium.org</owner>
   <summary>
@@ -116,8 +120,12 @@ chromium-metrics-reviews@google.com.
   <token key="TutorialID" variants="TutorialID"/>
 </histogram>
 
+<!-- expires-never: this is a meta-histogram for tracking the performance of
+     individual tutorials. Since tutorials are periodically added, this cannot
+     be allowed to expire. -->
+
 <histogram name="Tutorial.{TutorialID}.Completion" enum="BooleanSuccess"
-    expires_after="2025-04-30">
+    expires_after="never">
   <owner>dpenning@chromium.org</owner>
   <owner>dfried@chromium.org</owner>
   <summary>
@@ -127,8 +135,12 @@ chromium-metrics-reviews@google.com.
   <token key="TutorialID" variants="TutorialID"/>
 </histogram>
 
+<!-- expires-never: this is a meta-histogram for tracking the performance of
+     individual tutorials. Since tutorials are periodically added, this cannot
+     be allowed to expire. -->
+
 <histogram name="Tutorial.{TutorialID}.IPHLinkClicked" enum="BooleanSuccess"
-    expires_after="2025-04-30">
+    expires_after="never">
   <owner>dpenning@chromium.org</owner>
   <owner>dfried@chromium.org</owner>
   <summary>
@@ -139,8 +151,12 @@ chromium-metrics-reviews@google.com.
   <token key="TutorialID" variants="TutorialID"/>
 </histogram>
 
+<!-- expires-never: this is a meta-histogram for tracking the performance of
+     individual tutorials. Since tutorials are periodically added, this cannot
+     be allowed to expire. -->
+
 <histogram name="Tutorial.{TutorialID}.StartedFromWhatsNewPage"
-    enum="BooleanSuccess" expires_after="2025-04-30">
+    enum="BooleanSuccess" expires_after="never">
   <owner>dpenning@chromium.org</owner>
   <owner>dfried@chromium.org</owner>
   <summary>
@@ -189,8 +205,13 @@ chromium-metrics-reviews@google.com.
   </summary>
 </histogram>
 
+<!-- expires-never: this histogram provides general telemetry about the
+     performance of active promos in the User Education system. Because the
+     roster of promos changes from release to release this metric must be
+     tracked as a measure of the current health of the promo ecosystem. -->
+
 <histogram name="UserEducation.MessageShown.Subtype" enum="PromoSubtype"
-    expires_after="2025-04-30">
+    expires_after="never">
   <owner>mickeyburks@chromium.org</owner>
   <owner>frizzle-team@google.com</owner>
   <summary>
@@ -201,8 +222,13 @@ chromium-metrics-reviews@google.com.
   </summary>
 </histogram>
 
+<!-- expires-never: this histogram provides general telemetry about the
+     performance of active promos in the User Education system. Because the
+     roster of promos changes from release to release this metric must be
+     tracked as a measure of the current health of the promo ecosystem. -->
+
 <histogram name="UserEducation.MessageShown.Type" enum="PromoType"
-    expires_after="2025-04-30">
+    expires_after="never">
   <owner>mickeyburks@chromium.org</owner>
   <owner>frizzle-team@google.com</owner>
   <summary>
@@ -212,8 +238,13 @@ chromium-metrics-reviews@google.com.
   </summary>
 </histogram>
 
+<!-- expires-never: this is a meta-histogram providing telemetry for "New"
+     Badges, which are periodically added and removed as new features are added
+     to the browser. If it expires, telemetry for new "New" Badges will no
+     longer be collected. -->
+
 <histogram name="UserEducation.NewBadge.{NewBadgeFeature}.MaxShownReached"
-    enum="BooleanCompleted" expires_after="2025-04-30">
+    enum="BooleanCompleted" expires_after="never">
   <owner>dfried@chromium.org</owner>
   <owner>frizzle-team@google.com</owner>
   <summary>
@@ -225,8 +256,13 @@ chromium-metrics-reviews@google.com.
   <token key="NewBadgeFeature" variants="NewBadgeFeature"/>
 </histogram>
 
+<!-- expires-never: this is a meta-histogram providing telemetry for "New"
+     Badges, which are periodically added and removed as new features are added
+     to the browser. If it expires, telemetry for new "New" Badges will no
+     longer be collected. -->
+
 <histogram name="UserEducation.NewBadge.{NewBadgeFeature}.MaxUsedReached"
-    enum="BooleanCompleted" expires_after="2025-04-30">
+    enum="BooleanCompleted" expires_after="never">
   <owner>dfried@chromium.org</owner>
   <owner>frizzle-team@google.com</owner>
   <summary>
@@ -357,8 +393,12 @@ chromium-metrics-reviews@google.com.
   </summary>
 </histogram>
 
+<!-- expires-never: since the content of the "What's New" page changes from
+     release to release, this is an important health metric for the performance
+     of any particular release. It should not be allowed to expire. -->
+
 <histogram name="UserEducation.WhatsNew.ExploreMoreExpanded"
-    enum="BooleanYesNo" expires_after="2025-04-30">
+    enum="BooleanYesNo" expires_after="never">
   <owner>mickeyburks@chromium.org</owner>
   <owner>frizzle-team@google.com</owner>
   <summary>
@@ -367,8 +407,13 @@ chromium-metrics-reviews@google.com.
   </summary>
 </histogram>
 
+<!-- expires-never: this is a meta-histogram that provides performance data for
+     "What's New" page modules. Since the modules change every release, this
+     cannot be allowed to expire or no telemetry would be returned for new
+     modules. -->
+
 <histogram name="UserEducation.WhatsNew.ModuleLinkClicked.{ModuleName}"
-    enum="WhatsNewModulePosition" expires_after="2025-04-30">
+    enum="WhatsNewModulePosition" expires_after="never">
   <owner>mickeyburks@chromium.org</owner>
   <owner>frizzle-team@google.com</owner>
   <summary>
@@ -378,8 +423,13 @@ chromium-metrics-reviews@google.com.
   <token key="ModuleName" variants="WhatsNewModule"/>
 </histogram>
 
+<!-- expires-never: this is a meta-histogram that provides performance data for
+     "What's New" page modules. Since the modules change every release, this
+     cannot be allowed to expire or no telemetry would be returned for new
+     modules. -->
+
 <histogram name="UserEducation.WhatsNew.ModuleShown.{ModuleName}"
-    enum="WhatsNewModulePosition" expires_after="2025-04-30">
+    enum="WhatsNewModulePosition" expires_after="never">
   <owner>mickeyburks@chromium.org</owner>
   <owner>frizzle-team@google.com</owner>
   <summary>
@@ -389,8 +439,13 @@ chromium-metrics-reviews@google.com.
   <token key="ModuleName" variants="WhatsNewModule"/>
 </histogram>
 
+<!-- expires-never: this is a meta-histogram that provides performance data for
+     "What's New" page modules. Since the modules change every release, this
+     cannot be allowed to expire or no telemetry would be returned for new
+     modules. -->
+
 <histogram name="UserEducation.WhatsNew.PauseClicked.{ModuleName}"
-    enum="WhatsNewModulePosition" expires_after="2025-04-30">
+    enum="WhatsNewModulePosition" expires_after="never">
   <owner>mickeyburks@chromium.org</owner>
   <owner>frizzle-team@google.com</owner>
   <summary>
@@ -401,8 +456,13 @@ chromium-metrics-reviews@google.com.
   <token key="ModuleName" variants="WhatsNewModule"/>
 </histogram>
 
+<!-- expires-never: this is a meta-histogram that provides performance data for
+     "What's New" page modules. Since the modules change every release, this
+     cannot be allowed to expire or no telemetry would be returned for new
+     modules. -->
+
 <histogram name="UserEducation.WhatsNew.PlayClicked.{ModuleName}"
-    enum="WhatsNewModulePosition" expires_after="2025-04-30">
+    enum="WhatsNewModulePosition" expires_after="never">
   <owner>mickeyburks@chromium.org</owner>
   <owner>frizzle-team@google.com</owner>
   <summary>
@@ -413,8 +473,13 @@ chromium-metrics-reviews@google.com.
   <token key="ModuleName" variants="WhatsNewModule"/>
 </histogram>
 
+<!-- expires-never: this is a meta-histogram that provides performance data for
+     "What's New" page modules. Since the modules change every release, this
+     cannot be allowed to expire or no telemetry would be returned for new
+     modules. -->
+
 <histogram name="UserEducation.WhatsNew.RestartClicked.{ModuleName}"
-    enum="WhatsNewModulePosition" expires_after="2025-04-30">
+    enum="WhatsNewModulePosition" expires_after="never">
   <owner>mickeyburks@chromium.org</owner>
   <owner>frizzle-team@google.com</owner>
   <summary>
@@ -425,8 +490,12 @@ chromium-metrics-reviews@google.com.
   <token key="ModuleName" variants="WhatsNewModule"/>
 </histogram>
 
+<!-- expires-never: this provides usage information about a specific edition of
+     the "What's New" page. However, since the content on the page changes every
+     edition, this histogram cannot be allowed to expire. -->
+
 <histogram name="UserEducation.WhatsNew.ScrollDepth" enum="ScrollDepthQuartile"
-    expires_after="2025-04-30">
+    expires_after="never">
   <owner>mickeyburks@chromium.org</owner>
   <owner>frizzle-team@google.com</owner>
   <summary>
@@ -435,8 +504,12 @@ chromium-metrics-reviews@google.com.
   </summary>
 </histogram>
 
+<!-- expires-never: this provides usage information about a specific edition of
+     the "What's New" page. However, since the content on the page changes every
+     edition, this histogram cannot be allowed to expire. -->
+
 <histogram name="UserEducation.WhatsNew.TimeOnPage" units="ms"
-    expires_after="2025-04-30">
+    expires_after="never">
   <owner>mickeyburks@chromium.org</owner>
   <owner>frizzle-team@google.com</owner>
   <summary>
@@ -445,8 +518,12 @@ chromium-metrics-reviews@google.com.
   </summary>
 </histogram>
 
+<!-- expires-never: this provides performance information about a specific
+     edition of the "What's New" page. However, since the content on the page
+     changes every edition, this histogram cannot be allowed to expire. -->
+
 <histogram name="UserEducation.WhatsNew.TimeToLoadContent" units="ms"
-    expires_after="2025-04-30">
+    expires_after="never">
   <owner>mickeyburks@chromium.org</owner>
   <owner>frizzle-team@google.com</owner>
   <summary>
@@ -455,8 +532,13 @@ chromium-metrics-reviews@google.com.
   </summary>
 </histogram>
 
+<!-- expires-never: this is a meta-histogram that provides performance data for
+     "What's New" page modules. Since the modules change every release, this
+     cannot be allowed to expire or no telemetry would be returned for new
+     modules. -->
+
 <histogram name="UserEducation.WhatsNew.VideoEnded.{ModuleName}"
-    enum="WhatsNewModulePosition" expires_after="2025-04-30">
+    enum="WhatsNewModulePosition" expires_after="never">
   <owner>mickeyburks@chromium.org</owner>
   <owner>frizzle-team@google.com</owner>
   <summary>
@@ -466,8 +548,13 @@ chromium-metrics-reviews@google.com.
   <token key="ModuleName" variants="WhatsNewModule"/>
 </histogram>
 
+<!-- expires-never: this is a meta-histogram that provides performance data for
+     "What's New" page modules. Since the modules change every release, this
+     cannot be allowed to expire or no telemetry would be returned for new
+     modules. -->
+
 <histogram name="UserEducation.WhatsNew.VideoStarted.{ModuleName}"
-    enum="WhatsNewModulePosition" expires_after="2025-04-30">
+    enum="WhatsNewModulePosition" expires_after="never">
   <owner>mickeyburks@chromium.org</owner>
   <owner>frizzle-team@google.com</owner>
   <summary>