Bug 1943650 - Command-line --help output misformatted after --dbus-service. r=emilio
[gecko.git] / toolkit / components / antitracking / bouncetrackingprotection / metrics.yaml
blob9e324c4d6650c459c533b2747a16cfd12302831d
1 # This Source Code Form is subject to the terms of the Mozilla Public
2 # License, v. 2.0. If a copy of the MPL was not distributed with this
3 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
5 # Adding a new metric? We have docs for that!
6 # https://firefox-source-docs.mozilla.org/toolkit/components/glean/user/new_definitions_file.html
8 ---
9 $schema: moz://mozilla.org/schemas/glean/metrics/2-0-0
10 $tags:
11   - 'Core :: Privacy: Anti-Tracking'
13 bounce.tracking.protection:
14   purge_duration:
15     type: timing_distribution
16     description: >
17       For every purge that is scheduled, we call the ClearDataService to
18       purge persistent storage for each detected bounce tracker. This may
19       do some blocking work on main thread and dispatch some cleanups to
20       other threads.
21       Collect telemetry on how long it takes to clear in the wild to
22       determine whether we need to improve performance here.
23     bugs:
24       - https://bugzilla.mozilla.org/show_bug.cgi?id=1890582
25       - https://bugzilla.mozilla.org/show_bug.cgi?id=1922601
26     data_reviews:
27       - https://bugzilla.mozilla.org/show_bug.cgi?id=1890582#c4
28     data_sensitivity:
29       - technical
30     notification_emails:
31       - emz@mozilla.com
32       - bvandersloot@mozilla.com
33       - manuel@mozilla.com
34     expires: 140
35   num_hosts_per_purge_run:
36     type: custom_distribution
37     unit: integer
38     range_min: 1
39     range_max: 99
40     bucket_count: 100
41     histogram_type: linear
42     description: >
43       Number of bounce trackers purged successfully per scheduled purge.
44     bugs:
45       - https://bugzilla.mozilla.org/show_bug.cgi?id=1899809
46       - https://bugzilla.mozilla.org/show_bug.cgi?id=1922601
47     data_reviews:
48       - https://bugzilla.mozilla.org/show_bug.cgi?id=1899809
49     data_sensitivity:
50       - technical
51     notification_emails:
52       - emz@mozilla.com
53       - bvandersloot@mozilla.com
54       - manuel@mozilla.com
55     expires: 140
56   purge_count:
57     type: labeled_counter
58     description: >
59       Counts how often we purge trackers. Giving a high level overview about
60       the effectivness of bounce tracking protection. Allows determining error
61       rate with failure/success label. When in dry mode, we count the purges
62       that would have happened under the dry label.
63     bugs:
64       - https://bugzilla.mozilla.org/show_bug.cgi?id=1890578
65       - https://bugzilla.mozilla.org/show_bug.cgi?id=1922601
66     data_reviews:
67       - https://bugzilla.mozilla.org/show_bug.cgi?id=1890578
68     data_sensitivity:
69       - technical
70     notification_emails:
71       - emz@mozilla.com
72       - bvandersloot@mozilla.com
73       - manuel@mozilla.com
74     expires: 140
75     labels:
76       - success
77       - failure
78       - dry
79   purge_action:
80     type: event
81     description: >
82       Dispatched whenever a bounce tracker site is purged.
83     bugs:
84       - https://bugzilla.mozilla.org/1889444
85       - https://bugzilla.mozilla.org/1922602
86     data_reviews:
87       - https://bugzilla.mozilla.org/show_bug.cgi?id=1889444#c16
88     data_sensitivity:
89       - stored_content
90     notification_emails:
91       - emz@mozilla.com
92       - bvandersloot@mozilla.com
93       - manuel@mozilla.com
94     send_in_pings:
95       - bounce-tracking-protection
96     expires: 140
97     extra_keys:
98       site_host:
99         description: The site host of which the data has been purged.
100         type: string
101       bounce_time:
102         description: Timestamp (seconds since epoch) of the last detected bounce.
103         type: quantity
104       is_dry_run:
105         description: Whether we just pretended to purge since the client is in dry-run mode.
106         type: boolean
107       success:
108         description: Whether the purge data call was successful. false indicates an error in ClearDataService.
109         type: boolean
110   mode:
111     type: quantity
112     lifetime: application
113     unit: intPref
114     description: >
115       Records the pref value of privacy.bounceTrackingProtection.mode. Values
116       are any of nsIBounceTrackingProtection#Modes.
117     bugs:
118       - https://bugzilla.mozilla.org/show_bug.cgi?id=1928062
119     data_reviews:
120       - https://bugzilla.mozilla.org/show_bug.cgi?id=1928062
121     data_sensitivity:
122       - technical
123     notification_emails:
124       - emz@mozilla.com
125       - bvandersloot@mozilla.com
126       - manuel@mozilla.com
127     expires: 140
128   purge_count_classified_tracker:
129     type: counter
130     description: >
131       Counts sites purged from BTP that are classified as trackers as part of the following lists:
132       [emailtracking-protection, fingerprinting-protection, socialtracking-protection, tracking-protection]
133     bugs:
134       - https://bugzilla.mozilla.org/show_bug.cgi?id=1890580
135       - https://bugzilla.mozilla.org/show_bug.cgi?id=1922601
136     data_reviews:
137       - https://bugzilla.mozilla.org/show_bug.cgi?id=1890580
138     data_sensitivity:
139       - technical
140     notification_emails:
141       - emz@mozilla.com
142       - bvandersloot@mozilla.com
143       - manuel@mozilla.com
144     expires: 140