summaryrefslogtreecommitdiffstats
path: root/toolkit/components/cookiebanners/metrics.yaml
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 19:33:14 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 19:33:14 +0000
commit36d22d82aa202bb199967e9512281e9a53db42c9 (patch)
tree105e8c98ddea1c1e4784a60a5a6410fa416be2de /toolkit/components/cookiebanners/metrics.yaml
parentInitial commit. (diff)
downloadfirefox-esr-36d22d82aa202bb199967e9512281e9a53db42c9.tar.xz
firefox-esr-36d22d82aa202bb199967e9512281e9a53db42c9.zip
Adding upstream version 115.7.0esr.upstream/115.7.0esr
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'toolkit/components/cookiebanners/metrics.yaml')
-rw-r--r--toolkit/components/cookiebanners/metrics.yaml239
1 files changed, 239 insertions, 0 deletions
diff --git a/toolkit/components/cookiebanners/metrics.yaml b/toolkit/components/cookiebanners/metrics.yaml
new file mode 100644
index 0000000000..e8db788378
--- /dev/null
+++ b/toolkit/components/cookiebanners/metrics.yaml
@@ -0,0 +1,239 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+# Adding a new metric? We have docs for that!
+# https://firefox-source-docs.mozilla.org/toolkit/components/glean/user/new_definitions_file.html
+
+---
+$schema: moz://mozilla.org/schemas/glean/metrics/2-0-0
+$tags:
+ - 'Core :: Privacy: Anti-Tracking'
+
+cookie.banners:
+ normal_window_service_mode:
+ type: labeled_boolean
+ description: >
+ The pref value of the cookie banner service mode for normal windows.
+ bugs:
+ - https://bugzilla.mozilla.org/1797081
+ - https://bugzilla.mozilla.org/1804259
+ data_reviews:
+ - https://bugzilla.mozilla.org/show_bug.cgi?id=1797081#c3
+ notification_emails:
+ - tihuang@mozilla.com
+ - pbz@mozilla.com
+ expires: never
+ labels:
+ - disabled
+ - reject
+ - reject_or_accept
+ - invalid
+ telemetry_mirror: COOKIE_BANNERS_NORMAL_WINDOW_SERVICE_MODE
+ private_window_service_mode:
+ type: labeled_boolean
+ description: >
+ The pref value of the cookie banner service mode for private windows.
+ bugs:
+ - https://bugzilla.mozilla.org/1797081
+ - https://bugzilla.mozilla.org/1804259
+ data_reviews:
+ - https://bugzilla.mozilla.org/show_bug.cgi?id=1797081#c3
+ notification_emails:
+ - tihuang@mozilla.com
+ - pbz@mozilla.com
+ expires: never
+ labels:
+ - disabled
+ - reject
+ - reject_or_accept
+ - invalid
+ telemetry_mirror: COOKIE_BANNERS_PRIVATE_WINDOW_SERVICE_MODE
+ service_detect_only:
+ type: boolean
+ description: >
+ Tracks the value of the cookiebanners.service.detectOnly pref.
+ bugs:
+ - https://bugzilla.mozilla.org/1809700
+ data_reviews:
+ - https://bugzilla.mozilla.org/show_bug.cgi?id=1809700#c3
+ notification_emails:
+ - tihuang@mozilla.com
+ - pbz@mozilla.com
+ expires: never
+ telemetry_mirror: COOKIE_BANNERS_SERVICE_DETECT_ONLY
+ rule_lookup_by_load:
+ type: labeled_counter
+ description: >
+ Counts the number of hit/miss of cookie banner rule lookups for every
+ load. We collect three types of counters, including counters for overall
+ rule lookup, counters for cookie rule lookup and counters for click rule
+ lookup. We also divide the counter by top-level loads and iframe loads.
+ bugs:
+ - https://bugzilla.mozilla.org/1797073
+ - https://bugzilla.mozilla.org/1804259
+ - https://bugzilla.mozilla.org/1827765
+ data_reviews:
+ - https://bugzilla.mozilla.org/show_bug.cgi?id=1797073#c6
+ - https://bugzilla.mozilla.org/show_bug.cgi?id=1827765#c9
+ data_sensitivity:
+ - interaction
+ notification_emails:
+ - tihuang@mozilla.com
+ - pbz@mozilla.com
+ expires: 120
+ labels:
+ - top_hit
+ - top_hit_opt_in
+ - top_hit_opt_out
+ - top_miss
+ - iframe_hit
+ - iframe_hit_opt_in
+ - iframe_hit_opt_out
+ - iframe_miss
+ - top_cookie_hit
+ - top_cookie_hit_opt_in
+ - top_cookie_hit_opt_out
+ - top_cookie_miss
+ - iframe_cookie_hit
+ - iframe_cookie_hit_opt_in
+ - iframe_cookie_hit_opt_out
+ - iframe_cookie_miss
+ - top_click_hit
+ - top_click_hit_opt_in
+ - top_click_hit_opt_out
+ - top_click_miss
+ - iframe_click_hit
+ - iframe_click_hit_opt_in
+ - iframe_click_hit_opt_out
+ - iframe_click_miss
+ telemetry_mirror: COOKIE_BANNERS_RULE_LOOKUP_BY_LOAD
+ rule_lookup_by_domain:
+ type: labeled_counter
+ description: >
+ Counts the number of hit/miss of cookie banner rule lookups for domain.
+ We collect three types of counters, including counters for overall
+ rule lookup, counters for cookie rule lookup and counters for click rule
+ lookup. We also divide the counter by top-level loads and iframe loads.
+ For each domain, we will only collect once.
+ bugs:
+ - https://bugzilla.mozilla.org/1797073
+ - https://bugzilla.mozilla.org/1804259
+ - https://bugzilla.mozilla.org/1827765
+ data_reviews:
+ - https://bugzilla.mozilla.org/show_bug.cgi?id=1797073#c6
+ - https://bugzilla.mozilla.org/show_bug.cgi?id=1827765#c9
+ data_sensitivity:
+ - interaction
+ notification_emails:
+ - tihuang@mozilla.com
+ - pbz@mozilla.com
+ expires: 120
+ labels:
+ - top_hit
+ - top_hit_opt_in
+ - top_hit_opt_out
+ - top_miss
+ - iframe_hit
+ - iframe_hit_opt_in
+ - iframe_hit_opt_out
+ - iframe_miss
+ - top_cookie_hit
+ - top_cookie_hit_opt_in
+ - top_cookie_hit_opt_out
+ - top_cookie_miss
+ - iframe_cookie_hit
+ - iframe_cookie_hit_opt_in
+ - iframe_cookie_hit_opt_out
+ - iframe_cookie_miss
+ - top_click_hit
+ - top_click_hit_opt_in
+ - top_click_hit_opt_out
+ - top_click_miss
+ - iframe_click_hit
+ - iframe_click_hit_opt_in
+ - iframe_click_hit_opt_out
+ - iframe_click_miss
+ telemetry_mirror: COOKIE_BANNERS_RULE_LOOKUP_BY_DOMAIN
+ reload:
+ type: event
+ description: >
+ Recorded when the top-level page is reloaded. We use this event metric to
+ know whether or not the reloading domain has cookie banner rule.
+ bugs:
+ - https://bugzilla.mozilla.org/1797079
+ - https://bugzilla.mozilla.org/1827765
+ data_reviews:
+ - https://bugzilla.mozilla.org/show_bug.cgi?id=1797079#c6
+ - https://bugzilla.mozilla.org/show_bug.cgi?id=1827765#c9
+ notification_emails:
+ - pbz@mozilla.com
+ - tihuang@mozilla.com
+ expires: 120
+ data_sensitivity:
+ - interaction
+ extra_keys:
+ no_rule:
+ description: There is no cookie banner rule for the reloading domain.
+ type: boolean
+ has_cookie_rule:
+ description: There is a matching cookie rule for the reloading domain.
+ type: boolean
+ has_click_rule:
+ description: There is a matching click rule for the reloading domain.
+ type: boolean
+ telemetry_mirror: Cookie_banner_Reload_Browser
+cookie.banners.click:
+ handle_duration:
+ type: timing_distribution
+ time_unit: millisecond
+ description: >
+ Counts how long it takes to handle cookie banners successfully from
+ DOMContentLoaded until click.
+ bugs:
+ - https://bugzilla.mozilla.org/1797078
+ - https://bugzilla.mozilla.org/1804259
+ - https://bugzilla.mozilla.org/1827765
+ data_reviews:
+ - https://bugzilla.mozilla.org/show_bug.cgi?id=1797078#c6
+ - https://bugzilla.mozilla.org/show_bug.cgi?id=1827765#c9
+ notification_emails:
+ - pbz@mozilla.com
+ - tihuang@mozilla.com
+ expires: 120
+ telemetry_mirror: COOKIE_BANNERS_CLICK_HANDLE_DURATION_MS
+ # TODO: consider moving this out of "click". It also records cookie injection.
+ result:
+ type: labeled_counter
+ description: >
+ Given a matching cookie banner rule, how often do we handle or fail to
+ handle cookie banners, labelled by reason. The 'success' and 'fail'
+ counters count the total numbers independently of the reason counters.
+ Counters are incremented after the content window has been destroyed. This
+ metric additionally reports cookie injections after which we didn't see a
+ banner as "success_cookie_injected".
+ bugs:
+ - https://bugzilla.mozilla.org/1797078
+ - https://bugzilla.mozilla.org/1804259
+ - https://bugzilla.mozilla.org/1821738
+ - https://bugzilla.mozilla.org/1827765
+ data_reviews:
+ - https://bugzilla.mozilla.org/show_bug.cgi?id=1797078#c6
+ - https://bugzilla.mozilla.org/show_bug.cgi?id=1827765#c9
+ notification_emails:
+ - pbz@mozilla.com
+ - tihuang@mozilla.com
+ expires: 120
+ labels:
+ - success
+ - success_cookie_injected
+ - success_dom_content_loaded
+ - success_mutation_pre_load
+ - success_mutation_post_load
+ - fail
+ - fail_banner_not_found
+ - fail_banner_not_visible
+ - fail_button_not_found
+ - fail_no_rule_for_mode
+ - fail_actor_destroyed
+ telemetry_mirror: COOKIE_BANNERS_CLICK_RESULT