metrics.yaml (7598B)
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 - ahochheiden@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 - ahochheiden@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 - ahochheiden@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 - ahochheiden@mozilla.com 75 expires: never 76 send_in_pings: 77 - usage 78 moz_automation: 79 type: boolean 80 description: True if this command is being run on Mozilla Automation/CI 81 lifetime: application 82 bugs: 83 - https://bugzilla.mozilla.org/show_bug.cgi?id=1894154 84 data_reviews: 85 - https://bugzilla.mozilla.org/show_bug.cgi?id=1894154 86 notification_emails: 87 - build-telemetry@mozilla.com 88 - ahochheiden@mozilla.com 89 expires: never 90 send_in_pings: 91 - usage 92 93 mach.system: 94 cpu_brand: 95 type: string 96 description: CPU brand string from CPUID. 97 lifetime: application 98 bugs: 99 - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053 100 data_reviews: 101 - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053#c34 102 notification_emails: 103 - build-telemetry@mozilla.com 104 - ahochheiden@mozilla.com 105 expires: never 106 send_in_pings: 107 - usage 108 distro: 109 type: string 110 description: The name of the operating system distribution. 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 - ahochheiden@mozilla.com 119 expires: never 120 send_in_pings: 121 - usage 122 distro_version: 123 type: string 124 description: The high-level OS version. 125 lifetime: application 126 bugs: 127 - https://bugzilla.mozilla.org/show_bug.cgi?id=1655845 128 data_reviews: 129 - https://bugzilla.mozilla.org/show_bug.cgi?id=1655845#c3 130 notification_emails: 131 - build-telemetry@mozilla.com 132 - ahochheiden@mozilla.com 133 expires: never 134 send_in_pings: 135 - usage 136 logical_cores: 137 type: counter 138 description: Number of logical 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 - ahochheiden@mozilla.com 147 expires: never 148 send_in_pings: 149 - usage 150 physical_cores: 151 type: counter 152 description: Number of physical CPU cores present. 153 lifetime: application 154 bugs: 155 - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053 156 data_reviews: 157 - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053#c34 158 notification_emails: 159 - build-telemetry@mozilla.com 160 - ahochheiden@mozilla.com 161 expires: never 162 send_in_pings: 163 - usage 164 memory: 165 type: memory_distribution 166 memory_unit: gigabyte 167 description: Amount of system memory. 168 lifetime: application 169 bugs: 170 - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053 171 data_reviews: 172 - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053#c34 173 notification_emails: 174 - build-telemetry@mozilla.com 175 - ahochheiden@mozilla.com 176 expires: never 177 send_in_pings: 178 - usage 179 vscode_terminal: 180 type: boolean 181 description: True if the current terminal is opened via Visual Studio Code. 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 ssh_connection: 194 type: boolean 195 description: True if the current shell is a remote SSH connection. 196 lifetime: application 197 bugs: 198 - https://bugzilla.mozilla.org/show_bug.cgi?id=1702172 199 data_reviews: 200 - https://bugzilla.mozilla.org/show_bug.cgi?id=1702172#c4 201 notification_emails: 202 - build-telemetry@mozilla.com 203 - andi@mozilla.com 204 expires: never 205 send_in_pings: 206 - usage 207 vscode_running: 208 type: boolean 209 description: True if there is an instance of vscode running. 210 lifetime: application 211 bugs: 212 - https://bugzilla.mozilla.org/show_bug.cgi?id=1717801 213 data_reviews: 214 - https://bugzilla.mozilla.org/show_bug.cgi?id=1717801#c1 215 notification_emails: 216 - build-telemetry@mozilla.com 217 - andi@mozilla.com 218 expires: never 219 send_in_pings: 220 - usage 221 fleet_running: 222 type: boolean 223 description: True if FleetDM endpoint management tool is running. 224 lifetime: application 225 bugs: 226 - https://bugzilla.mozilla.org/show_bug.cgi?id=1982531 227 data_reviews: 228 - https://bugzilla.mozilla.org/show_bug.cgi?id=1982531 229 notification_emails: 230 - build-telemetry@mozilla.com 231 expires: never 232 send_in_pings: 233 - usage 234 crowdstrike_running: 235 type: boolean 236 description: True if CrowdStrike security software is running. 237 lifetime: application 238 bugs: 239 - https://bugzilla.mozilla.org/show_bug.cgi?id=1982531 240 data_reviews: 241 - https://bugzilla.mozilla.org/show_bug.cgi?id=1982531 242 notification_emails: 243 - build-telemetry@mozilla.com 244 expires: never 245 send_in_pings: 246 - usage