Add FXIOS-5207 [v108] Telemetry for logins component key regeneration logic

[lougeniaC64]

Jira ticket
#12308
Adding telemetry to the key regeneration logic in the logins component in order to monitor the rates in which we recreate the encryption key. This will help us surface any spikes in encryption key errors similar to the ones we previously noticed.

With the exception of some naming changes suggested by Glean, this is identical to what we have implemented for Android (see here).

[lougeniaC64]

1. What questions will you answer with this data?

How often do we regenerate the logins encryption key on iOS? Why do we regenerate it?

2. Why does Mozilla need to answer these questions? Are there benefits for users? Do we need this information to address product or business requirements? Some example responses:

Regenerating the key means loss of all local logins data. If this happens often then we want to investigate why to try to avoid it.

3. What alternative methods did you consider to answer these questions? Why were they not sufficient?

No alternatives.

4. Can current instrumentation answer these questions?

No.

5. List all proposed measurements and indicate the category of data collection for each measurement, using the Firefox data collection categories found on the Mozilla wiki.

Measurement Description	Data Collection Category	Tracking Bug #
When the encryption key is regenerated and why	technical data	#12308

6. Please provide a link to the documentation for this data collection which describes the ultimate data set in a public, complete, and accurate way.

This collection is documented in the Glean Dictionary at https://dictionary.telemetry.mozilla.org/

7. How long will this data be collected? Choose one of the following:

I want this data to be collected indefinitely to monitor for any potential data loss

8. What populations will you measure?

All channels in all countries in all locales, for Firefox iOS

9. If this data collection is default on, what is the opt-out mechanism for users?

Standard Firefox telemetry controls

10. Please provide a general description of how you will analyze this data.

Track the error rates. If we determine they are too high, then we will attempt to address the causes.

11. Where do you intend to share the results of your analysis?

The SACI and iOS teams

12. Is there a third-party tool (i.e. not Telemetry) that you are proposing to use for this data collection? If so:

No

[lougeniaC64]

cc @nbhasin2 and @mhammond for review

[lougeniaC64]

Oh, forgot I need to request data review. @travis79 let me know if this should land in your queue or someone else's. Thanks!

[nbhasin2]

lgtm - data review remaining

[mhammond]

🚢

[travis79]

1. What questions will you answer with this data?

How often do we regenerate the logins encryption key on iOS? Why do we regenerate it?

2. Why does Mozilla need to answer these questions?  Are there benefits for users? Do we need this information to address product or business requirements? Some example responses:

Regenerating the key means loss of all local logins data. If this happens often then we want to investigate why to try to avoid it.

3. What alternative methods did you consider to answer these questions? Why were they not sufficient?

No alternatives.

4. Can current instrumentation answer these questions?

No.

5. List all proposed measurements and indicate the category of data collection for each measurement, using the [Firefox data collection categories](https://wiki.mozilla.org/Data_Collection) found on the Mozilla wiki.

Measurement Description Data Collection Category Tracking Bug #
When the encryption key is regenerated and why technical data #12308

6. Please provide a link to the documentation for this data collection which describes the ultimate data set in a public, complete, and accurate way.

This collection is documented in the Glean Dictionary at dictionary.telemetry.mozilla.org

7. How long will this data be collected?  Choose one of the following:

I want this data to be collected indefinitely to monitor for any potential data loss

8. What populations will you measure?

All channels in all countries in all locales, for Firefox iOS

9. If this data collection is default on, what is the opt-out mechanism for users?

Standard Firefox telemetry controls

10. Please provide a general description of how you will analyze this data.

Track the error rates. If we determine they are too high, then we will attempt to address the causes.

11. Where do you intend to share the results of your analysis?

The SACI and iOS teams

12. Is there a third-party tool (i.e. not Telemetry) that you are proposing to use for this data collection? If so:

No

Data Review

1. Is there or will there be documentation that describes the schema for the ultimate data set in a public, complete, and accurate way?

Yes, through the metrics.yaml file and the Glean Dictionary.

2. Is there a control mechanism that allows the user to turn the data collection on and off?

Yes, through the "Send Usage Data" preference in the application settings.

3. If the request is for permanent data collection, is there someone who will monitor the data over time?

Permanent collection to be monitored by @lougeniaC64

4. Using the category system of data types on the Mozilla wiki, what collection type of data do the requested measurements fall under?

Category 1, Technical data

5. Is the data collection request for default-on or default-off?

Default-on

6. Does the instrumentation include the addition of any new identifiers (whether anonymous or otherwise; e.g., username, random IDs, etc. See the appendix for more details)?

No

7. Is the data collection covered by the existing Firefox privacy notice?

Yes

8. Does the data collection use a third-party collection tool?

No

Result

data-review+

[nbhasin2]

Closing and reopening to try BR

[nbhasin2]

Merging as the tests not being started is not part of this change