summaryrefslogtreecommitdiffstats
path: root/dom/media/webrtc/metrics.yaml
blob: dfa8c120f136709a459dafd40f41fa8e2594a4a7 (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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
# 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/.

# Adding a new metric? We have docs for that!
# https://firefox-source-docs.mozilla.org/toolkit/components/glean/user/new_definitions_file.html

---
$schema: moz://mozilla.org/schemas/glean/metrics/2-0-0
$tags:
  - 'Core :: WebRTC'

rtcrtpsender:
  count:
    type: counter
    description: >
      The number of RTCRtpSenders created.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1401592
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1832459
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1881403
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1401592
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1832459
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1881403
    data_sensitivity:
      - technical
    notification_emails:
      - webrtc-telemetry-alerts@mozilla.com
    expires: 132

  count_setparameters_compat:
    type: counter
    description: >
      The number of RTCRtpSenders created that use the compatibility mode for
      setParameters.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1401592
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1832459
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1881403
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1401592
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1832459
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1881403
    data_sensitivity:
      - technical
    notification_emails:
      - webrtc-telemetry-alerts@mozilla.com
    expires: 132

  used_sendencodings:
    type: rate
    description: >
      The proportion of RTCRtpSenders that were created by an addTransceivers
      call that was passed a sendEncodings.
    denominator_metric: rtcrtpsender.count
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1401592
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1832459
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1881403
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1401592
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1832459
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1881403
    data_sensitivity:
      - technical
    notification_emails:
      - webrtc-telemetry-alerts@mozilla.com
    expires: 132

rtcrtpsender.setparameters:
  warn_no_getparameters:
    type: rate
    description: >
      The proportion of RTCRtpSenders configured with the setParameters compat
      mode that have warned at least once about a setParameters call because
      [[LastReturnedParameters]] was not set.  (ie; there was not a recent
      enough call to getParameters)
    denominator_metric: rtcrtpsender.count_setparameters_compat
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1401592
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1832459
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1881403
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1401592
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1832459
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1881403
    data_sensitivity:
      - technical
    notification_emails:
      - webrtc-telemetry-alerts@mozilla.com
    expires: 132

  blame_no_getparameters:
    type: labeled_counter
    description: >
      The number of RTCRtpSenders that have warned at least once about
      a `setParameters` call because `[[LastReturnedParameters]]` was not set,
      broken down by the eTLD+1 of the site. (ie; there was not a recent
      enough call to `getParameters`) Collected only on EARLY_BETA_OR_EARLIER.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1831343
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1881403
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1831343
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1881403
    data_sensitivity:
      - web_activity
    notification_emails:
      - webrtc-telemetry-alerts@mozilla.com
    expires: 132

  warn_length_changed:
    type: rate
    description: >
      The proportion of RTCRtpSenders configured with the setParameters compat
      mode that have warned at least once about a setParameters call that
      attempted to change the number of encodings.
    denominator_metric: rtcrtpsender.count_setparameters_compat
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1401592
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1832459
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1881403
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1401592
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1832459
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1881403
    data_sensitivity:
      - technical
    notification_emails:
      - webrtc-telemetry-alerts@mozilla.com
    expires: 132

  blame_length_changed:
    type: labeled_counter
    description: >
      The number of RTCRtpSenders that have warned at least once about a
      `setParameters` call that attempted to change the number of encodings,
      broken down by the eTLD+1 of the site. Collected only on
      EARLY_BETA_OR_EARLIER.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1831343
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1881403
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1831343
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1881403
    data_sensitivity:
      - web_activity
    notification_emails:
      - webrtc-telemetry-alerts@mozilla.com
    expires: 132

  warn_no_transactionid:
    type: rate
    description: >
      The proportion of RTCRtpSenders configured with the setParameters compat
      mode that have warned at least once about a setParameters call that did
      not set the transactionId field.
    denominator_metric: rtcrtpsender.count_setparameters_compat
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1401592
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1832459
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1881403
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1401592
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1832459
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1881403
    data_sensitivity:
      - technical
    notification_emails:
      - webrtc-telemetry-alerts@mozilla.com
    expires: 132

  blame_no_transactionid:
    type: labeled_counter
    description: >
      The number of RTCRtpSenders that have warned at least once about a
      `setParameters` call that did not set the transactionId field, broken down
      by the eTLD+1 of the site. Collected only on EARLY_BETA_OR_EARLIER.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1831343
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1881403
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1831343
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1881403
    data_sensitivity:
      - web_activity
    notification_emails:
      - webrtc-telemetry-alerts@mozilla.com
    expires: 132

  fail_length_changed:
    type: rate
    description: >
      The proportion of RTCRtpSenders that have thrown an error at least once
      about a setParameters call that attempted to change the number of
      encodings.
    denominator_metric: rtcrtpsender.count
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1401592
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1832459
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1881403
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1401592
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1832459
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1881403
    data_sensitivity:
      - technical
    notification_emails:
      - webrtc-telemetry-alerts@mozilla.com
    expires: 132

  fail_rid_changed:
    type: rate
    description: >
      The proportion of RTCRtpSenders that have thrown an error at least once
      about a setParameters call that attempted to change the rid on an
      encoding (note that we only check this if the encoding count did not
      change, see fail_length_changed).
    denominator_metric: rtcrtpsender.count
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1401592
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1832459
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1881403
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1401592
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1832459
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1881403
    data_sensitivity:
      - technical
    notification_emails:
      - webrtc-telemetry-alerts@mozilla.com
    expires: 132

  fail_no_getparameters:
    type: rate
    description: >
      The proportion of RTCRtpSenders that have thrown an error at least once
      about a setParameters call because [[LastReturnedParameters]] was not set.
      (ie; there was not a recent enough call to getParameters)
    denominator_metric: rtcrtpsender.count
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1401592
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1832459
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1881403
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1401592
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1832459
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1881403
    data_sensitivity:
      - technical
    notification_emails:
      - webrtc-telemetry-alerts@mozilla.com
    expires: 132

  fail_no_transactionid:
    type: rate
    description: >
      The proportion of RTCRtpSenders that have thrown an error at least once
      about a setParameters call that did not set the transactionId field.
    denominator_metric: rtcrtpsender.count
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1401592
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1832459
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1881403
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1401592
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1832459
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1881403
    data_sensitivity:
      - technical
    notification_emails:
      - webrtc-telemetry-alerts@mozilla.com
    expires: 132

  fail_stale_transactionid:
    type: rate
    description: >
      The proportion of RTCRtpSenders that have thrown an error at least once
      about a setParameters call that used a stale transaction id.
    denominator_metric: rtcrtpsender.count
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1401592
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1832459
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1881403
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1401592
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1832459
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1881403
    data_sensitivity:
      - technical
    notification_emails:
      - webrtc-telemetry-alerts@mozilla.com
    expires: 132

  fail_no_encodings:
    type: rate
    description: >
      The proportion of RTCRtpSenders configured with the setParameters compat
      mode that have thrown an error at least once about a setParameters call
      that had no encodings (we do not measure this against the general
      population of RTCRtpSenders, since without the compat mode this failure
      is never observed, because it fails the length change check).
    denominator_metric: rtcrtpsender.count_setparameters_compat
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1401592
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1832459
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1881403
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1401592
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1832459
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1881403
    data_sensitivity:
      - technical
    notification_emails:
      - webrtc-telemetry-alerts@mozilla.com
    expires: 132

  fail_other:
    type: rate
    description: >
      The proportion of RTCRtpSenders that have thrown an error at least once
      about a setParameters call that had no encodings.
    denominator_metric: rtcrtpsender.count
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1401592
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1832459
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1881403
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1401592
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1832459
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1881403
    data_sensitivity:
      - technical
    notification_emails:
      - webrtc-telemetry-alerts@mozilla.com
    expires: 132

codec.stats:
  ulpfec_negotiated:
    type: labeled_counter
    description: >
      Counts the number of times that ulpfec is negotiated or not negotiated
      on the first negotiation for each video transceiver.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1858213
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1881396
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1858213
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1881396
    data_sensitivity:
      - technical
    notification_emails:
      - webrtc-telemetry-alerts@mozilla.com
    expires: 132
    labels:
      - negotiated
      - not_negotiated

  other_fec_signaled:
    type: labeled_counter
    description: >
      Count how many other fec options are being offered.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1858213
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1881396
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1858213
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1881396
    data_sensitivity:
      - technical
    notification_emails:
      - webrtc-telemetry-alerts@mozilla.com
    expires: 132

  video_preferred_codec:
    type: labeled_counter
    description: >
      Counts the preferred video codec being signaled to us to identify preferred video codec.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1858213
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1881396
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1858213
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1881396
    data_sensitivity:
      - technical
    notification_emails:
      - webrtc-telemetry-alerts@mozilla.com
    expires: 132

  audio_preferred_codec:
    type: labeled_counter
    description: >
      Counts the preferred audio codec being signaled to us to identify preferred audio codec.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1858213
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1881396
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1858213
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1881396
    data_sensitivity:
      - technical
    notification_emails:
      - webrtc-telemetry-alerts@mozilla.com
    expires: 132

webrtcdtls:
  protocol_version:
    type: labeled_counter
    description: >
      The version of DTLS used for each webrtc connection. Can be 1.0, 1.2, or 1.3 (there is no 1.1 version of DTLS)
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1884140
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1884140
    data_sensitivity:
      - technical
    notification_emails:
      - webrtc-telemetry-alerts@mozilla.com
    expires: 135

  cipher:
    type: labeled_counter
    description: >
      The CipherSuite used for each webrtc DTLS connection, as a string
      representation of the CipherSuite's ID in 4 hex digits (eg;
      TLS_DHE_RSA_WITH_AES_128_CBC_SHA would be "0x0033")
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1884140
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1884140
    data_sensitivity:
      - technical
    notification_emails:
      - webrtc-telemetry-alerts@mozilla.com
    expires: 135

  srtp_cipher:
    type: labeled_counter
    description: >
      The SRTPProtectionProfile (see RFC 5764) used for each webrtc SRTP
      connection, as a string representation of the SRTPProtectionProfile's ID
      in 4 hex digits (eg; SRTP_AES128_CM_HMAC_SHA1_80 would be "0x0001")
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1884140
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1884140
    data_sensitivity:
      - technical
    notification_emails:
      - webrtc-telemetry-alerts@mozilla.com
    expires: 135

  client_handshake_result:
    type: labeled_counter
    description: >
      The result of each webrtc client DTLS handshake as a string containing
      either the name of the error code (eg; SSL_ERROR_BAD_CERTIFICATE),
      SUCCESS for successful handshakes, ALPN_FAILURE when ALPN negotiation
      fails, or CERT_FAILURE when cert validation fails.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1884140
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1884140
    data_sensitivity:
      - technical
    notification_emails:
      - webrtc-telemetry-alerts@mozilla.com
    expires: 135

  server_handshake_result:
    type: labeled_counter
    description: >
      The result of each webrtc server DTLS handshake, as the name of the error
      code (eg; SSL_ERROR_BAD_CERTIFICATE), the empty string for successful
      handshakes, ALPN_FAILURE when ALPN negotiation fails, or CERT_FAILURE when
      cert validation fails.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1884140
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1884140
    data_sensitivity:
      - technical
    notification_emails:
      - webrtc-telemetry-alerts@mozilla.com
    expires: 135