summaryrefslogtreecommitdiffstats
path: root/toolkit/components/translations/metrics.yaml
blob: 01e77c46bdda395aa1f7bd51e3c06982b7b809d7 (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
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
# 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:
  - 'Firefox :: Translation'

translations:
  requests_count:
    type: counter
    description: >
      The count of translation requests.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836436
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836436
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_sensitivity:
      - technical
    notification_emails:
      - translations-telemetry-alerts@mozilla.com
    expires: never

  error_rate:
    type: rate
    description: >
      The rate of failed translations requests.
    denominator_metric: translations.requests_count
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836436
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836436
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_sensitivity:
      - technical
    notification_emails:
      - translations-telemetry-alerts@mozilla.com
    expires: never

  error:
    type: event
    description: >
      The specific translations error that caused a full-page translation failure.
    extra_keys:
      flow_id: &flow_id
        type: string
        description: A uuid to relate events associated with the current panel session.
      first_interaction: &first_interaction
        type: boolean
        description: >
          True if this event occurred in the user's first interaction with translations,
          otherwise false.
      reason:
        type: string
        description: The reason for the error.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836436
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1841366
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1845428
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836436#c4
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1841366#c11
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1845428
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_sensitivity:
      - technical
    notification_emails:
      - translations-telemetry-alerts@mozilla.com
    expires: never

  translation_request:
    type: event
    description: >
      Triggers when a full-page translation request is sent.
    extra_keys:
      flow_id: *flow_id
      first_interaction: *first_interaction
      from_language:
        type: string
        description: The language being translated from.
      to_language:
        type: string
        description: The language being translated to.
      document_language:
        type: string
        description: The detected BCP-47 language tag of the document.
      top_preferred_language:
        type: string
        description: The top preferred language for this user.
      auto_translate:
        type: boolean
        description: >
          True if this translation was triggered automatically
          due to configured always-translate-language settings.
          False if this translation was triggered manually.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836381
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1841366
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1845428
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1847150
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1836381#c4
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1841366#c11
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1845428#c16
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1847150#c4
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_sensitivity:
      - interaction
    notification_emails:
      - translations-telemetry-alerts@mozilla.com
    expires: never

  restore_page:
    type: event
    description: >
      Triggers when the a restore-page event is triggered.
    extra_keys:
      flow_id: *flow_id
      first_interaction: *first_interaction
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1845428
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1845428
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_sensitivity:
      - interaction
    notification_emails:
      - translations-telemetry-alerts@mozilla.com
    expires: never

translations.panel:
  open:
    type: event
    description: >
      Triggers when the translations panel is opened.
    extra_keys:
      flow_id: *flow_id
      first_interaction: *first_interaction
      auto_show:
        type: boolean
        description: Whether the panel was opened automatically or manually by the user.
      view_name:
        type: string
        description: The type of view shown in the panel.
      opened_from:
        type: string
        description: The method by which the translations panel was opened.
      document_language:
        type: string
        description: The detected BCP-47 language tag of the document.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1835502
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1841366
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1845428
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1847150
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1835502#c7
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1841366#c11
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1845428#c16
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1847150#c4
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_sensitivity:
      - interaction
    notification_emails:
      - translations-telemetry-alerts@mozilla.com
    expires: never

  close:
    type: event
    description: >
      Triggers when translations panel is closed.
    extra_keys:
      flow_id: *flow_id
      first_interaction: *first_interaction
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1845428
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1845428
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_sensitivity:
      - interaction
    notification_emails:
      - translations-telemetry-alerts@mozilla.com
    expires: never

  open_from_language_menu:
    type: event
    description: >
      Triggers when the from-language dropdown is opened in the translations panel.
    extra_keys:
      flow_id: *flow_id
      first_interaction: *first_interaction
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1845428
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1845428
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_sensitivity:
      - interaction
    notification_emails:
      - translations-telemetry-alerts@mozilla.com
    expires: never

  change_from_language:
    type: event
    description: >
      Triggers when the from-language selected value is changed.
    extra_keys:
      flow_id: *flow_id
      first_interaction: *first_interaction
      language:
        type: string
        description: >
          - The BCP47 language tag.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1845428
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1845428
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_sensitivity:
      - interaction
    notification_emails:
      - translations-telemetry-alerts@mozilla.com
    expires: never

  close_from_language_menu:
    type: event
    description: >
      Triggers when the from-language dropdown is closed in the translations panel.
    extra_keys:
      flow_id: *flow_id
      first_interaction: *first_interaction
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1845428
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1845428
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_sensitivity:
      - interaction
    notification_emails:
      - translations-telemetry-alerts@mozilla.com
    expires: never

  open_to_language_menu:
    type: event
    description: >
      Triggers when the from-language dropdown is opened in the translations panel.
    extra_keys:
      flow_id: *flow_id
      first_interaction: *first_interaction
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1845428
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1845428
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_sensitivity:
      - interaction
    notification_emails:
      - translations-telemetry-alerts@mozilla.com
    expires: never

  change_to_language:
    type: event
    description: >
      Triggers when the to-language selected value is changed.
    extra_keys:
      flow_id: *flow_id
      first_interaction: *first_interaction
      language:
        type: string
        description: >
          - The BCP47 language tag.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1845428
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1845428
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_sensitivity:
      - interaction
    notification_emails:
      - translations-telemetry-alerts@mozilla.com
    expires: never

  close_to_language_menu:
    type: event
    description: >
      Triggers when the from-language dropdown is closed in the translations panel.
    extra_keys:
      flow_id: *flow_id
      first_interaction: *first_interaction
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1845428
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1845428
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_sensitivity:
      - interaction
    notification_emails:
      - translations-telemetry-alerts@mozilla.com
    expires: never

  open_settings_menu:
    type: event
    description: >
      Triggers when the settings menu is opened in the translations panel.
    extra_keys:
      flow_id: *flow_id
      first_interaction: *first_interaction
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1845428
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1845428
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_sensitivity:
      - interaction
    notification_emails:
      - translations-telemetry-alerts@mozilla.com
    expires: never

  close_settings_menu:
    type: event
    description: >
      Triggers when the settings menu is closed in the translations panel.
    extra_keys:
      flow_id: *flow_id
      first_interaction: *first_interaction
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1845428
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1845428
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_sensitivity:
      - interaction
    notification_emails:
      - translations-telemetry-alerts@mozilla.com
    expires: never

  cancel_button:
    type: event
    description: >
      Triggers when the cancel button is invoked in the translations panel.
    extra_keys:
      flow_id: *flow_id
      first_interaction: *first_interaction
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1845428
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1845428
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_sensitivity:
      - interaction
    notification_emails:
      - translations-telemetry-alerts@mozilla.com
    expires: never

  change_source_language_button:
    type: event
    description: >
      Triggers when the change-source-language button is invoked in the translations panel.
    extra_keys:
      flow_id: *flow_id
      first_interaction: *first_interaction
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1845428
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1845428
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_sensitivity:
      - interaction
    notification_emails:
      - translations-telemetry-alerts@mozilla.com
    expires: never

  dismiss_error_button:
    type: event
    description: >
      Triggers when the dismiss-error button is invoked in the translations panel.
    extra_keys:
      flow_id: *flow_id
      first_interaction: *first_interaction
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1845428
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1845428
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_sensitivity:
      - interaction
    notification_emails:
      - translations-telemetry-alerts@mozilla.com
    expires: never

  restore_page_button:
    type: event
    description: >
      Triggers when the restore-page button is invoked in the translations panel.
    extra_keys:
      flow_id: *flow_id
      first_interaction: *first_interaction
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1845428
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1845428
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_sensitivity:
      - interaction
    notification_emails:
      - translations-telemetry-alerts@mozilla.com
    expires: never

  translate_button:
    type: event
    description: >
      Triggers when the translate button is invoked in the translations panel.
    extra_keys:
      flow_id: *flow_id
      first_interaction: *first_interaction
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1845428
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1845428
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_sensitivity:
      - interaction
    notification_emails:
      - translations-telemetry-alerts@mozilla.com
    expires: never

  always_offer_translations:
    type: event
    description: >
      Triggers when the always-offer-translations menuitem is invoked in the translations panel seeings.
    extra_keys:
      flow_id: *flow_id
      first_interaction: *first_interaction
      toggled_on:
        type: boolean
        description: >
          - Whether the setting was toggled on or off.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1842646
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1842646
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_sensitivity:
      - interaction
    notification_emails:
      - translations-telemetry-alerts@mozilla.com
    expires: never

  always_translate_language:
    type: event
    description: >
      Triggers when the always-translate-language menuitem is invoked in the translations panel settings.
    extra_keys:
      flow_id: *flow_id
      first_interaction: *first_interaction
      language:
        type: string
        description: >
          - The BCP47 language tag.
      toggled_on:
        type: boolean
        description: >
          - Whether the setting was toggled on or off for this language.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1845428
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1845428
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_sensitivity:
      - interaction
    notification_emails:
      - translations-telemetry-alerts@mozilla.com
    expires: never

  never_translate_language:
    type: event
    description: >
      Triggers when the never-translate-language menuitem is invoked in the translations panel settings.
    extra_keys:
      flow_id: *flow_id
      first_interaction: *first_interaction
      language:
        type: string
        description: >
          - The BCP47 language tag.
      toggled_on:
        type: boolean
        description: >
          - Whether the setting was toggled on or off for this language.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1845428
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1845428
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_sensitivity:
      - interaction
    notification_emails:
      - translations-telemetry-alerts@mozilla.com
    expires: never

  never_translate_site:
    type: event
    description: >
      Triggers when the never-translate-site menuitem is invoked in the translations panel settings.
    extra_keys:
      flow_id: *flow_id
      first_interaction: *first_interaction
      toggled_on:
        type: boolean
        description: >
          - Whether the setting was toggled on or off for this site.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1845428
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1845428
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_sensitivity:
      - interaction
    notification_emails:
      - translations-telemetry-alerts@mozilla.com
    expires: never

  manage_languages:
    type: event
    description: >
      Triggers when the manage-languages menuitem is invoked in the translations panel settings.
    extra_keys:
      flow_id: *flow_id
      first_interaction: *first_interaction
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1845428
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1845428
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_sensitivity:
      - interaction
    notification_emails:
      - translations-telemetry-alerts@mozilla.com
    expires: never

  about_translations:
    type: event
    description: >
      Triggers when the about-translations menuitem is invoked in the translations panel settings.
    extra_keys:
      flow_id: *flow_id
      first_interaction: *first_interaction
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1845428
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1845428
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_sensitivity:
      - interaction
    notification_emails:
      - translations-telemetry-alerts@mozilla.com
    expires: never

  learn_more:
    type: event
    description: >
      Triggers when the learn-more link is invoked in the translations panel first interaction.
    extra_keys:
      flow_id: *flow_id
      first_interaction: *first_interaction
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1845428
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1845428
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1861319
    data_sensitivity:
      - interaction
    notification_emails:
      - translations-telemetry-alerts@mozilla.com
    expires: never