python/mach/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 # If this file is changed, update the generated docs:
   6 # https://firefox-source-docs.mozilla.org/mach/telemetry.html#updating-generated-metrics-docs
   7 ---
   8 $schema: moz://mozilla.org/schemas/glean/metrics/1-0-0
   9
  10 mach:
  11   command:
  12     type: string
  13     description: >
  14       The name of the mach command that was invoked, such as "build",
  15       "doc", or "try".
  16     lifetime: application
  17     bugs:
  18       - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053
  19     data_reviews:
  20       - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053#c34
  21     notification_emails:
  22       - build-telemetry@mozilla.com
  23       - mhentges@mozilla.com
  24     expires: never
  25     send_in_pings:
  26       - usage
  27   argv:
  28     type: string_list
  29     description: >
  30       Parameters provided to mach. Absolute paths are sanitized to be relative
  31       to one of a few key base paths, such as the "$topsrcdir", "$topobjdir",
  32       or "$HOME". For example: "/home/mozilla/dev/firefox/python/mozbuild"
  33       would be replaced with "$topsrcdir/python/mozbuild".
  34       If a valid replacement base path cannot be found, the path is replaced
  35       with "<path omitted>".
  36     lifetime: application
  37     bugs:
  38       - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053
  39     data_reviews:
  40       - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053#c34
  41     notification_emails:
  42       - build-telemetry@mozilla.com
  43       - mhentges@mozilla.com
  44     expires: never
  45     send_in_pings:
  46       - usage
  47   success:
  48     type: boolean
  49     description: True if the mach invocation succeeded.
  50     lifetime: application
  51     bugs:
  52       - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053
  53     data_reviews:
  54       - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053#c34
  55     notification_emails:
  56       - build-telemetry@mozilla.com
  57       - mhentges@mozilla.com
  58     expires: never
  59     send_in_pings:
  60       - usage
  61   duration:
  62     type: timespan
  63     description: How long it took for the command to complete.
  64     lifetime: application
  65     bugs:
  66       - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053
  67     data_reviews:
  68       - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053#c34
  69     notification_emails:
  70       - build-telemetry@mozilla.com
  71       - mhentges@mozilla.com
  72     expires: never
  73     send_in_pings:
  74       - usage
  75
  76 mach.system:
  77   cpu_brand:
  78     type: string
  79     description: CPU brand string from CPUID.
  80     lifetime: application
  81     bugs:
  82       - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053
  83     data_reviews:
  84       - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053#c34
  85     notification_emails:
  86       - build-telemetry@mozilla.com
  87       - mhentges@mozilla.com
  88     expires: never
  89     send_in_pings:
  90       - usage
  91   distro:
  92     type: string
  93     description: The name of the operating system distribution.
  94     lifetime: application
  95     bugs:
  96       - https://bugzilla.mozilla.org/show_bug.cgi?id=1655845
  97     data_reviews:
  98       - https://bugzilla.mozilla.org/show_bug.cgi?id=1655845#c3
  99     notification_emails:
 100       - build-telemetry@mozilla.com
 101       - mhentges@mozilla.com
 102     expires: never
 103     send_in_pings:
 104       - usage
 105   distro_version:
 106     type: string
 107     description: The high-level OS version.
 108     lifetime: application
 109     bugs:
 110       - https://bugzilla.mozilla.org/show_bug.cgi?id=1655845
 111     data_reviews:
 112       - https://bugzilla.mozilla.org/show_bug.cgi?id=1655845#c3
 113     notification_emails:
 114       - build-telemetry@mozilla.com
 115       - mhentges@mozilla.com
 116     expires: never
 117     send_in_pings:
 118       - usage
 119   logical_cores:
 120     type: counter
 121     description: Number of logical CPU cores present.
 122     lifetime: application
 123     bugs:
 124       - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053
 125     data_reviews:
 126       - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053#c34
 127     notification_emails:
 128       - build-telemetry@mozilla.com
 129       - mhentges@mozilla.com
 130     expires: never
 131     send_in_pings:
 132       - usage
 133   physical_cores:
 134     type: counter
 135     description: Number of physical CPU cores present.
 136     lifetime: application
 137     bugs:
 138       - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053
 139     data_reviews:
 140       - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053#c34
 141     notification_emails:
 142       - build-telemetry@mozilla.com
 143       - mhentges@mozilla.com
 144     expires: never
 145     send_in_pings:
 146       - usage
 147   memory:
 148     type: memory_distribution
 149     memory_unit: gigabyte
 150     description: Amount of system memory.
 151     lifetime: application
 152     bugs:
 153       - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053
 154     data_reviews:
 155       - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053#c34
 156     notification_emails:
 157       - build-telemetry@mozilla.com
 158       - mhentges@mozilla.com
 159     expires: never
 160     send_in_pings:
 161       - usage