dom/quota/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 :: Storage: Quota Manager'
  12
  13 dom.quota.try:
  14   error_step:
  15     type: event
  16     description: >
  17       An event recorded on an error of the quota manager or its clients.
  18       Since errors are usually propagated up the call chain, all such
  19       propagation steps are recorded for an error. This is only active
  20       during specific contexts, in particular during storage
  21       initialization. No dynamic data is included in the event beyond the
  22       error code which will be added through Bug 1670555.
  23       This event was generated to correspond to the Legacy Telemetry event
  24       dom.quota.try.error#step.
  25     bugs:
  26       - https://bugzil.la/1665088
  27     data_reviews:
  28       - https://bugzil.la/1665088
  29     notification_emails:
  30       - jvarga@mozilla.com
  31       - storage-telemetry@mozilla.com
  32     expires: never
  33     extra_keys:
  34       context:
  35         description: >
  36           The context in which the error occurred, e.g. during a storage initialization.
  37           Telemetry events are only emitted for selected contexts.
  38         type: string
  39       frame_id:
  40         description: >
  41           Optionally, the frame within stack_id.
  42         type: string
  43       process_id:
  44         description: >
  45           Optionally, the process in which the error occured.
  46         type: string
  47       result:
  48         description: >
  49           Optionally, the name of the error that occurred.
  50         type: string
  51       seq:
  52         description: >
  53           Sequence number.
  54         type: quantity
  55       severity:
  56         description: >
  57           One of WARNING or ERROR.
  58         type: string
  59       source_file:
  60         description: >
  61           The name of the source code file where the error occurred.
  62         type: string
  63       source_line:
  64         description: >
  65           The line within source_file where the error occurred.
  66         type: quantity
  67       stack_id:
  68         description: >
  69           Optionally, the stack within process_id.
  70         type: string
  71     telemetry_mirror: DomQuotaTry_Error_Step
  72 quotamanager.initialize.repository:
  73   number_of_iterations:
  74     type: labeled_custom_distribution
  75     description: >
  76       This metric logs the count of directory entries iterated within the
  77       QuotaManager::InitializeRepository function for each repository type.
  78       Each instance of this metric is labeled with one of three repository
  79       types: "persistent", "temporary" or "default" (there's also "private"
  80       repository but that should never be iterated by the function).
  81       The main purpose is to track and analyze iteration counts during the
  82       initialization process of each repository type, helping to identify
  83       performance trends or potential inefficiencies across these repositories.
  84       This can provide insight into the impacts of specific code changes,
  85       including potential optimizations or regressions.
  86     range_min: 0
  87     range_max: 65535
  88     bucket_count: 50
  89     histogram_type: exponential
  90     unit: integer
  91     bugs:
  92       - https://bugzilla.mozilla.org/show_bug.cgi?id=1927260
  93     data_reviews:
  94       - https://bugzilla.mozilla.org/show_bug.cgi?id=1927260
  95     data_sensitivity:
  96       - technical
  97     notification_emails:
  98       - jvarga@mozilla.com
  99       - storage-telemetry@mozilla.com
 100     expires: never
 101     labels:
 102       - persistent
 103       - temporary
 104       - default
 105       - private