# 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:
  - 'Toolkit :: Picture-in-Picture'

mini_window:
  created:
    type: event
    description: >
      Recorded when a mini window is created, after the tab has been moved
      into it. A failed move is not recorded.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=2066606
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=2066606
    data_sensitivity:
      - interaction
    notification_emails:
      - hsohaney@mozilla.com
    expires: never
    extra_keys:
      type:
        type: string
        description: >
          "full_tab" for a whole popped-out tab, or "fragment" for one
          framing a region of the page.
      entry_point:
        type: string
        description: >
          Where the user started from, one of: "tab_context_menu",
          "content_context_menu" or "toolbar_button".
      was_last_tab:
        type: boolean
        description: >
          Whether the popped tab was its window's last one, so that a new tab
          was opened in its place.
      concurrent_open:
        type: quantity
        description: >
          How many mini windows are open, counting this one.

  closed:
    type: event
    description: >
      Recorded when a mini window closes, whichever way it was ended.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=2066606
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=2066606
    data_sensitivity:
      - interaction
    notification_emails:
      - hsohaney@mozilla.com
    expires: never
    extra_keys:
      type:
        type: string
        description: >
          "full_tab" for a whole popped-out tab, or "fragment" for one
          framing a region of the page.
      method:
        type: string
        description: >
          How it ended: "put_tab_back", "close_button", "kbd_close_window",
          "kbd_close_tab", "auto_return_guardrail", "origin_window_closed",
          "navigated_away" (a cropped mini window left its page), or
          "unknown".
      duration_ms:
        type: quantity
        description: >
          How long the mini window was open, in milliseconds.

  open_duration:
    type: labeled_timing_distribution
    time_unit: millisecond
    description: >
      How long a mini window stayed open, split by which flavour it was.
    labels:
      - full_tab
      - fragment
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=2066606
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=2066606
    data_sensitivity:
      - interaction
    notification_emails:
      - hsohaney@mozilla.com
    expires: never