Source code
Revision control
Copy as Markdown
Other Tools
# 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!
---
$schema: moz://mozilla.org/schemas/glean/metrics/2-0-0
$tags:
- "Core :: Machine Learning"
smart_window:
chat_submit:
type: event
description: |
Recorded when the user submits a chat entry
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=2015626
- https://bugzilla.mozilla.org/show_bug.cgi?id=2009615
data_reviews:
- https://phabricator.services.mozilla.com/D282873
data_sensitivity:
- interaction
notification_emails:
- npodgurski@mozilla.com
expires: never
extra_keys:
chat_id: &chat_id
type: string
description: >
UUID for this smart window session. Unique identifier for each chat conversation
detected_intent: &detected_intent
type: string
description: >
What was the detected intent for the request: navigate, search, chat, or action
location: &location
type: string
description: >
Which input was used: fullpage, sidebar, or urlbar
memories:
type: quantity
unit: count
description: >
Number of memories included
mentions:
type: quantity
unit: count
description: >
Number of mentions in the request
message_seq: &message_seq
type: quantity
unit: count
description: >
Number of messages in that chat
model: &model
type: string
description: >
Model selected by the user
submit_type: &submit_type
type: string
description: >
How the request was submitted: button, enter, follow-up, starter, or suggestion
tabs:
type: quantity
unit: count
description: >
Number of tabs selected
tokens:
type: quantity
unit: count
description: >
Number of tokens in the request
search_submit:
type: event
description: |
Recorded when the user runs a search query
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=2009615
data_reviews:
- https://phabricator.services.mozilla.com/D288855
data_sensitivity:
- interaction
notification_emails:
- npodgurski@mozilla.com
expires: never
extra_keys:
chat_id: *chat_id
detected_intent: *detected_intent
length:
type: quantity
unit: characters
description: >
Number of characters for the search terms
location: *location
message_seq: *message_seq
model: *model
provider:
type: string
description: >
Search provider used in the request
navigate_submit:
type: event
description: |
Recorded when the user navigates to a URL
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=2009615
data_reviews:
- https://phabricator.services.mozilla.com/D288855
data_sensitivity:
- interaction
notification_emails:
- npodgurski@mozilla.com
expires: never
extra_keys:
chat_id: *chat_id
detected_intent: *detected_intent
location: *location
message_seq: *message_seq
model: *model
submit_type: *submit_type
# Chat Assistant
chat_previous_session:
type: event
description: |
User clicks on previous session button
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=2022629
data_reviews:
- https://phabricator.services.mozilla.com/D287197
data_sensitivity:
- interaction
notification_emails:
- npodgurski@mozilla.com
expires: never
extra_keys:
tabs:
type: quantity
unit: count
description: >
Number of tabs restored
history_displayed:
type: event
description: |
Results from Ask History are displayed to the user
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=2022629
data_reviews:
- https://phabricator.services.mozilla.com/D287197
data_sensitivity:
- interaction
notification_emails:
- npodgurski@mozilla.com
expires: never
extra_keys:
location: *location
chat_id: *chat_id
message_seq: *message_seq
total: &total
type: quantity
unit: count
description: >
Number of history entries displayed
reason: &history_reason
type: string
description: >
What triggered the history display: ask or restore
history_click:
type: event
description: |
User clicks on a history result
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=2022629
data_reviews:
- https://phabricator.services.mozilla.com/D287197
data_sensitivity:
- interaction
notification_emails:
- npodgurski@mozilla.com
expires: never
extra_keys:
location: *location
chat_id: *chat_id
message_seq: *message_seq
total: *total
position: &position
type: quantity
unit: count
description: >
Position of the entry that was clicked
chat_retrieved:
type: event
description: |
User retrieves a chat from history
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=2022629
data_reviews:
- https://phabricator.services.mozilla.com/D287197
data_sensitivity:
- interaction
notification_emails:
- npodgurski@mozilla.com
expires: never
extra_keys:
location: *location
chat_id: *chat_id
num_messages: &num_messages
type: quantity
unit: count
description: >
Number of messages in that chat.
time_delta:
type: quantity
unit: minutes
description: >
Elapsed time in minutes between chat session completion and retrieval
quick_prompt_displayed:
type: event
description: |
User is presented with one or more quick prompts
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=2022629
data_reviews:
- https://phabricator.services.mozilla.com/D282482
data_sensitivity:
- interaction
notification_emails:
- npodgurski@mozilla.com
expires: never
extra_keys:
location: *location
chat_id: *chat_id
message_seq: *message_seq
prompts:
type: quantity
unit: count
description: >
Number of prompts displayed
quick_prompt_clicked:
type: event
description: |
Recorded when the user selects a prompt suggestion in smart window mode
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=2022629
data_reviews:
- https://phabricator.services.mozilla.com/D282482
data_sensitivity:
- interaction
notification_emails:
- npodgurski@mozilla.com
expires: never
extra_keys:
location: *location
chat_id: *chat_id
message_seq: *message_seq
starter: &starter
type: boolean
description: >
Boolean indicating if the prompt is a conversation starter, as opposed to a follow-up
get_page_content:
type: event
description: |
Browser reads the contents of a tab to include in chat result
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=2022629
data_reviews:
- https://phabricator.services.mozilla.com/D287197
data_sensitivity:
- interaction
notification_emails:
- npodgurski@mozilla.com
expires: never
extra_keys:
location: *location
chat_id: *chat_id
message_seq: *message_seq
length:
type: quantity
unit: count
description: >
Number of characters read from the page
time:
type: quantity
unit: ms
description: >
Time to process the request
link_click:
type: event
description: |
User clicks a link within the response
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=2022629
data_reviews:
- https://phabricator.services.mozilla.com/D287197
data_sensitivity:
- interaction
notification_emails:
- npodgurski@mozilla.com
expires: never
extra_keys:
location: *location
chat_id: *chat_id
message_seq: *message_seq
memory_removed_panel:
type: event
description: |
User removes a single memory from the memories panel
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=2022629
data_reviews:
- https://phabricator.services.mozilla.com/D287197
data_sensitivity:
- interaction
notification_emails:
- npodgurski@mozilla.com
expires: never
extra_keys:
memories:
type: quantity
unit: count
description: >
Total number of memories still present after the removal
trigger:
type: string
description: >
The location where the removal occurred (assistant, settings)
memory_applied:
type: event
description: |
Triggered when a memory is used as part of query to provide response/results to user
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=2022629
data_reviews:
- https://phabricator.services.mozilla.com/D287197
data_sensitivity:
- interaction
notification_emails:
- npodgurski@mozilla.com
expires: never
extra_keys:
location: *location
chat_id: *chat_id
message_seq: *message_seq
memory_applied_click:
type: event
description: |
User clicks on memories applied tooltip
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=2022629
data_reviews:
- https://phabricator.services.mozilla.com/D287197
data_sensitivity:
- interaction
notification_emails:
- npodgurski@mozilla.com
expires: never
extra_keys:
location: *location
chat_id: *chat_id
message_seq: *message_seq
retry_no_memories:
type: event
description: |
User selects retry without memories
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=2022629
data_reviews:
- https://phabricator.services.mozilla.com/D287197
data_sensitivity:
- interaction
notification_emails:
- npodgurski@mozilla.com
expires: never
extra_keys:
location: *location
chat_id: *chat_id
message_seq: *message_seq
memories_toggle:
type: event
description: |
Recorded when the user clicks the toggle to turn memories on or off for that chat
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=2022629
data_reviews:
- https://phabricator.services.mozilla.com/D287197
data_sensitivity:
- interaction
notification_emails:
- npodgurski@mozilla.com
expires: never
extra_keys:
location: *location
chat_id: *chat_id
message_seq: *message_seq
memories:
type: quantity
unit: count
description: >
Total number of memories available
toggle: &toggle
type: boolean
description: >
Whether the memories feature is enabled or not. True for turning on and false for turning off
model_request:
type: event
description: |
A request is made to the backend model
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=2021947
data_reviews:
- https://phabricator.services.mozilla.com/D287710
data_sensitivity:
- interaction
notification_emails:
- gcardieri@mozilla.com
expires: never
extra_keys:
location: *location
chat_id: *chat_id
message_seq: *message_seq
request_id: &request_id
type: string
description: >
Identifier to be used to cross reference with backend telemetry
detected_intent: *detected_intent
intent: &intent
type: string
description: >
Intent of the request
tokens: &tokens
type: quantity
unit: count
description: >
number of tokens processed to fulfill the request
memories:
type: quantity
unit: count
description: >
Number of memories included in the response
model_response:
type: event
description: |
A response is received from the backend model
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=2021947
data_reviews:
- https://phabricator.services.mozilla.com/D287710
data_sensitivity:
- interaction
notification_emails:
- gcardieri@mozilla.com
expires: never
extra_keys:
location: *location
chat_id: *chat_id
message_seq: *message_seq
request_id: *request_id
intent: *intent
tokens: *tokens
memories:
type: quantity
unit: count
description: >
Number of memories included in the response
latency:
type: quantity
unit: ms
description: >
Time in ms to start processing the request
duration:
type: quantity
unit: ms
description: >
Time in ms to process the request
error: &error
type: string
description: >
Error code if it's not a successful response
model: *model
onboarding_screen_impression:
type: event
description: |
Recorded when onboarding screen is displayed in smart window mode
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=2009613
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=2009613
data_sensitivity:
- interaction
notification_emails:
- pdahiya@mozilla.com
extra_keys:
message_id:
description: >
Identifier for the onboarding screen that is displayed, for example
'AI_WINDOW_WELCOME_0_AI_WINDOW_INTRO_WW' for the welcome screen,
'AI_WINDOW_WELCOME_1_AI_WINDOW_CHOOSE_MODEL_WW' for the model selection screen
type: string
expires: never
onboarding_model_selected:
type: event
description: |
Recorded when user selects a model for Smart Window during onboarding
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=2009613
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=2009613
data_sensitivity:
- interaction
notification_emails:
- pdahiya@mozilla.com
extra_keys:
model:
description: >
Identifier for the model tile clicked by the user during onboarding,
for example: '1', '2', '3'
type: string
expires: never
onboarding_model_navigate:
type: event
description: |
Recorded when user clicks done on the model selection screen
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=2009613
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=2009613
data_sensitivity:
- interaction
notification_emails:
- pdahiya@mozilla.com
extra_keys:
model:
description: >
Identifier for the selected model during onboarding when user clicks done,
for example: '1', '2', '3'
type: string
expires: never
onboarding_complete:
type: event
description: |
Indicates if user completed onboarding successfully
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=2009613
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=2009613
data_sensitivity:
- interaction
notification_emails:
- pdahiya@mozilla.com
expires: never
open_window:
type: event
description: |
Recorded when a Smart Window is opened
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=2009610
data_reviews:
- https://phabricator.services.mozilla.com/D285902
data_sensitivity:
- interaction
notification_emails:
- mlucks@mozilla.com
extra_keys:
trigger:
type: string
description: >
The reason the Smart Window was opened. One of: switch, menu, new_window, open_browser, or undo_close
fxa:
type: boolean
description: >
Whether the user is signed in to their Firefox Account
onboarding:
type: boolean
description: >
Whether the user saw firstrun onboarding when opening Smart Window. True if onboarding has not yet been completed.
expires: never
uri_load:
type: event
description: |
User opens a URI in the Smart Window (includes session restore and external link). This event is sent at most once per hour to indicate Smart Window activity.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=2009610
data_reviews:
- https://phabricator.services.mozilla.com/D285902
data_sensitivity:
- interaction
notification_emails:
- mlucks@mozilla.com
extra_keys:
model:
type: string
description: >
The model choice selected during firstrun, corresponding to the
model_choice_id in Remote Settings (1, 2, or 3). "custom" if a
custom model override is set. Empty string if firstrun was not
completed.
expires: never
sidebar_open:
type: event
description: |
Recorded when the Smart Window sidebar is opened
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=2009610
data_reviews:
- https://phabricator.services.mozilla.com/D285902
data_sensitivity:
- interaction
notification_emails:
- mlucks@mozilla.com
extra_keys:
chat_id: *chat_id
message_seq: &sidebar_message_seq
type: quantity
unit: count
description: >
Number of messages in the conversation at the time the sidebar was opened or closed
expires: never
sidebar_close:
type: event
description: |
Recorded when the Smart Window sidebar is closed
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=2009610
data_reviews:
- https://phabricator.services.mozilla.com/D285902
data_sensitivity:
- interaction
notification_emails:
- mlucks@mozilla.com
extra_keys:
chat_id: *chat_id
message_seq: *sidebar_message_seq
expires: never
tabs_opened:
type: counter
description: |
The number of Smart Window tabs opened in the current ping session
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=2009610
data_reviews:
- https://phabricator.services.mozilla.com/D285902
data_sensitivity:
- interaction
notification_emails:
- mlucks@mozilla.com
expires: never
memories_nuke:
type: event
description: |
User clicks on “Delete all” button for memories
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=2009612
data_reviews:
- https://phabricator.services.mozilla.com/D288768
data_sensitivity:
- interaction
notification_emails:
- gcardieri@mozilla.com
expires: never
settings_memories:
type: event
description: |
User interacts with the checkboxes to change memories settings
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=2009612
data_reviews:
- https://phabricator.services.mozilla.com/D288768
data_sensitivity:
- interaction
notification_emails:
- gcardieri@mozilla.com
expires: never
extra_keys:
type:
type: string
description: >
chat or browsing
enabled:
type: boolean
description: >
Boolean indicating if that type of memory was enabled or disabled
settings_model:
type: event
description: |
User selects a different model from the settings page
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=2009612
data_reviews:
- https://phabricator.services.mozilla.com/D288768
data_sensitivity:
- interaction
notification_emails:
- gcardieri@mozilla.com
expires: never
extra_keys:
previous_model:
type: string
description: >
The model that was previously selected
new_model:
type: string
description: >
The new model that was selected
memories_panel_displayed:
type: event
description: |
User opens the memories preferences panel
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=2009612
data_reviews:
- https://phabricator.services.mozilla.com/D288768
data_sensitivity:
- interaction
notification_emails:
- gcardieri@mozilla.com
expires: never
extra_keys:
source:
type: string
description: >
Where the panel was opened from
memories:
type: quantity
unit: count
description: >
Number of memories available
model:
type: string
description: |
Records the model selected by the user, or “custom-model”
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=2009612
data_reviews:
- https://phabricator.services.mozilla.com/D288768
data_sensitivity:
- interaction
notification_emails:
- gcardieri@mozilla.com
expires: never
intent_change_preview:
type: event
description: |
Recorded when the smartbar action menu is opened
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=2009615
data_reviews:
- https://phabricator.services.mozilla.com/D288855
data_sensitivity:
- interaction
notification_emails:
- npodgurski@mozilla.com
expires: never
extra_keys:
chat_id: *chat_id
current_intent:
type: string
description: >
The current intent action: chat, search, navigate, or empty string
location: *location
message_seq: *message_seq
mention_start:
type: event
description: |
Recorded when the user brings up a list of inline mentions by typing `@`
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=2009615
data_reviews:
- https://phabricator.services.mozilla.com/D288855
data_sensitivity:
- interaction
notification_emails:
- npodgurski@mozilla.com
expires: never
extra_keys:
chat_id: *chat_id
location: *location
mentions_available:
type: quantity
unit: count
description: >
Number of mention suggestions shown
message_seq: *message_seq
mention_select:
type: event
description: |
Recorded when the user selects an inline mention from the list of suggestions
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=2009615
data_reviews:
- https://phabricator.services.mozilla.com/D288855
data_sensitivity:
- interaction
notification_emails:
- npodgurski@mozilla.com
expires: never
extra_keys:
chat_id: *chat_id
length:
type: quantity
unit: characters
description: >
Number of characters in the mention
location: *location
mentions_available:
type: quantity
unit: count
description: >
Number of mention suggestions available
message_seq: *message_seq
mention_remove:
type: event
description: |
Recorded when an inline mention is removed
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=2009615
data_reviews:
- https://phabricator.services.mozilla.com/D288855
data_sensitivity:
- interaction
notification_emails:
- npodgurski@mozilla.com
expires: never
extra_keys:
chat_id: *chat_id
location: *location
mentions:
type: quantity
unit: count
description: >
Number of inline mentions still included in the input
message_seq: *message_seq
add_tabs_click:
type: event
description: |
Recorded when the user clicks the "+"-menu
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=2009615
data_reviews:
- https://phabricator.services.mozilla.com/D288855
data_sensitivity:
- interaction
notification_emails:
- npodgurski@mozilla.com
expires: never
extra_keys:
chat_id: *chat_id
location: *location
message_seq: *message_seq
tabs_available: &tabs_available
type: quantity
unit: count
description: >
Number of tabs available
tabs_preselected: &tabs_preselected
type: quantity
unit: count
description: >
Number of tabs pre-selected
add_tabs_selection:
type: event
description: |
Recorded when the user selected a tab
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=2009615
data_reviews:
- https://phabricator.services.mozilla.com/D288855
data_sensitivity:
- interaction
notification_emails:
- npodgurski@mozilla.com
expires: never
extra_keys:
chat_id: *chat_id
location: *location
message_seq: *message_seq
tabs_available: *tabs_available
tabs_preselected: *tabs_preselected
tabs_selected: &tabs_selected
type: quantity
unit: count
description: >
Number of tabs selected at the end
remove_tab:
type: event
description: |
Recorded when the user removes a tab
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=2009615
data_reviews:
- https://phabricator.services.mozilla.com/D288855
data_sensitivity:
- interaction
notification_emails:
- npodgurski@mozilla.com
expires: never
extra_keys:
chat_id: *chat_id
location: *location
message_seq: *message_seq
tabs_selected: *tabs_selected