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 # Adding a new metric? We have docs for that!
   9 # https://mozilla.github.io/glean/book/user/metrics/adding-new-metrics.html
  10 ---
  11 $schema: moz://mozilla.org/schemas/glean/metrics/2-0-0
  12
  13 mach:
  14   command:
  15     type: string
  16     description: >
  17       The name of the mach command that was invoked, such as "build",
  18       "doc", or "try".
  19     lifetime: application
  20     bugs:
  21       - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053
  22     data_reviews:
  23       - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053#c34
  24     notification_emails:
  25       - build-telemetry@mozilla.com
  26       - mhentges@mozilla.com
  27     expires: never
  28     send_in_pings:
  29       - usage
  30   argv:
  31     type: string_list
  32     description: >
  33       Parameters provided to mach. Absolute paths are sanitized to be relative
  34       to one of a few key base paths, such as the "$topsrcdir", "$topobjdir",
  35       or "$HOME". For example: "/home/mozilla/dev/firefox/python/mozbuild"
  36       would be replaced with "$topsrcdir/python/mozbuild".
  37       If a valid replacement base path cannot be found, the path is replaced
  38       with "<path omitted>".
  39     lifetime: application
  40     bugs:
  41       - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053
  42     data_reviews:
  43       - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053#c34
  44     notification_emails:
  45       - build-telemetry@mozilla.com
  46       - mhentges@mozilla.com
  47     expires: never
  48     send_in_pings:
  49       - usage
  50   success:
  51     type: boolean
  52     description: True if the mach invocation succeeded.
  53     lifetime: application
  54     bugs:
  55       - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053
  56     data_reviews:
  57       - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053#c34
  58     notification_emails:
  59       - build-telemetry@mozilla.com
  60       - mhentges@mozilla.com
  61     expires: never
  62     send_in_pings:
  63       - usage
  64   duration:
  65     type: timespan
  66     description: How long it took for the command to complete.
  67     lifetime: application
  68     bugs:
  69       - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053
  70     data_reviews:
  71       - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053#c34
  72     notification_emails:
  73       - build-telemetry@mozilla.com
  74       - mhentges@mozilla.com
  75     expires: never
  76     send_in_pings:
  77       - usage
  78
  79 mach.system:
  80   cpu_brand:
  81     type: string
  82     description: CPU brand string from CPUID.
  83     lifetime: application
  84     bugs:
  85       - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053
  86     data_reviews:
  87       - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053#c34
  88     notification_emails:
  89       - build-telemetry@mozilla.com
  90       - mhentges@mozilla.com
  91     expires: never
  92     send_in_pings:
  93       - usage
  94   distro:
  95     type: string
  96     description: The name of the operating system distribution.
  97     lifetime: application
  98     bugs:
  99       - https://bugzilla.mozilla.org/show_bug.cgi?id=1655845
 100     data_reviews:
 101       - https://bugzilla.mozilla.org/show_bug.cgi?id=1655845#c3
 102     notification_emails:
 103       - build-telemetry@mozilla.com
 104       - mhentges@mozilla.com
 105     expires: never
 106     send_in_pings:
 107       - usage
 108   distro_version:
 109     type: string
 110     description: The high-level OS version.
 111     lifetime: application
 112     bugs:
 113       - https://bugzilla.mozilla.org/show_bug.cgi?id=1655845
 114     data_reviews:
 115       - https://bugzilla.mozilla.org/show_bug.cgi?id=1655845#c3
 116     notification_emails:
 117       - build-telemetry@mozilla.com
 118       - mhentges@mozilla.com
 119     expires: never
 120     send_in_pings:
 121       - usage
 122   logical_cores:
 123     type: counter
 124     description: Number of logical CPU cores present.
 125     lifetime: application
 126     bugs:
 127       - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053
 128     data_reviews:
 129       - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053#c34
 130     notification_emails:
 131       - build-telemetry@mozilla.com
 132       - mhentges@mozilla.com
 133     expires: never
 134     send_in_pings:
 135       - usage
 136   physical_cores:
 137     type: counter
 138     description: Number of physical CPU cores present.
 139     lifetime: application
 140     bugs:
 141       - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053
 142     data_reviews:
 143       - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053#c34
 144     notification_emails:
 145       - build-telemetry@mozilla.com
 146       - mhentges@mozilla.com
 147     expires: never
 148     send_in_pings:
 149       - usage
 150   memory:
 151     type: memory_distribution
 152     memory_unit: gigabyte
 153     description: Amount of system memory.
 154     lifetime: application
 155     bugs:
 156       - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053
 157     data_reviews:
 158       - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053#c34
 159     notification_emails:
 160       - build-telemetry@mozilla.com
 161       - mhentges@mozilla.com
 162     expires: never
 163     send_in_pings:
 164       - usage
 165   vscode_terminal:
 166     type: boolean
 167     description: True if the current terminal is opened via Visual Studio Code.
 168     lifetime: application
 169     bugs:
 170       - https://bugzilla.mozilla.org/show_bug.cgi?id=1702172
 171     data_reviews:
 172       - https://bugzilla.mozilla.org/show_bug.cgi?id=1702172#c4
 173     notification_emails:
 174       - build-telemetry@mozilla.com
 175       - andi@mozilla.com
 176     expires: never
 177     send_in_pings:
 178       - usage
 179   ssh_connection:
 180     type: boolean
 181     description: True if the current shell is a remote SSH connection.
 182     lifetime: application
 183     bugs:
 184       - https://bugzilla.mozilla.org/show_bug.cgi?id=1702172
 185     data_reviews:
 186       - https://bugzilla.mozilla.org/show_bug.cgi?id=1702172#c4
 187     notification_emails:
 188       - build-telemetry@mozilla.com
 189       - andi@mozilla.com
 190     expires: never
 191     send_in_pings:
 192       - usage
 193   vscode_running:
 194     type: boolean
 195     description: True if there is an instance of vscode running.
 196     lifetime: application
 197     bugs:
 198       - https://bugzilla.mozilla.org/show_bug.cgi?id=1717801
 199     data_reviews:
 200       - https://bugzilla.mozilla.org/show_bug.cgi?id=1717801#c1
 201     notification_emails:
 202       - build-telemetry@mozilla.com
 203       - andi@mozilla.com
 204     expires: never
 205     send_in_pings:
 206       - usage