toolkit/components/telemetry/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 # This file is for Internal Telemetry Use Only.
   6 # Please don't add anything here unless you have the permission of a
   7 # Telemetry Module Peer.
   8
   9 ---
  10 $schema: moz://mozilla.org/schemas/glean/metrics/2-0-0
  11 $tags:
  12   - "Toolkit :: Telemetry"
  13
  14 legacy.telemetry:
  15   client_id:
  16     type: uuid
  17     lifetime: application
  18     description: |
  19       The client_id according to Telemetry.
  20       Might not always have a value due to being too early for it to have
  21       loaded.
  22       Value may be the canary client id `c0ffeec0-ffee-c0ff-eec0-ffeec0ffeec0`
  23       in pings near when the data upload pref is disabled (if Telemetry gets
  24       to go first), or between when a client_id has been removed and when it
  25       has been regenerated.
  26       Does not need to be sent in the Glean "deletion-request" ping.
  27     bugs:
  28       - https://bugzilla.mozilla.org/show_bug.cgi?id=1755549
  29       - https://bugzilla.mozilla.org/show_bug.cgi?id=1921440
  30     data_reviews:
  31       - https://bugzilla.mozilla.org/show_bug.cgi?id=1755549
  32       - https://bugzilla.mozilla.org/show_bug.cgi?id=1921440
  33     data_sensitivity:
  34       - technical
  35       - highly_sensitive
  36     notification_emails:
  37       - chutten@mozilla.com
  38       - glean-team@mozilla.com
  39     expires: never
  40     no_lint:
  41       - BASELINE_PING
  42     send_in_pings: &client_id_pings
  43       - 'metrics'
  44       - 'events'
  45       - 'newtab'
  46       - 'baseline'
  47
  48   profile_group_id:
  49     type: uuid
  50     lifetime: application
  51     description: |
  52       The profile_group_id according to Telemetry.
  53       Might not always have a value due to being too early for it to have
  54       loaded.
  55       Does not need to be sent in the Glean "deletion-request" ping.
  56     bugs:
  57       - https://bugzilla.mozilla.org/show_bug.cgi?id=1901263
  58     data_reviews:
  59       - https://bugzilla.mozilla.org/show_bug.cgi?id=1901263
  60     data_sensitivity:
  61       - technical
  62       - highly_sensitive
  63     notification_emails:
  64       - dtownsend@mozilla.com
  65       - glean-team@mozilla.com
  66     expires: never
  67     no_lint:
  68       - BASELINE_PING
  69     send_in_pings: *client_id_pings
  70
  71 telemetry:
  72   data_upload_optin:
  73     type: boolean
  74     description: >
  75       User opted into sending Telemetry data again.
  76       This metric was generated to correspond to the Legacy Telemetry
  77       scalar telemetry.data_upload_optin.
  78     bugs:
  79       - https://bugzil.la/1445921
  80     data_reviews:
  81       - https://bugzil.la/1445921
  82     notification_emails:
  83       - jrediger@mozilla.com
  84       - telemetry-client-dev@mozilla.com
  85     expires: never
  86     telemetry_mirror: TELEMETRY_DATA_UPLOAD_OPTIN
  87
  88 usage:
  89   profile_id:
  90     type: uuid
  91     lifetime: user
  92     description: |
  93       A UUID uniquely identifying the profile,
  94       not shared with other telemetry data.
  95     bugs:
  96       - https://bugzilla.mozilla.org/show_bug.cgi?id=1926829
  97     data_reviews:
  98       - https://bugzilla.mozilla.org/show_bug.cgi?id=1926829
  99     data_sensitivity:
 100       - technical
 101       - highly_sensitive
 102     notification_emails:
 103       - glean-team@mozilla.com
 104       - jrediger@mozilla.com
 105       - loines@mozilla.com
 106     expires: never
 107     send_in_pings:
 108       - usage-reporting
 109       - usage-deletion-request
 110
 111 browser.engagement:
 112   session_time_including_suspend:
 113     type: quantity
 114     description: >
 115       The duration of the session in milliseconds, including the time the
 116       device was suspended.
 117       This metric was generated to correspond to the Legacy Telemetry
 118       scalar browser.engagement.session_time_including_suspend.
 119     bugs:
 120       - https://bugzil.la/1205985
 121     data_reviews:
 122       - https://bugzil.la/1205985
 123     notification_emails:
 124       - padenot@mozilla.com
 125     expires: never
 126     unit: ms
 127     telemetry_mirror: BROWSER_ENGAGEMENT_SESSION_TIME_INCLUDING_SUSPEND
 128
 129   session_time_excluding_suspend:
 130     type: quantity
 131     description: >
 132       The duration of the session in milliseconds, excluding the time the
 133       device was suspended.
 134       This metric was generated to correspond to the Legacy Telemetry
 135       scalar browser.engagement.session_time_excluding_suspend.
 136     bugs:
 137       - https://bugzil.la/1205985
 138     data_reviews:
 139       - https://bugzil.la/1205985
 140     notification_emails:
 141       - padenot@mozilla.com
 142     expires: never
 143     unit: ms
 144     telemetry_mirror: BROWSER_ENGAGEMENT_SESSION_TIME_EXCLUDING_SUSPEND
 145
 146 browser.timings:
 147   last_shutdown:
 148     type: quantity
 149     description: >
 150       The time, in milliseconds, it took to complete the last shutdown. On
 151       successful shutdown, Telemetry saves this to disk into
 152       Telemetry.ShutdownTime.txt. On the next startup this is loaded and
 153       recorded.
 154       This metric was generated to correspond to the Legacy Telemetry
 155       scalar browser.timings.last_shutdown.
 156     bugs:
 157       - https://bugzil.la/1429510
 158     data_reviews:
 159       - https://bugzil.la/1429510
 160     notification_emails:
 161       - perf-telemetry-alerts@mozilla.com
 162       - florian@mozilla.com
 163     expires: never
 164     unit: ms
 165     telemetry_mirror: BROWSER_TIMINGS_LAST_SHUTDOWN