# 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:
  - 'Firefox :: Tabbed Browser'

tab_notes:
  added:
    type: event
    description: >
      Recorded when a user creates a new note for a tab.
    notification_emails:
      - sthompson@mozilla.com
    bugs:
      - https://bugzil.la/2003702
    data_reviews:
      - https://bugzil.la/2003702
    data_sensitivity:
      - interaction
    extra_keys:
      source:
        description: >
          Identifies the user interface entry point that resulted in this tab
          note being added. Expected values:
            - `context_menu` # Tab context menu's "Add Note" menu item
            - `hover_menu` # Tab hover preview panel's "Add Note" button
        type: string
    expires: never
  edited:
    type: event
    description: >
      Recorded when a user edits an existing tab note.
    notification_emails:
      - sthompson@mozilla.com
      - jswinarton@mozilla.com
    bugs:
      - https://bugzil.la/2003703
    data_reviews:
      - https://bugzil.la/2003703
    data_sensitivity:
      - interaction
    extra_keys:
      source:
        description: >
          Identifies the user interface entry point that resulted in this tab
          note being edited. Expected values:
            - `context_menu` # Tab context menu's "Update Note" menu item
            - `hover_menu` # Tab hover preview panel's edit note icon button
        type: string
    expires: never
  deleted:
    type: event
    description: >
      Recorded when a user deletes an existing note for a tab.
    notification_emails:
      - sthompson@mozilla.com
      - jswinarton@mozilla.com
    bugs:
      - https://bugzil.la/2003705
    data_reviews:
      - https://bugzil.la/2003705
    data_sensitivity:
      - interaction
    extra_keys:
      source:
        description: >
          Identifies the user interface entry point that resulted in this tab
          note being deleted. Expected values:
            - `context_menu` # Tab context menu's "Delete Note" menu item
            - `hover_menu` # "Delete Note" button in the edit note UI via tab hover preview
        type: string
      note_age_hours:
        description: >
          Number of hours that elapsed since the tab note was first created,
          expressed as an integer (rounded to the nearest full hour).
        type: quantity
    expires: never