608 lines
15 KiB
YAML
608 lines
15 KiB
YAML
# 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 :: Machine Learning"
|
|
|
|
genai.chatbot:
|
|
# metrics
|
|
|
|
enabled:
|
|
type: boolean
|
|
lifetime: application
|
|
description: >
|
|
Indicates if the chatbot feature is enabled.
|
|
bugs:
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1895813
|
|
data_reviews:
|
|
- https://phabricator.services.mozilla.com/D214470
|
|
data_sensitivity:
|
|
- interaction
|
|
expires: 147
|
|
notification_emails:
|
|
- elee@mozilla.com
|
|
send_in_pings:
|
|
- metrics
|
|
|
|
provider:
|
|
type: string
|
|
lifetime: application
|
|
description: >
|
|
Indicates id of activated chatbot provider or "custom" or "none"
|
|
bugs:
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1895813
|
|
data_reviews:
|
|
- https://phabricator.services.mozilla.com/D214470
|
|
data_sensitivity:
|
|
- interaction
|
|
expires: 147
|
|
notification_emails:
|
|
- elee@mozilla.com
|
|
send_in_pings:
|
|
- metrics
|
|
|
|
shortcuts:
|
|
type: boolean
|
|
lifetime: application
|
|
description: >
|
|
Indicates if the chatbot feature would show shortcuts on selection.
|
|
bugs:
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1910005
|
|
data_reviews:
|
|
- https://phabricator.services.mozilla.com/D217782
|
|
data_sensitivity:
|
|
- interaction
|
|
expires: 147
|
|
notification_emails:
|
|
- elee@mozilla.com
|
|
send_in_pings:
|
|
- metrics
|
|
|
|
shortcuts_custom:
|
|
type: boolean
|
|
lifetime: application
|
|
description: >
|
|
Indicates if the chatbot feature would show shortcuts custom input.
|
|
bugs:
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1910005
|
|
data_reviews:
|
|
- https://phabricator.services.mozilla.com/D217782
|
|
data_sensitivity:
|
|
- interaction
|
|
expires: 147
|
|
notification_emails:
|
|
- elee@mozilla.com
|
|
send_in_pings:
|
|
- metrics
|
|
|
|
sidebar:
|
|
type: boolean
|
|
lifetime: application
|
|
description: >
|
|
Indicates if the chatbot feature would open in sidebar.
|
|
bugs:
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1895813
|
|
data_reviews:
|
|
- https://phabricator.services.mozilla.com/D214470
|
|
data_sensitivity:
|
|
- interaction
|
|
expires: 147
|
|
notification_emails:
|
|
- elee@mozilla.com
|
|
send_in_pings:
|
|
- metrics
|
|
|
|
# events
|
|
|
|
contextmenu_prompt_click:
|
|
type: event
|
|
description: >
|
|
Chatbot prompt was clicked from the context menu.
|
|
bugs:
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1895813
|
|
data_reviews:
|
|
- https://phabricator.services.mozilla.com/D214470
|
|
data_sensitivity:
|
|
- interaction
|
|
expires: 147
|
|
notification_emails:
|
|
- elee@mozilla.com
|
|
send_in_pings:
|
|
- events
|
|
extra_keys:
|
|
prompt:
|
|
type: string
|
|
description: Selected prompt id.
|
|
provider:
|
|
type: string
|
|
description: Selected provider id.
|
|
selection:
|
|
type: quantity
|
|
description: Selected text length.
|
|
|
|
experiment_checkbox_click:
|
|
type: event
|
|
description: >
|
|
Chatbot experiment checkbox was clicked to enable/disable.
|
|
bugs:
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1895813
|
|
data_reviews:
|
|
- https://phabricator.services.mozilla.com/D214470
|
|
data_sensitivity:
|
|
- interaction
|
|
expires: 147
|
|
notification_emails:
|
|
- elee@mozilla.com
|
|
send_in_pings:
|
|
- events
|
|
extra_keys:
|
|
enabled:
|
|
type: boolean
|
|
description: New/current state is enabled.
|
|
|
|
onboarding_close:
|
|
type: event
|
|
description: >
|
|
Chatbot onboarding closed from provider choice.
|
|
bugs:
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1911104
|
|
data_reviews:
|
|
- https://phabricator.services.mozilla.com/D223938
|
|
data_sensitivity:
|
|
- interaction
|
|
expires: 147
|
|
notification_emails:
|
|
- elee@mozilla.com
|
|
send_in_pings:
|
|
- events
|
|
extra_keys:
|
|
provider:
|
|
type: string
|
|
description: Which provider was last selected.
|
|
step:
|
|
type: quantity
|
|
description: Onboarding screen number.
|
|
|
|
onboarding_continue:
|
|
type: event
|
|
description: >
|
|
Chatbot onboarding continued from provider choice.
|
|
bugs:
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1911104
|
|
data_reviews:
|
|
- https://phabricator.services.mozilla.com/D223938
|
|
data_sensitivity:
|
|
- interaction
|
|
expires: 147
|
|
notification_emails:
|
|
- elee@mozilla.com
|
|
send_in_pings:
|
|
- events
|
|
extra_keys:
|
|
provider:
|
|
type: string
|
|
description: Which provider was last selected.
|
|
step:
|
|
type: quantity
|
|
description: Onboarding screen number.
|
|
|
|
onboarding_finish:
|
|
type: event
|
|
description: >
|
|
Chatbot onboarding finished with start chatting button.
|
|
bugs:
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1911104
|
|
data_reviews:
|
|
- https://phabricator.services.mozilla.com/D223938
|
|
data_sensitivity:
|
|
- interaction
|
|
expires: 147
|
|
notification_emails:
|
|
- elee@mozilla.com
|
|
send_in_pings:
|
|
- events
|
|
extra_keys:
|
|
provider:
|
|
type: string
|
|
description: Which provider was last selected.
|
|
step:
|
|
type: quantity
|
|
description: Onboarding screen number.
|
|
|
|
onboarding_learn_more:
|
|
type: event
|
|
description: >
|
|
Chatbot onboarding opened feature learn more link.
|
|
bugs:
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1911104
|
|
data_reviews:
|
|
- https://phabricator.services.mozilla.com/D223938
|
|
data_sensitivity:
|
|
- interaction
|
|
expires: 147
|
|
notification_emails:
|
|
- elee@mozilla.com
|
|
send_in_pings:
|
|
- events
|
|
extra_keys:
|
|
provider:
|
|
type: string
|
|
description: Which provider was last selected.
|
|
step:
|
|
type: quantity
|
|
description: Onboarding screen number.
|
|
|
|
onboarding_provider_choice_displayed:
|
|
type: event
|
|
description: >
|
|
Chatbot onboarding impression for provider choice screen.
|
|
bugs:
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1911104
|
|
data_reviews:
|
|
- https://phabricator.services.mozilla.com/D223938
|
|
data_sensitivity:
|
|
- interaction
|
|
expires: 147
|
|
notification_emails:
|
|
- elee@mozilla.com
|
|
send_in_pings:
|
|
- events
|
|
extra_keys:
|
|
provider:
|
|
type: string
|
|
description: Current provider id.
|
|
step:
|
|
type: quantity
|
|
description: Onboarding screen number.
|
|
|
|
onboarding_provider_learn:
|
|
type: event
|
|
description: >
|
|
Chatbot onboarding opened provider learn more link.
|
|
bugs:
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1911104
|
|
data_reviews:
|
|
- https://phabricator.services.mozilla.com/D223938
|
|
data_sensitivity:
|
|
- interaction
|
|
expires: 147
|
|
notification_emails:
|
|
- elee@mozilla.com
|
|
send_in_pings:
|
|
- events
|
|
extra_keys:
|
|
provider:
|
|
type: string
|
|
description: Which provider.
|
|
step:
|
|
type: quantity
|
|
description: Onboarding screen number.
|
|
|
|
onboarding_provider_selection:
|
|
type: event
|
|
description: >
|
|
Chatbot onboarding selected a provider.
|
|
bugs:
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1911104
|
|
data_reviews:
|
|
- https://phabricator.services.mozilla.com/D223938
|
|
data_sensitivity:
|
|
- interaction
|
|
expires: 147
|
|
notification_emails:
|
|
- elee@mozilla.com
|
|
send_in_pings:
|
|
- events
|
|
extra_keys:
|
|
provider:
|
|
type: string
|
|
description: Which provider.
|
|
step:
|
|
type: quantity
|
|
description: Onboarding screen number.
|
|
|
|
onboarding_provider_terms:
|
|
type: event
|
|
description: >
|
|
Chatbot onboarding opened provider terms link.
|
|
bugs:
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1911104
|
|
data_reviews:
|
|
- https://phabricator.services.mozilla.com/D223938
|
|
data_sensitivity:
|
|
- interaction
|
|
expires: 147
|
|
notification_emails:
|
|
- elee@mozilla.com
|
|
send_in_pings:
|
|
- events
|
|
extra_keys:
|
|
provider:
|
|
type: string
|
|
description: Which provider.
|
|
step:
|
|
type: quantity
|
|
description: Onboarding screen number.
|
|
text:
|
|
type: string
|
|
description: Which terms link.
|
|
|
|
onboarding_text_highlight_displayed:
|
|
type: event
|
|
description: >
|
|
Chatbot onboarding impression for text highlight screen.
|
|
bugs:
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1911104
|
|
data_reviews:
|
|
- https://phabricator.services.mozilla.com/D223938
|
|
data_sensitivity:
|
|
- interaction
|
|
expires: 147
|
|
notification_emails:
|
|
- elee@mozilla.com
|
|
send_in_pings:
|
|
- events
|
|
extra_keys:
|
|
provider:
|
|
type: string
|
|
description: Which provider was last selected.
|
|
step:
|
|
type: quantity
|
|
description: Onboarding screen number.
|
|
|
|
provider_change:
|
|
type: event
|
|
description: >
|
|
Chatbot provider UI changed providers.
|
|
bugs:
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1895813
|
|
data_reviews:
|
|
- https://phabricator.services.mozilla.com/D214470
|
|
data_sensitivity:
|
|
- interaction
|
|
expires: 147
|
|
notification_emails:
|
|
- elee@mozilla.com
|
|
send_in_pings:
|
|
- events
|
|
extra_keys:
|
|
current:
|
|
type: string
|
|
description: Current provider id.
|
|
previous:
|
|
type: string
|
|
description: Previous provider id.
|
|
surface:
|
|
type: string
|
|
description: Which UI surface.
|
|
|
|
shortcuts_checkbox_click:
|
|
type: event
|
|
description: >
|
|
Chatbot shortcuts checkbox was clicked to enable/disable.
|
|
bugs:
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1910005
|
|
data_reviews:
|
|
- https://phabricator.services.mozilla.com/D217782
|
|
data_sensitivity:
|
|
- interaction
|
|
expires: 147
|
|
notification_emails:
|
|
- elee@mozilla.com
|
|
send_in_pings:
|
|
- events
|
|
extra_keys:
|
|
enabled:
|
|
type: boolean
|
|
description: New/current state is enabled.
|
|
|
|
shortcuts_displayed:
|
|
type: event
|
|
description: >
|
|
Shortcuts displayed on text selection.
|
|
bugs:
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1910005
|
|
data_reviews:
|
|
- https://phabricator.services.mozilla.com/D217782
|
|
data_sensitivity:
|
|
- interaction
|
|
expires: 147
|
|
notification_emails:
|
|
- elee@mozilla.com
|
|
send_in_pings:
|
|
- events
|
|
extra_keys:
|
|
delay:
|
|
type: quantity
|
|
description: Milliseconds from mousedown to showing.
|
|
inputType:
|
|
type: string
|
|
description: Type if user can edit, e.g., contenteditable, input, textarea.
|
|
selection:
|
|
type: quantity
|
|
description: Selected text length.
|
|
|
|
shortcuts_expanded:
|
|
type: event
|
|
description: >
|
|
Shortcuts expanded to show prompts.
|
|
bugs:
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1910005
|
|
data_reviews:
|
|
- https://phabricator.services.mozilla.com/D217782
|
|
data_sensitivity:
|
|
- interaction
|
|
expires: 147
|
|
notification_emails:
|
|
- elee@mozilla.com
|
|
send_in_pings:
|
|
- events
|
|
extra_keys:
|
|
selection:
|
|
type: quantity
|
|
description: Selected text length.
|
|
|
|
shortcuts_hide_click:
|
|
type: event
|
|
description: >
|
|
Chatbot hide shortcuts was clicked from the shortcuts.
|
|
bugs:
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1911104
|
|
data_reviews:
|
|
- https://phabricator.services.mozilla.com/D223938
|
|
data_sensitivity:
|
|
- interaction
|
|
expires: 147
|
|
notification_emails:
|
|
- elee@mozilla.com
|
|
send_in_pings:
|
|
- events
|
|
extra_keys:
|
|
selection:
|
|
type: quantity
|
|
description: Selected text length.
|
|
|
|
shortcuts_prompt_click:
|
|
type: event
|
|
description: >
|
|
Chatbot prompt was clicked from the shortcuts.
|
|
bugs:
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1910005
|
|
data_reviews:
|
|
- https://phabricator.services.mozilla.com/D217782
|
|
data_sensitivity:
|
|
- interaction
|
|
expires: 147
|
|
notification_emails:
|
|
- elee@mozilla.com
|
|
send_in_pings:
|
|
- events
|
|
extra_keys:
|
|
prompt:
|
|
type: string
|
|
description: Selected prompt id.
|
|
provider:
|
|
type: string
|
|
description: Selected provider id.
|
|
selection:
|
|
type: quantity
|
|
description: Selected text length.
|
|
|
|
sidebar_close_click:
|
|
type: event
|
|
description: >
|
|
Chatbot close X clicked.
|
|
bugs:
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1911104
|
|
data_reviews:
|
|
- https://phabricator.services.mozilla.com/D223938
|
|
data_sensitivity:
|
|
- interaction
|
|
expires: 147
|
|
notification_emails:
|
|
- elee@mozilla.com
|
|
send_in_pings:
|
|
- events
|
|
extra_keys:
|
|
provider:
|
|
type: string
|
|
description: Selected provider id.
|
|
|
|
sidebar_more_menu_click:
|
|
type: event
|
|
description: >
|
|
Chatbot more menu clicked an action.
|
|
bugs:
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1911104
|
|
data_reviews:
|
|
- https://phabricator.services.mozilla.com/D223938
|
|
data_sensitivity:
|
|
- interaction
|
|
expires: 147
|
|
notification_emails:
|
|
- elee@mozilla.com
|
|
send_in_pings:
|
|
- events
|
|
extra_keys:
|
|
action:
|
|
type: string
|
|
description: Which action was clicked.
|
|
provider:
|
|
type: string
|
|
description: Selected provider id.
|
|
|
|
sidebar_more_menu_display:
|
|
type: event
|
|
description: >
|
|
Chatbot more menu opened.
|
|
bugs:
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1911104
|
|
data_reviews:
|
|
- https://phabricator.services.mozilla.com/D223938
|
|
data_sensitivity:
|
|
- interaction
|
|
expires: 147
|
|
notification_emails:
|
|
- elee@mozilla.com
|
|
send_in_pings:
|
|
- events
|
|
extra_keys:
|
|
provider:
|
|
type: string
|
|
description: Selected provider id.
|
|
|
|
sidebar_provider_menu_click:
|
|
type: event
|
|
description: >
|
|
Chatbot provider menu clicked an action.
|
|
bugs:
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1911104
|
|
data_reviews:
|
|
- https://phabricator.services.mozilla.com/D223938
|
|
data_sensitivity:
|
|
- interaction
|
|
expires: 147
|
|
notification_emails:
|
|
- elee@mozilla.com
|
|
send_in_pings:
|
|
- events
|
|
extra_keys:
|
|
action:
|
|
type: string
|
|
description: Which action was clicked.
|
|
provider:
|
|
type: string
|
|
description: Selected provider id.
|
|
|
|
sidebar_toggle:
|
|
type: event
|
|
description: >
|
|
Chatbot sidebar panel was toggled open/close.
|
|
bugs:
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1895813
|
|
data_reviews:
|
|
- https://phabricator.services.mozilla.com/D214470
|
|
data_sensitivity:
|
|
- interaction
|
|
expires: 147
|
|
notification_emails:
|
|
- elee@mozilla.com
|
|
send_in_pings:
|
|
- events
|
|
extra_keys:
|
|
opened:
|
|
type: boolean
|
|
description: New/current state of sidebar is open.
|
|
provider:
|
|
type: string
|
|
description: Selected provider id.
|
|
reason:
|
|
type: string
|
|
description: Why panel is toggling.
|