summaryrefslogtreecommitdiffstats
path: root/python/mach/metrics.yaml
blob: 16b2aa28776cf0926cc376ebcc589ae71744e7ce (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.

# If this file is changed, update the generated docs:
# https://firefox-source-docs.mozilla.org/mach/telemetry.html#updating-generated-metrics-docs

# Adding a new metric? We have docs for that!
# https://mozilla.github.io/glean/book/user/metrics/adding-new-metrics.html
---
$schema: moz://mozilla.org/schemas/glean/metrics/2-0-0

mach:
  command:
    type: string
    description: >
      The name of the mach command that was invoked, such as "build",
      "doc", or "try".
    lifetime: application
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053#c34
    notification_emails:
      - build-telemetry@mozilla.com
      - mhentges@mozilla.com
    expires: never
    send_in_pings:
      - usage
  argv:
    type: string_list
    description: >
      Parameters provided to mach. Absolute paths are sanitized to be relative
      to one of a few key base paths, such as the "$topsrcdir", "$topobjdir",
      or "$HOME". For example: "/home/mozilla/dev/firefox/python/mozbuild"
      would be replaced with "$topsrcdir/python/mozbuild".
      If a valid replacement base path cannot be found, the path is replaced
      with "<path omitted>".
    lifetime: application
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053#c34
    notification_emails:
      - build-telemetry@mozilla.com
      - mhentges@mozilla.com
    expires: never
    send_in_pings:
      - usage
  success:
    type: boolean
    description: True if the mach invocation succeeded.
    lifetime: application
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053#c34
    notification_emails:
      - build-telemetry@mozilla.com
      - mhentges@mozilla.com
    expires: never
    send_in_pings:
      - usage
  duration:
    type: timespan
    description: How long it took for the command to complete.
    lifetime: application
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053#c34
    notification_emails:
      - build-telemetry@mozilla.com
      - mhentges@mozilla.com
    expires: never
    send_in_pings:
      - usage

mach.system:
  cpu_brand:
    type: string
    description: CPU brand string from CPUID.
    lifetime: application
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053#c34
    notification_emails:
      - build-telemetry@mozilla.com
      - mhentges@mozilla.com
    expires: never
    send_in_pings:
      - usage
  distro:
    type: string
    description: The name of the operating system distribution.
    lifetime: application
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1655845
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1655845#c3
    notification_emails:
      - build-telemetry@mozilla.com
      - mhentges@mozilla.com
    expires: never
    send_in_pings:
      - usage
  distro_version:
    type: string
    description: The high-level OS version.
    lifetime: application
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1655845
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1655845#c3
    notification_emails:
      - build-telemetry@mozilla.com
      - mhentges@mozilla.com
    expires: never
    send_in_pings:
      - usage
  logical_cores:
    type: counter
    description: Number of logical CPU cores present.
    lifetime: application
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053#c34
    notification_emails:
      - build-telemetry@mozilla.com
      - mhentges@mozilla.com
    expires: never
    send_in_pings:
      - usage
  physical_cores:
    type: counter
    description: Number of physical CPU cores present.
    lifetime: application
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053#c34
    notification_emails:
      - build-telemetry@mozilla.com
      - mhentges@mozilla.com
    expires: never
    send_in_pings:
      - usage
  memory:
    type: memory_distribution
    memory_unit: gigabyte
    description: Amount of system memory.
    lifetime: application
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1291053#c34
    notification_emails:
      - build-telemetry@mozilla.com
      - mhentges@mozilla.com
    expires: never
    send_in_pings:
      - usage
  vscode_terminal:
    type: boolean
    description: True if the current terminal is opened via Visual Studio Code.
    lifetime: application
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1702172
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1702172#c4
    notification_emails:
      - build-telemetry@mozilla.com
      - andi@mozilla.com
    expires: never
    send_in_pings:
      - usage
  ssh_connection:
    type: boolean
    description: True if the current shell is a remote SSH connection.
    lifetime: application
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1702172
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1702172#c4
    notification_emails:
      - build-telemetry@mozilla.com
      - andi@mozilla.com
    expires: never
    send_in_pings:
      - usage
  vscode_running:
    type: boolean
    description: True if there is an instance of vscode running.
    lifetime: application
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1717801
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1717801#c1
    notification_emails:
      - build-telemetry@mozilla.com
      - andi@mozilla.com
    expires: never
    send_in_pings:
      - usage