Bug 1933479 - Add tab close button on hover to vertical tabs when sidebar is collapse...
[gecko.git] / toolkit / components / pdfjs / metrics.yaml
blob5a2451c382ef6061441657c9c1e825e5ce3bdc9e
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/.↩
5 # Adding a new metric? We have docs for that!↩
6 # https://firefox-source-docs.mozilla.org/toolkit/components/glean/user/new_definitions_file.html↩
8 ---
9 $schema: moz://mozilla.org/schemas/glean/metrics/2-0-0
10 $tags:
11   - 'Firefox :: PDF Viewer'
14 pdfjs:
15   editing:
16     type: labeled_counter
17     labels:
18       - ink
19       - freetext
20       - stamp
21       - save
22       - print
23     description: >
24       Counts the number of times some PDF editing features are used.
25     bugs:
26       - https://bugzilla.mozilla.org/show_bug.cgi?id=1782254
27     data_reviews:
28       - https://bugzilla.mozilla.org/show_bug.cgi?id=1782254#c4
29     data_sensitivity:
30       - interaction
31     notification_emails:
32       - cdenizet@mozilla.com
33       - mcastelluccio@mozilla.com
34     expires: never
35   stamp:
36     type: labeled_counter
37     labels:
38       - inserted_image
39       - alt_text_save
40       - alt_text_cancel
41       - alt_text_tooltip
42       - alt_text_edit
43       - alt_text_description
44       - alt_text_decorative
45       - alt_text_keyboard
46     description: >
47       Counts the number of times some PDF editing features are used.
48     bugs:
49       - https://bugzilla.mozilla.org/show_bug.cgi?id=1853960
50     data_reviews:
51       - https://bugzilla.mozilla.org/show_bug.cgi?id=1853960#c1
52     data_sensitivity:
53       - interaction
54     notification_emails:
55       - cdenizet@mozilla.com
56       - mcastelluccio@mozilla.com
57     expires: never
58   buttons:
59     type: labeled_counter
60     labels:
61       - presentation_mode
62       - presentation_mode_keyboard
63       - view_bookmark
64       - first_page
65       - last_page
66       - page_rotate_cw
67       - page_rotate_ccw
68       - cursor_select_tool
69       - cursor_hand_tool
70       - scroll_page
71       - scroll_vertical
72       - scroll_horizontal
73       - scroll_wrapped
74       - spread_none
75       - spread_odd
76       - spread_even
77       - document_properties
78     description: >
79       Counts the number of times some actions are executed in the PDF viewer.
80     bugs:
81       - https://bugzilla.mozilla.org/show_bug.cgi?id=1789883
82     data_reviews:
83       - https://bugzilla.mozilla.org/show_bug.cgi?id=1789883#2
84     data_sensitivity:
85       - interaction
86     notification_emails:
87       - cdenizet@mozilla.com
88       - mcastelluccio@mozilla.com
89     expires: never
90   geckoview:
91     type: labeled_counter
92     labels:
93       - download_tapped
94       - open_in_app_tapped
95       - open_in_app_just_once
96       - open_in_app_always
97       - download_failed
98       - download_succeeded
99       - save_as_pdf_tapped
100     description: >
101       Counts the number of times some actions are executed in the PDF viewer.
102     bugs:
103       - https://bugzilla.mozilla.org/show_bug.cgi?id=1829216
104     data_reviews:
105       - https://bugzilla.mozilla.org/show_bug.cgi?id=1829216#2
106     data_sensitivity:
107       - interaction
108     notification_emails:
109       - cdenizet@mozilla.com
110       - mcastelluccio@mozilla.com
111     expires: never
112   used:
113     bugs:
114       - https://bugzilla.mozilla.org/show_bug.cgi?id=1566882
115     data_reviews:
116       - https://bugzilla.mozilla.org/show_bug.cgi?id=1566882#c2
117     description: >
118       How many times PDF Viewer was used.
119     expires: never
120     type: counter
121     notification_emails:
122       - cdenizet@mozilla.com
123       - mcastelluccio@mozilla.com
124   time_to_view:
125     type: custom_distribution
126     bugs:
127       - https://bugzilla.mozilla.org/show_bug.cgi?id=1566882
128     data_reviews:
129       - https://bugzilla.mozilla.org/show_bug.cgi?id=1566882#c2
130     description: >
131       Time spent to display first page in PDF Viewer (ms).
132     expires: never
133     range_min: 1
134     range_max: 10000
135     bucket_count: 50
136     histogram_type: exponential
137     unit: ms
138     data_sensitivity:
139       - interaction
140     notification_emails:
141       - cdenizet@mozilla.com
142       - mcastelluccio@mozilla.com
143 pdfjs.editing.highlight:
144     kind:
145       type: labeled_counter
146       labels:
147         - free_highlight
148         - highlight
149       description: >
150         Counts the number of times a given kind is used to highlight.
151       bugs:
152         - https://bugzilla.mozilla.org/show_bug.cgi?id=1866437
153       data_reviews:
154         - https://bugzilla.mozilla.org/show_bug.cgi?id=1866437#c1
155       data_sensitivity:
156         - interaction
157       notification_emails:
158         - pdfjs-team@mozilla.com
159       expires: never
161     method:
162       type: labeled_counter
163       labels:
164         - context_menu
165         - main_toolbar
166         - floating_button
167       description: >
168         Counts the number of times a given method is used to highlight.
169       bugs:
170         - https://bugzilla.mozilla.org/show_bug.cgi?id=1866437
171       data_reviews:
172         - https://bugzilla.mozilla.org/show_bug.cgi?id=1866437#c1
173       data_sensitivity:
174         - interaction
175       notification_emails:
176         - pdfjs-team@mozilla.com
177       expires: never
179     color:
180       type: labeled_counter
181       labels:
182         - yellow
183         - green
184         - blue
185         - pink
186         - red
187       description: >
188         Counts the number of times a given color is used to highlight.
189       bugs:
190         - https://bugzilla.mozilla.org/show_bug.cgi?id=1866437
191       data_reviews:
192         - https://bugzilla.mozilla.org/show_bug.cgi?id=1866437#c1
193       data_sensitivity:
194         - interaction
195       notification_emails:
196         - pdfjs-team@mozilla.com
197       expires: never
199     color_changed:
200       type: counter
201       description: >
202         Counts the number of times the user changes the color of a highlight.
203       bugs:
204         - https://bugzilla.mozilla.org/show_bug.cgi?id=1866437
205       data_reviews:
206         - https://bugzilla.mozilla.org/show_bug.cgi?id=1866437#c1
207       data_sensitivity:
208         - interaction
209       notification_emails:
210         - pdfjs-team@mozilla.com
211       expires: never
213     number_of_colors:
214       type: labeled_counter
215       labels:
216         - one
217         - two
218         - three
219         - four
220         - five
221       description: >
222         Counts the number of different colors used to highlight.
223       bugs:
224         - https://bugzilla.mozilla.org/show_bug.cgi?id=1866437
225       data_reviews:
226         - https://bugzilla.mozilla.org/show_bug.cgi?id=1866437#c1
227       data_sensitivity:
228         - interaction
229       notification_emails:
230         - pdfjs-team@mozilla.com
231       expires: never
233     thickness:
234       type: custom_distribution
235       range_min: 8
236       range_max: 24
237       bucket_count: 17
238       histogram_type: linear
239       unit: pixels
240       description: >
241         The thickness used to draw a free highlight.
242       bugs:
243         - https://bugzilla.mozilla.org/show_bug.cgi?id=1866437
244       data_reviews:
245         - https://bugzilla.mozilla.org/show_bug.cgi?id=1866437#c1
246       data_sensitivity:
247         - interaction
248       notification_emails:
249         - pdfjs-team@mozilla.com
250       expires: never
252     thickness_changed:
253       type: counter
254       description: >
255         Counts the number of times the user changes the thickness of a free highlight.
256       bugs:
257         - https://bugzilla.mozilla.org/show_bug.cgi?id=1866437
258       data_reviews:
259         - https://bugzilla.mozilla.org/show_bug.cgi?id=1866437#c1
260       data_sensitivity:
261         - interaction
262       notification_emails:
263         - pdfjs-team@mozilla.com
264       expires: never
266     save:
267       type: counter
268       description: >
269         Counts the number of times the user saves a PDF with highlights.
270       bugs:
271         - https://bugzilla.mozilla.org/show_bug.cgi?id=1866437
272       data_reviews:
273         - https://bugzilla.mozilla.org/show_bug.cgi?id=1866437#c1
274       data_sensitivity:
275         - interaction
276       notification_emails:
277         - pdfjs-team@mozilla.com
278       expires: never
280     print:
281       type: counter
282       description: >
283         Counts the number of times the user prints a PDF with highlights.
284       bugs:
285         - https://bugzilla.mozilla.org/show_bug.cgi?id=1866437
286       data_reviews:
287         - https://bugzilla.mozilla.org/show_bug.cgi?id=1866437#c1
288       data_sensitivity:
289         - interaction
290       notification_emails:
291         - pdfjs-team@mozilla.com
292       expires: never
294     edited:
295       type: counter
296       description: >
297         Counts the number of times the user edits highlights.
298       bugs:
299         - https://bugzilla.mozilla.org/show_bug.cgi?id=1866437
300       data_reviews:
301         - https://bugzilla.mozilla.org/show_bug.cgi?id=1866437#c1
302       data_sensitivity:
303         - interaction
304       notification_emails:
305         - pdfjs-team@mozilla.com
306       expires: never
308     deleted:
309       type: counter
310       description: >
311         Counts the number of times the user deletes highlights.
312       bugs:
313         - https://bugzilla.mozilla.org/show_bug.cgi?id=1866437
314       data_reviews:
315         - https://bugzilla.mozilla.org/show_bug.cgi?id=1866437#c1
316       data_sensitivity:
317         - interaction
318       notification_emails:
319         - pdfjs-team@mozilla.com
320       expires: never
322     toggle_visibility:
323       type: counter
324       description: >
325         Counts the number of times the user toggles the visibility of highlights.
326       bugs:
327         - https://bugzilla.mozilla.org/show_bug.cgi?id=1866437
328       data_reviews:
329         - https://bugzilla.mozilla.org/show_bug.cgi?id=1866437#c1
330       data_sensitivity:
331         - interaction
332       notification_emails:
333         - pdfjs-team@mozilla.com
334       expires: never
335 pdfjs.image.alt_text:
336     callout_displayed:
337       type: event
338       description: >
339         Recorded when the callout describing automatic alt text generation is displayed.
340       bugs:
341         - https://bugzilla.mozilla.org/show_bug.cgi?id=1909325
342       data_reviews:
343         - https://bugzilla.mozilla.org/show_bug.cgi?id=1909325#c1
344       data_sensitivity:
345         - interaction
346       notification_emails:
347         - pdfjs-team@mozilla.com
348         - asafko@mozilla.com
349       expires: never
351     callout_dismissed:
352       type: event
353       description: >
354         Recorded when the callout describing automatic alt text generation is dismissed.
355       bugs:
356         - https://bugzilla.mozilla.org/show_bug.cgi?id=1909325
357       data_reviews:
358         - https://bugzilla.mozilla.org/show_bug.cgi?id=1909325#c1
359       data_sensitivity:
360         - interaction
361       notification_emails:
362         - pdfjs-team@mozilla.com
363         - asafko@mozilla.com
364       expires: never
366     info:
367       type: event
368       description: >
369         Recorded on the alt text modal when the user clicks on "i" to learn about alt text or "Learn More" to learn about AI generation.
370       bugs:
371         - https://bugzilla.mozilla.org/show_bug.cgi?id=1909325
372       data_reviews:
373         - https://bugzilla.mozilla.org/show_bug.cgi?id=1909325#c1
374       data_sensitivity:
375         - interaction
376       notification_emails:
377         - pdfjs-team@mozilla.com
378         - asafko@mozilla.com
379       expires: never
380       extra_keys:
381         topic:
382           type: string
383           description: alt_text, ai_generation.
385     ai_generation_check:
386       type: event
387       description: >
388         Recorded when the user interacts with the alt text setting in the alt text modal to create alt text with AI.
389       bugs:
390         - https://bugzilla.mozilla.org/show_bug.cgi?id=1915434
391       data_reviews:
392         - https://bugzilla.mozilla.org/show_bug.cgi?id=1915434#c1
393       data_sensitivity:
394         - interaction
395       notification_emails:
396         - pdfjs-team@mozilla.com
397         - asafko@mozilla.com
398       expires: never
399       extra_keys:
400         status:
401           type: boolean
402           description: >
403             true (resp. false) if the user enables (resp. disables) the AI generation.
405     settings_displayed:
406       type: event
407       description: >
408         Recorded when alt text settings dialog is displayed to a user.
409       bugs:
410         - https://bugzilla.mozilla.org/show_bug.cgi?id=1909325
411       data_reviews:
412         - https://bugzilla.mozilla.org/show_bug.cgi?id=1909325#c1
413       data_sensitivity:
414         - interaction
415       notification_emails:
416         - pdfjs-team@mozilla.com
417         - asafko@mozilla.com
418       expires: never
420     settings_ai_generation_check:
421       type: event
422       description: >
423         Recorded when the user interacts with the alt text setting to create alt text with AI.
424       bugs:
425         - https://bugzilla.mozilla.org/show_bug.cgi?id=1909325
426       data_reviews:
427         - https://bugzilla.mozilla.org/show_bug.cgi?id=1909325#c1
428       data_sensitivity:
429         - interaction
430       notification_emails:
431         - pdfjs-team@mozilla.com
432         - asafko@mozilla.com
433       expires: never
434       extra_keys:
435         status:
436           type: boolean
437           description: >
438             true (resp. false) if the user enables (resp. disables) the AI generation.
440     settings_edit_alt_text_check:
441       type: event
442       description: >
443         Recorded when the user interacts with the alt text modal setting to edit alt text on this pdf.
444       bugs:
445         - https://bugzilla.mozilla.org/show_bug.cgi?id=1909325
446       data_reviews:
447         - https://bugzilla.mozilla.org/show_bug.cgi?id=1909325#c1
448       data_sensitivity:
449         - interaction
450       notification_emails:
451         - pdfjs-team@mozilla.com
452         - asafko@mozilla.com
453       expires: never
454       extra_keys:
455         status:
456           type: boolean
457           description: >
458             true if the user edits the generated text.
460     save:
461       type: event
462       description: >
463         Recorded when the user clicks Save on the alt text modal.
464       bugs:
465         - https://bugzilla.mozilla.org/show_bug.cgi?id=1909325
466       data_reviews:
467         - https://bugzilla.mozilla.org/show_bug.cgi?id=1909325#c1
468       data_sensitivity:
469         - interaction
470       notification_emails:
471         - pdfjs-team@mozilla.com
472         - asafko@mozilla.com
473       expires: never
474       extra_keys:
475         alt_text_type:
476           type: string
477           description: present, empty.
478         flow:
479           type: string
480           description: image_add, alt_text_edit.
482     dismiss:
483       type: event
484       description: >
485         Recorded when the user clicks Not now or Cancel on the alt text modal.
486       bugs:
487         - https://bugzilla.mozilla.org/show_bug.cgi?id=1909325
488       data_reviews:
489         - https://bugzilla.mozilla.org/show_bug.cgi?id=1909325#c1
490       data_sensitivity:
491         - interaction
492       notification_emails:
493         - pdfjs-team@mozilla.com
494         - asafko@mozilla.com
495       expires: never
496       extra_keys:
497         alt_text_type:
498           type: string
499           description: present, empty.
500         flow:
501           type: string
502           description: image_add, alt_text_edit.
504     model_download_start:
505       type: event
506       description: >
507         Recorded when download starts for the alt text generation model.
508       bugs:
509         - https://bugzilla.mozilla.org/show_bug.cgi?id=1909325
510       data_reviews:
511         - https://bugzilla.mozilla.org/show_bug.cgi?id=1909325#c1
512       data_sensitivity:
513         - interaction
514       notification_emails:
515         - pdfjs-team@mozilla.com
516         - asafko@mozilla.com
517       expires: never
519     model_download_complete:
520       type: event
521       description: >
522         Recorded when download completes for the alt text generation model.
523       bugs:
524         - https://bugzilla.mozilla.org/show_bug.cgi?id=1909325
525       data_reviews:
526         - https://bugzilla.mozilla.org/show_bug.cgi?id=1909325#c1
527       data_sensitivity:
528         - interaction
529       notification_emails:
530         - pdfjs-team@mozilla.com
531         - asafko@mozilla.com
532       expires: never
534     model_download_error:
535       type: event
536       description: >
537         Recorded when an error occurs during the download for the alt text generation model.
538       bugs:
539         - https://bugzilla.mozilla.org/show_bug.cgi?id=1909325
540       data_reviews:
541         - https://bugzilla.mozilla.org/show_bug.cgi?id=1909325#c1
542       data_sensitivity:
543         - interaction
544       notification_emails:
545         - pdfjs-team@mozilla.com
546         - asafko@mozilla.com
547       expires: never
548       extra_keys:
549         error:
550           type: string
551           description: Error message.
553     model_deleted:
554       type: event
555       description: >
556         Recorded when the user clicks to delete the model from the alt text settings.
557       bugs:
558         - https://bugzilla.mozilla.org/show_bug.cgi?id=1909325
559       data_reviews:
560         - https://bugzilla.mozilla.org/show_bug.cgi?id=1909325#c1
561       data_sensitivity:
562         - interaction
563       notification_emails:
564         - pdfjs-team@mozilla.com
565         - asafko@mozilla.com
566       expires: never
568     model_result:
569       type: event
570       description: >
571         Records how long it takes to generate the alt text and what is the length of the result.
572       bugs:
573         - https://bugzilla.mozilla.org/show_bug.cgi?id=1909325
574       data_reviews:
575         - https://bugzilla.mozilla.org/show_bug.cgi?id=1909325#c1
576       data_sensitivity:
577         - interaction
578       notification_emails:
579         - pdfjs-team@mozilla.com
580         - asafko@mozilla.com
581       expires: never
582       extra_keys:
583         time:
584           type: quantity
585           description: >
586             time in ms to generate result.
587         length:
588           type: quantity
589           description: >
590             number of characters of generated text.
592     user_edit:
593       type: event
594       description: >
595         Recorded once the alt text is confirmed, when the user makes changes to the alt text generated. By comparing the initially generated text with the final version, quantifies how many words were changed.
596       bugs:
597         - https://bugzilla.mozilla.org/show_bug.cgi?id=1909325
598       data_reviews:
599         - https://bugzilla.mozilla.org/show_bug.cgi?id=1909325#c1
600       data_sensitivity:
601         - interaction
602       notification_emails:
603         - pdfjs-team@mozilla.com
604         - asafko@mozilla.com
605       expires: never
606       extra_keys:
607         total_words:
608           type: quantity
609           description: >
610             total number of words in the generated text.
611         words_removed:
612           type: quantity
613           description: >
614             number of words removed.
615         words_added:
616           type: quantity
617           description: >
618             number of words added.
620     image_status_label_displayed:
621       type: event
622       description: >
623         Recorded when the alt text status button on an image is shown .
624       bugs:
625         - https://bugzilla.mozilla.org/show_bug.cgi?id=1909325
626       data_reviews:
627         - https://bugzilla.mozilla.org/show_bug.cgi?id=1909325#c1
628       data_sensitivity:
629         - interaction
630       notification_emails:
631         - pdfjs-team@mozilla.com
632         - asafko@mozilla.com
633       expires: never
634       extra_keys:
635         label:
636           type: string
637           description: added, review, missing.
640     image_status_label_clicked:
641       type: event
642       description: >
643         Recorded when the user clicks on the alt text status button.
644       bugs:
645         - https://bugzilla.mozilla.org/show_bug.cgi?id=1909325
646       data_reviews:
647         - https://bugzilla.mozilla.org/show_bug.cgi?id=1909325#c1
648       data_sensitivity:
649         - interaction
650       notification_emails:
651         - pdfjs-team@mozilla.com
652         - asafko@mozilla.com
653       expires: never
654       extra_keys:
655         label:
656           type: string
657           description: added, review, missing.
658 pdfjs.image:
659     icon_click:
660       type: event
661       description: >
662         Recorded when the image toolbar icon is clicked.
663       bugs:
664         - https://bugzilla.mozilla.org/show_bug.cgi?id=1909325
665       data_reviews:
666         - https://bugzilla.mozilla.org/show_bug.cgi?id=1909325#c1
667       data_sensitivity:
668         - interaction
669       notification_emails:
670         - pdfjs-team@mozilla.com
671         - asafko@mozilla.com
672       expires: never
674     add_image_click:
675       type: event
676       description: >
677         Recorded when the Add Image label is clicked.
678       bugs:
679         - https://bugzilla.mozilla.org/show_bug.cgi?id=1909325
680       data_reviews:
681         - https://bugzilla.mozilla.org/show_bug.cgi?id=1909325#c1
682       data_sensitivity:
683         - interaction
684       notification_emails:
685         - pdfjs-team@mozilla.com
686         - asafko@mozilla.com
687       expires: never
689     image_selected:
690       type: event
691       description: >
692         Recorded when the user selects an image file from their computer.
693       bugs:
694         - https://bugzilla.mozilla.org/show_bug.cgi?id=1909325
695       data_reviews:
696         - https://bugzilla.mozilla.org/show_bug.cgi?id=1909325#c1
697       data_sensitivity:
698         - interaction
699       notification_emails:
700         - pdfjs-team@mozilla.com
701         - asafko@mozilla.com
702       expires: never
703       extra_keys:
704         alt_text_modal:
705           type: boolean
706           description: >
707             Indicates if the alt text modal was displayed and the user clicked save, or if it was skipped and the image was added directly after selection.
709     image_added:
710       type: event
711       description: >
712         Recorded once the image is added to the pdf.
713       bugs:
714         - https://bugzilla.mozilla.org/show_bug.cgi?id=1909325
715       data_reviews:
716         - https://bugzilla.mozilla.org/show_bug.cgi?id=1909325#c1
717       data_sensitivity:
718         - interaction
719       notification_emails:
720         - pdfjs-team@mozilla.com
721         - asafko@mozilla.com
722       expires: never
723       extra_keys:
724         alt_text_modal:
725           type: boolean
726           description: >
727             Indicates if the alt text modal was displayed and the user clicked save, or if it was skipped and the image was added directly after selection.
728         alt_text_type:
729           type: string
730           description: present, empty, skipped.
732     alt_text_edit:
733       type: labeled_boolean
734       description: >
735         Stores alt text modal settings for the user.
736       labels:
737         - ask_to_edit
738         - ai_generation
739       bugs:
740         - https://bugzilla.mozilla.org/show_bug.cgi?id=1909325
741       data_reviews:
742         - https://bugzilla.mozilla.org/show_bug.cgi?id=1909325#c1
743       data_sensitivity:
744         - interaction
745       notification_emails:
746         - pdfjs-team@mozilla.com
747         - asafko@mozilla.com
748       expires: never
750     added:
751       type: labeled_counter
752       description: >
753         Number of images added with/without alt text.
754       labels:
755         - with_alt_text
756         - without_alt_text
757       bugs:
758         - https://bugzilla.mozilla.org/show_bug.cgi?id=1909325
759       data_reviews:
760         - https://bugzilla.mozilla.org/show_bug.cgi?id=1909325#c1
761       data_sensitivity:
762         - interaction
763       notification_emails:
764         - pdfjs-team@mozilla.com
765         - asafko@mozilla.com
766       expires: never