Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

extend metric, add extra #10133

Merged
merged 4 commits into from
Jan 2, 2025
Merged

extend metric, add extra #10133

merged 4 commits into from
Jan 2, 2025

Conversation

mcleinman
Copy link
Collaborator

Description

This metric is expiring, and it seems like there are more errors being logged than I'd expect. It's happening on about 10% of iOS user's devices (though it should have no user-facing impact), and I'd like to know why an error is being thrown.

Thus, I've extended the expiration and added an extra bit to learn which error is being thrown.

This will require data review.

Reference

N/A

Checklist

  • My code follows the style guidelines for this project
  • I have not added any packages that contain high risk or unknown licenses (GPL, LGPL, MPL, etc. consult with DevOps if in question)
  • I have performed a self review of my own code
  • I have commented my code PARTICULARLY in hard to understand areas
  • I have added thorough tests where needed

@mcleinman mcleinman changed the title extend metric, add extra to it extend metric, add extra Dec 17, 2024
@mcleinman
Copy link
Collaborator Author

mcleinman commented Dec 17, 2024

Request for data collection review form

All questions are mandatory. You must receive review from a data steward peer on your responses to these questions before shipping new data collection.

  1. What questions will you answer with this data?

How often are there errors when sending pings to check connection health? What are they?

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

We want to strengthen code around switching servers, but need some basic data around how often the users are running into issues, and what types.

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

Carefully considered which metrics were needed.

  1. Can current instrumentation answer these questions?

No, unfortunately.

  1. 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.

Note that the data steward reviewing your request will characterize your data collection based on the highest (and most sensitive) category.

Measurement Name Measurement Description Data Collection Category Tracking Bug #
ping_analyzer_error Event for how often ping analyzer returns an error (somewhat rare), with an `extra` payload of what the error is technical VPN-6406
  1. 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/"

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

Several months, with potential of requesting renewal down the line.

  1. What populations will you measure?

No filters - all channels, countries, and locales, unless the user has opted out of data collection on that device.

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

When launching the app for the first time, a user is given an option for whether to allow data collection. After this initial set up screen, a user can always toggle data collection permissions in the System Preferences screen.

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

Dashboards that engineers and others will consult on a regular basis.

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

Within the Mozilla VPN team and Infra team.

  1. Is there a third-party tool (i.e. not Glean or Telemetry) that you are proposing to use for this data collection?

No

@mcleinman mcleinman requested a review from travis79 December 17, 2024 19:59
@mcleinman
Copy link
Collaborator Author

Adding @travis79 for data review. Thanks!

Copy link
Member

@travis79 travis79 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Request for data collection review form

All questions are mandatory. You must receive review from a data steward peer on your responses to these questions before shipping new data collection.

1. What questions will you answer with this data?

How often are there errors when sending pings to check connection health? What are they?

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?

We want to strengthen code around switching servers, but need some basic data around how often the users are running into issues, and what types.

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

Carefully considered which metrics were needed.

4. Can current instrumentation answer these questions?

No, unfortunately.

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.

Note that the data steward reviewing your request will characterize your data collection based on the highest (and most sensitive) category.
Measurement Name Measurement Description Data Collection Category Tracking Bug #
ping_analyzer_error Event for how often ping analyzer returns an error (somewhat rare), with an extra payload of what the error is technical VPN-6406

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:

Several months, with potential of requesting renewal down the line.

8. What populations will you measure?

No filters - all channels, countries, and locales, unless the user has opted out of data collection on that device.

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

When launching the app for the first time, a user is given an option for whether to allow data collection. After this initial set up screen, a user can always toggle data collection permissions in the System Preferences screen.

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

Dashboards that engineers and others will consult on a regular basis.

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

Within the Mozilla VPN team and Infra team.

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

No

Data Review Form (to be filled by Data Stewards)

  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

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

Yes

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

N/A

  1. 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

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

Default-on

  1. 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

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

Yes

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

No

Result

data-review+

Copy link
Collaborator

@oskirby oskirby left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, the only comment I would make is that the commit message should mention which metric is being extended.

@mcleinman mcleinman force-pushed the extend_connection_health_error branch from e3e4d7e to d535ef4 Compare January 2, 2025 17:23
@mcleinman
Copy link
Collaborator Author

Looks good, the only comment I would make is that the commit message should mention which metric is being extended.

Good call, done.

Copy link

Uh oh! Looks like an error!

Client ID static/taskcluster/github does not have sufficient scopes and is missing the following scopes:

{
  "AnyOf": [
    "queue:rerun-task:mozillavpn-level-1/GDm6eN8UTiytexnOl9QuUA/SjYgBQSkQ3yTl8ZCURz3Zw",
    "queue:rerun-task-in-project:none",
    {
      "AllOf": [
        "queue:rerun-task",
        "assume:scheduler-id:mozillavpn-level-1/GDm6eN8UTiytexnOl9QuUA"
      ]
    }
  ]
}

This request requires the client to satisfy the following scope expression:

{
  "AnyOf": [
    "queue:rerun-task:mozillavpn-level-1/GDm6eN8UTiytexnOl9QuUA/SjYgBQSkQ3yTl8ZCURz3Zw",
    "queue:rerun-task-in-project:none",
    {
      "AllOf": [
        "queue:rerun-task",
        "assume:scheduler-id:mozillavpn-level-1/GDm6eN8UTiytexnOl9QuUA"
      ]
    }
  ]
}

  • method: rerunTask
  • errorCode: InsufficientScopes
  • statusCode: 403
  • time: 2025-01-02T18:10:12.802Z

@mcleinman
Copy link
Collaborator Author

Merging w/ 1 failing test. That failing test is not related to this ticket, and is being fixed in another ticket.

@mcleinman mcleinman merged commit 1078d39 into main Jan 2, 2025
116 of 117 checks passed
@mcleinman mcleinman deleted the extend_connection_health_error branch January 2, 2025 23:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants