summaryrefslogtreecommitdiffstats
path: root/toolkit/components/telemetry/UserInteractions.yaml
diff options
context:
space:
mode:
Diffstat (limited to 'toolkit/components/telemetry/UserInteractions.yaml')
-rw-r--r--toolkit/components/telemetry/UserInteractions.yaml37
1 files changed, 37 insertions, 0 deletions
diff --git a/toolkit/components/telemetry/UserInteractions.yaml b/toolkit/components/telemetry/UserInteractions.yaml
new file mode 100644
index 0000000000..1005172038
--- /dev/null
+++ b/toolkit/components/telemetry/UserInteractions.yaml
@@ -0,0 +1,37 @@
+# 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/.
+
+# This file contains a definition of the UserInteractions that are recorded in
+# Telemetry via BHR.
+#
+# They are submitted as annotations with the "bhr" pings and can be inspected
+# in about:telemetry.
+#
+# These UserInteraction entries are subject to Data Collection Review. Do not
+# add or modify any of these entries without data-review+ from a Data Steward.
+#
+# Please attempt to keep the categories and UserInteraction names in
+# alphabetical order.
+#
+# Definitions
+# -----------
+# A UserInteraction definition looks like this:
+#
+# category: <category name> # mandatory
+# name: <interaction name> # mandatory
+# description: <description of user interaction> # mandatory
+# bug_numbers: [<list of bug numbers>] # mandatory
+#
+# Precise documentation for UserInteractions can be found at
+# https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/collection/user-interactions.html
+
+browser.tabs:
+ opening:
+ description: A new tab is being opened.
+ bug_numbers: [1662160]
+
+testing:
+ interaction:
+ description: A user interaction just for testing.
+ bug_numbers: [1661304]