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
# Adding a new metric? We have docs for that!
---
$tags:
- 'Firefox :: Sidebar'
sidebar:
expand:
type: event
description: >
The sidebar was expanded.
bugs:
data_reviews:
data_sensitivity:
- interaction
expires: never
notification_emails:
- vsabino@mozilla.com
send_in_pings:
- events
resize:
type: event
description: >
User resized the sidebar.
bugs:
data_reviews:
data_sensitivity:
- interaction
expires: never
notification_emails:
- vsabino@mozilla.com
send_in_pings:
- events
extra_keys:
current:
type: quantity
description: Current width in pixels.
previous:
type: quantity
description: Previous width in pixels.
percentage:
type: quantity
description: Percentage of window width at time of resize (0-100).
display_settings:
type: string
lifetime: application
description: >
Setting for sidebar display (either "always" or "hide").
bugs:
data_reviews:
data_sensitivity:
- interaction
expires: never
notification_emails:
- vsabino@mozilla.com
send_in_pings:
- metrics
position_settings:
type: string
lifetime: application
description: >
Setting for sidebar position (either "left" or "right").
bugs:
data_reviews:
data_sensitivity:
- interaction
expires: never
notification_emails:
- vsabino@mozilla.com
send_in_pings:
- metrics
tabs_layout:
type: string
lifetime: application
description: >
Setting for tabs orientation (either "horizontal" or "vertical").
bugs:
data_reviews:
data_sensitivity:
- interaction
expires: never
notification_emails:
- vsabino@mozilla.com
send_in_pings:
- metrics
width:
type: quantity
unit: pixels
lifetime: application
description: >
Width of the sidebar, in pixels.
bugs:
data_reviews:
data_sensitivity:
- interaction
expires: never
notification_emails:
- vsabino@mozilla.com
send_in_pings:
- metrics
search:
type: labeled_counter
description: >
The number of searches from the sidebar, per view (e.g.: bookmarks,
history).
This metric was generated to correspond to the Legacy Telemetry
scalar sidebar.search.
bugs:
data_reviews:
notification_emails:
- rtestard@mozilla.com
expires: never
telemetry_mirror: SIDEBAR_SEARCH
link:
type: labeled_counter
description: >
The number of history items opened from the History sidebar.
This metric was generated to correspond to the Legacy Telemetry
scalar sidebar.link.
bugs:
data_reviews:
notification_emails:
- rtestard@mozilla.com
expires: never
telemetry_mirror: SIDEBAR_LINK
chatbot_icon_click:
type: event
description: >
The chatbot icon was clicked.
bugs:
data_reviews:
data_sensitivity:
- interaction
expires: never
notification_emails:
- vsabino@mozilla.com
send_in_pings:
- events
extra_keys:
sidebar_open:
type: boolean
description: Whether the sidebar is expanded or collapsed.
history_icon_click:
type: event
description: >
The history icon was clicked.
bugs:
data_reviews:
data_sensitivity:
- interaction
expires: never
notification_emails:
- vsabino@mozilla.com
send_in_pings:
- events
extra_keys:
sidebar_open:
type: boolean
description: Whether the sidebar is expanded or collapsed.
synced_tabs_icon_click:
type: event
description: >
The synced tabs icon was clicked.
bugs:
data_reviews:
data_sensitivity:
- interaction
expires: never
notification_emails:
- vsabino@mozilla.com
send_in_pings:
- events
extra_keys:
sidebar_open:
type: boolean
description: Whether the sidebar is expanded or collapsed.
bookmarks_icon_click:
type: event
description: >
The bookmarks icon was clicked.
bugs:
data_reviews:
data_sensitivity:
- interaction
expires: never
notification_emails:
- vsabino@mozilla.com
send_in_pings:
- events
extra_keys:
sidebar_open:
type: boolean
description: Whether the sidebar is expanded or collapsed.
addon_icon_click:
type: event
description: >
An extension icon was clicked.
bugs:
data_reviews:
data_sensitivity:
- interaction
expires: never
notification_emails:
- vsabino@mozilla.com
send_in_pings:
- events
extra_keys:
sidebar_open:
type: boolean
description: Whether the sidebar is expanded or collapsed.
addon_id:
type: string
description: The extension's ID.
history:
sidebar_toggle:
type: event
description: >
The History sidebar panel was loaded or unloaded.
bugs:
data_reviews:
data_sensitivity:
- interaction
expires: never
notification_emails:
- vsabino@mozilla.com
send_in_pings:
- events
extra_keys:
opened:
type: boolean
description: Whether the panel was opened.
synced_tabs:
sidebar_toggle:
type: event
description: >
The Synced Tabs sidebar panel was loaded or unloaded.
bugs:
data_reviews:
data_sensitivity:
- interaction
expires: never
notification_emails:
- vsabino@mozilla.com
send_in_pings:
- events
extra_keys:
opened:
type: boolean
description: Whether the panel was opened.
synced_tabs_loaded:
type: boolean
description: Whether synced tabs are showing.
bookmarks:
sidebar_toggle:
type: event
description: >
The Bookmarks sidebar panel was loaded or unloaded.
bugs:
data_reviews:
data_sensitivity:
- interaction
expires: never
notification_emails:
- vsabino@mozilla.com
send_in_pings:
- events
extra_keys:
opened:
type: boolean
description: Whether the panel was opened.
extension:
sidebar_toggle:
type: event
description: >
A sidebar extension panel was loaded or unloaded.
bugs:
data_reviews:
data_sensitivity:
- interaction
expires: never
notification_emails:
- vsabino@mozilla.com
send_in_pings:
- events
extra_keys:
opened:
type: boolean
description: Whether the panel was opened.
addon_id:
type: string
description: The extension's ID.
addon_name:
type: string
description: The localized name of the extension.
sidebar.customize:
panel_toggle:
type: event
description: >
The Customize sidebar panel was loaded or unloaded.
bugs:
data_reviews:
data_sensitivity:
- interaction
expires: never
notification_emails:
- vsabino@mozilla.com
send_in_pings:
- events
extra_keys:
opened:
type: boolean
description: Whether the panel was opened.
icon_click:
type: event
description: >
User clicked on the gear icon to customize the sidebar.
bugs:
data_reviews:
data_sensitivity:
- interaction
expires: never
notification_emails:
- vsabino@mozilla.com
send_in_pings:
- events
chatbot_enabled:
type: event
description: >
User clicked on the checkbox corresponding to chatbot on sidebar customization settings.
bugs:
data_reviews:
data_sensitivity:
- interaction
expires: never
notification_emails:
- vsabino@mozilla.com
send_in_pings:
- events
extra_keys:
checked:
type: boolean
description: Whether the box was checked.
synced_tabs_enabled:
type: event
description: >
User clicked on the checkbox corresponding to synced tabs on sidebar customization settings.
bugs:
data_reviews:
data_sensitivity:
- interaction
expires: never
notification_emails:
- vsabino@mozilla.com
send_in_pings:
- events
extra_keys:
checked:
type: boolean
description: Whether the box was checked.
history_enabled:
type: event
description: >
User clicked on the checkbox corresponding to history on sidebar customization settings.
bugs:
data_reviews:
data_sensitivity:
- interaction
expires: never
notification_emails:
- vsabino@mozilla.com
send_in_pings:
- events
extra_keys:
checked:
type: boolean
description: Whether the box was checked.
bookmarks_enabled:
type: event
description: >
User clicked on the checkbox corresponding to bookmarks on sidebar customization settings.
bugs:
data_reviews:
data_sensitivity:
- interaction
expires: never
notification_emails:
- vsabino@mozilla.com
send_in_pings:
- events
extra_keys:
checked:
type: boolean
description: Whether the box was checked.
extensions_clicked:
type: event
description: >
User clicked on the link to go to Browser Extensions on sidebar customization settings.
bugs:
data_reviews:
data_sensitivity:
- interaction
expires: never
notification_emails:
- vsabino@mozilla.com
send_in_pings:
- events
sidebar_display:
type: event
description: >
User selected an option of when the sidebar is shown on sidebar customization settings.
bugs:
data_reviews:
data_sensitivity:
- interaction
expires: never
notification_emails:
- vsabino@mozilla.com
send_in_pings:
- events
extra_keys:
preference:
type: string
description: Either "always" or "hide".
sidebar_position:
type: event
description: >
User selected an option of in which side the sidebar is displayed from the sidebar customization settings.
bugs:
data_reviews:
data_sensitivity:
- interaction
expires: never
notification_emails:
- vsabino@mozilla.com
send_in_pings:
- events
extra_keys:
position:
type: string
description: Either "left" or "right".
tabs_layout:
type: event
description: >
User selected between horizontal or vertical tabs on sidebar customization settings.
bugs:
data_reviews:
data_sensitivity:
- interaction
expires: never
notification_emails:
- vsabino@mozilla.com
send_in_pings:
- events
extra_keys:
orientation:
type: string
description: Either "horizontal" or "vertical".
tabs_display:
type: event
description: >
User clicked on the checkbox corresponding to hiding horizontal tabs on sidebar customization settings.
bugs:
data_reviews:
data_sensitivity:
- interaction
expires: never
notification_emails:
- vsabino@mozilla.com
send_in_pings:
- events
extra_keys:
checked:
type: boolean
description: Whether the box was checked.
firefox_settings_clicked:
type: event
description: >
User clicked on the link to Manage Firefox Settings on sidebar customization settings.
bugs:
data_reviews:
data_sensitivity:
- interaction
expires: never
notification_emails:
- vsabino@mozilla.com
send_in_pings:
- events