dom/media/metrics.yaml

   1 # This Source Code Form is subject to the terms of the Mozilla Public
   2 # License, v. 2.0. If a copy of the MPL was not distributed with this
   3 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
   4
   5 # Adding a new metric? We have docs for that!
   6 # https://firefox-source-docs.mozilla.org/toolkit/components/glean/user/new_definitions_file.html
   7
   8 ---
   9 $schema: moz://mozilla.org/schemas/glean/metrics/2-0-0
  10 $tags:
  11   - 'Core :: Audio/Video'
  12
  13 gmp:
  14   update_xml_fetch_result:
  15     type: labeled_counter
  16     labels:
  17       - cert_pin_success
  18       - cert_pin_net_request_error
  19       - cert_pin_net_timeout
  20       - cert_pin_abort
  21       - cert_pin_missing_data
  22       - cert_pin_failed
  23       - cert_pin_invalid
  24       - cert_pin_xml_parse_error
  25       - cert_pin_unknown_error
  26       - content_sig_success
  27       - content_sig_net_request_error
  28       - content_sig_net_timeout
  29       - content_sig_abort
  30       - content_sig_missing_data
  31       - content_sig_failed
  32       - content_sig_invalid
  33       - content_sig_xml_parse_error
  34       - content_sig_unknown_error
  35     description: >
  36       The result of Gecko fetching an update.xml from Balrog.
  37       This captures 3 different data points: success or failure of the request,
  38       if cert pinning or content signatures were used to verify the result, and
  39       the reason for failure, if the request failed.
  40     metadata:
  41       tags:
  42         - 'Core :: Audio/Video: GMP'
  43     bugs:
  44       - https://bugzilla.mozilla.org/show_bug.cgi?id=1739664
  45     data_reviews:
  46       - https://bugzilla.mozilla.org/show_bug.cgi?id=1739664
  47     data_sensitivity:
  48       - technical
  49     notification_emails:
  50       - media-alerts@mozilla.com
  51     expires: never
  52
  53 media.audio:
  54   init_failure:
  55     type: labeled_counter
  56     labels:
  57       - first
  58       - other
  59     description: >
  60       Failure occurs when initializing the audio stream.
  61       (Migrated from the geckoview metric of the same name).
  62     bugs:
  63       - https://bugzilla.mozilla.org/show_bug.cgi?id=1671714
  64       - https://bugzilla.mozilla.org/show_bug.cgi?id=1879192
  65     data_reviews:
  66       - https://bugzilla.mozilla.org/show_bug.cgi?id=1671714#c10
  67     notification_emails:
  68       - media-alerts@mozilla.com
  69     expires: never
  70
  71   backend:
  72     type: labeled_counter
  73     labels:
  74       - unknown
  75       - audiounit
  76       - audiounit-rust
  77       - aaudio
  78       - opensl
  79       - wasapi
  80       - winmm
  81       - alsa
  82       - jack
  83       - oss
  84       - pulse
  85       - pulse-rust
  86       - sndio
  87       - sunaudio
  88     description: >
  89       The operating system audio backend
  90       (Migrated from the geckoview metric of the same name).
  91     bugs:
  92       - https://bugzilla.mozilla.org/show_bug.cgi?id=1671714
  93       - https://bugzilla.mozilla.org/show_bug.cgi?id=1879192
  94     data_reviews:
  95       - https://bugzilla.mozilla.org/show_bug.cgi?id=1671714#c10
  96     notification_emails:
  97       - media-alerts@mozilla.com
  98     expires: never
  99
 100 media.playback:
 101   first_frame_loaded:
 102     type: event
 103     description:
 104       The time that the media pipeline takes to load the first video frame.
 105     metadata:
 106       tags:
 107         - 'Core :: Audio/Video: Playback'
 108     bugs:
 109       - https://bugzilla.mozilla.org/show_bug.cgi?id=1882205
 110     data_reviews:
 111       - https://bugzilla.mozilla.org/show_bug.cgi?id=1882205
 112     data_sensitivity:
 113       - technical
 114     notification_emails:
 115       - media-alerts@mozilla.com
 116     extra_keys:
 117       first_frame_loaded_time:
 118         description:
 119           How long (in milliseconds) does the our media pipeline take to load
 120           the first video frame from "the creation of MDSM" to "the first frame
 121           loaded".
 122         type: quantity
 123       metadata_loaded_time:
 124         description:
 125           How long (in milliseconds) does the our media pipeline take to load
 126           the metadata, which happens before finishing loading the first frame.
 127         type: quantity
 128       total_waiting_data_time:
 129         description:
 130           How long (in milliseconds) does the our media pipeline has been in a
 131           state of waiting video data due to lacking of data before the first
 132           frame is loaded.
 133         type: quantity
 134       buffering_time:
 135         description:
 136           How long (in milliseconds) does the our media pipeline has been spent
 137           on the buffering state before the first frame is loaded.
 138         type: quantity
 139       playback_type:
 140         description:
 141           The type of the playback. The value could be one of following
 142           (1) Non-MSE playback
 143           (2) MSE playback
 144           (3) EME playback
 145           // Following are Windows-only
 146           (4) Non-MSE media-engine playback
 147           (5) MSE media-engine playback
 148           (6) EME media-engine playback
 149         type: string
 150       video_codec:
 151         description: The video codec used for playback
 152         type: string
 153       resolution:
 154         description: The video resolution used for playback
 155         type: string
 156       key_system:
 157         description: The key system used for the EME playback if exists
 158         type: string
 159       hls_decoder:
 160         description:
 161           This value will only be set on Android. It tells that whether playback
 162           is performed by the HLS decoder, which utilizes the external player to
 163           play video.
 164         type: boolean
 165       is_hardware_decoding:
 166         description: True if the first frame is decoded by a hardware decoder.
 167         type: boolean
 168     expires: never