application-services/components/logins/android/metrics.yaml at main · nishant2718/application-services · GitHub

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
# 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/.

# This file defines the metrics that will be gathered for the "logins"
# storage component.
# These are emitted for all users of the component.  Additional metrics
# specific to the *syncing* of logins are defined in a separate "sync_ping"
# package.
#
# Changes to these metrics require data review, which should take into
# consideration the following known consumers of the logins component
# Android bindings:
#
#  * Fenix for Andriod

---
$schema: moz://mozilla.org/schemas/glean/metrics/1-0-0

logins_store:
  # These track when we need to regenerate the encryption key which causes all
  # local data to be lost
  key_regenerated_lost:
    type: event
    description: >
      The encryption key was regenerated because it was lost
    bugs:
      - https://github.com/mozilla/application-services/issues/4554
    data_reviews:
      - https://github.com/mozilla/application-services/issues/4582
    data_sensitivity:
      - technical
    notification_emails:
      - synced-client-integrations@mozilla.com
    expires: 2022-04-18

  key_regenerated_corrupt:
    type: event
    description: >
      The encryption key was regenerated because it didn't match the encrypted
      data
    bugs:
      - https://github.com/mozilla/application-services/issues/4554
    data_reviews:
      - https://github.com/mozilla/application-services/issues/4582
    data_sensitivity:
      - technical
    notification_emails:
      - synced-client-integrations@mozilla.com
    expires: 2022-04-18

  key_regenerated_other:
    type: event
    description: >
      The encryption key was regenerated for an unknown reason
    bugs:
      - https://github.com/mozilla/application-services/issues/4554
    data_reviews:
      - https://github.com/mozilla/application-services/issues/4582
    data_sensitivity:
      - technical
    notification_emails:
      - synced-client-integrations@mozilla.com
    expires: 2022-04-18

  # These help us understand how much the logins store is being used, and
  # whether it's succeeding in the duties asked of it.  We'll use them to
  # graph e.g. the error rate of applications trying to use the logins store,
  # and identify application or platform features that lead to unusually
  # high error rates.
  read_query_count:
    type: counter
    description: >
      The total number of read operations performed on the logins store.
      The count only includes operations triggered by the application, not
      e.g. incidental reads performed as part of a sync. It is intended to be
      used together with `read_query_error_count` to measure the overall error
      rate of read operations on the logins store.
    bugs:
      - https://github.com/mozilla/application-services/issues/2225
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1597895
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1649044
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1694316
    data_sensitivity:
      - interaction
    notification_emails:
      - mhammond@mozilla.com
      - synced-client-integrations@mozilla.com
    expires: "never"

  read_query_error_count:
    type: labeled_counter
    description: >
      The total number of errors encountered during read operations on the
      logins store, labeled by type.
      It is intended to be used together with `read_query_count` to measure
      the overall error rate of read operations on the logins store.
    labels:
      - interrupted
      - storage_error
    bugs:
      - https://github.com/mozilla/application-services/issues/2225
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1597895
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1649044
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1694316
    data_sensitivity:
      - interaction
    notification_emails:
      - mhammond@mozilla.com
      - synced-client-integrations@mozilla.com
    expires: "never"

  write_query_count:
    type: counter
    description: >
      The total number of write operations performed on the logins store.
      The count only includes operations triggered by the application, not
      e.g. incidental writes performed as part of a sync. It is intended to
      be used together with `write_query_error_count` to measure the overall
      error rate of write operations on the logins store.
    bugs:
      - https://github.com/mozilla/application-services/issues/2225
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1597895
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1649044
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1694316
    data_sensitivity:
      - interaction
    notification_emails:
      - mhammond@mozilla.com
      - synced-client-integrations@mozilla.com
    expires: "never"

  write_query_error_count:
    type: labeled_counter
    description: >
      The total number of errors encountered during write operations on the
      logins store, labeled by type.
      It is intended to be used together with `write_query_count` to measure
      the overall error rate of write operations on the logins store.
    labels:
      - no_such_record
      - interrupted
      - invalid_record
      - storage_error
    bugs:
      - https://github.com/mozilla/application-services/issues/2225
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1597895
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1649044
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1694316
    data_sensitivity:
      - interaction
    notification_emails:
      - mhammond@mozilla.com
      - synced-client-integrations@mozilla.com
    expires: "never"

  # Migrations from sqlcipher to sqlite.
  migration_num_processed:
    type: counter
    description: >
      The total number of login records processed by the migration
    bugs:
      - https://github.com/mozilla/application-services/issues/4064
      - https://github.com/mozilla/application-services/issues/4102
    data_reviews:
      - https://github.com/mozilla/application-services/issues/4467
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - synced-client-integrations@mozilla.com
    expires: 2022-06-30

  migration_num_succeeded:
    type: counter
    description: >
      The total number of login records successfully migrated
    bugs:
      - https://github.com/mozilla/application-services/issues/4064
      - https://github.com/mozilla/application-services/issues/4102
    data_reviews:
      - https://github.com/mozilla/application-services/issues/4467
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - synced-client-integrations@mozilla.com
    expires: 2022-06-30

  migration_num_failed:
    type: counter
    description: >
      The total number of login records which failed to migrate
    bugs:
      - https://github.com/mozilla/application-services/issues/4064
      - https://github.com/mozilla/application-services/issues/4102
    data_reviews:
      - https://github.com/mozilla/application-services/issues/4467
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - synced-client-integrations@mozilla.com
    expires: 2022-06-30

  migration_total_duration:
    type: timespan
    time_unit: millisecond
    description: >
      How long the migration tool
    bugs:
      - https://github.com/mozilla/application-services/issues/4064
      - https://github.com/mozilla/application-services/issues/4102
    data_reviews:
      - https://github.com/mozilla/application-services/issues/4467
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - synced-client-integrations@mozilla.com
    expires: 2022-06-30

  # Note glean limits this to 20 items each with a max length of 50 utf8 chars.
  migration_errors:
    type: string_list
    description: >
      Errors discovered in the migration.
    bugs:
      - https://github.com/mozilla/application-services/issues/4064
      - https://github.com/mozilla/application-services/issues/4102
    data_reviews:
      - https://github.com/mozilla/application-services/issues/4467
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - synced-client-integrations@mozilla.com
    expires: 2022-06-30