Skip to content
This repository has been archived by the owner on Apr 27, 2023. It is now read-only.

Bug 1760255 - add rally ID to events pings #804

Merged
merged 4 commits into from
Mar 23, 2022
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
# Unreleased changes

[Full changelog](https://github.com/mozilla-rally/core-addon/compare/v1.4.2...master)
[Full changelog](https://github.com/mozilla-rally/core-addon/compare/v1.4.3...master)

* [804](https://github.com/mozilla-rally/rally-core-addon/pull/804): Bug 1760255 - add rally ID to events pings

# v1.4.3 (2022-02-03)

[Full changelog](https://github.com/mozilla-rally/core-addon/compare/v1.4.2...v1.4.3)

* [#788](https://github.com/mozilla-rally/rally-core-addon/pull/788): Ensure that data collection is always enabled in core add-on
when user is enrolled
Expand Down
19 changes: 17 additions & 2 deletions docs/metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ This means you might have to go searching through the dependency tree to get a f
- [deletion-request](#deletion-request)
- [demographics](#demographics)
- [enrollment](#enrollment)
- [events](#events)
- [study-enrollment](#study-enrollment)
- [study-unenrollment](#study-unenrollment)
- [uninstall-deletion](#uninstall-deletion)
Expand Down Expand Up @@ -86,6 +87,20 @@ In addition to those built-in metrics, the following metrics are added to the pi
| --- | --- | --- | --- | --- | --- | --- |
| rally.id |[uuid](https://mozilla.github.io/glean/book/user/metrics/uuid.html) |The id of the Rally client. |[mozilla-rally/rally-core-addon#505](https://github.com/mozilla-rally/rally-core-addon/pull/505#issuecomment-815826426)||never | |

## events

This is a built-in ping that is assembled out of the box by the Glean SDK.

See the Glean SDK documentation for the [`events` ping](https://mozilla.github.io/glean/book/user/pings/events.html).

All Glean pings contain built-in metrics in the [`ping_info`](https://mozilla.github.io/glean/book/user/pings/index.html#the-ping_info-section) and [`client_info`](https://mozilla.github.io/glean/book/user/pings/index.html#the-client_info-section) sections.

In addition to those built-in metrics, the following metrics are added to the ping:

| Name | Type | Description | Data reviews | Extras | Expiration | [Data Sensitivity](https://wiki.mozilla.org/Firefox/Data_Collection) |
| --- | --- | --- | --- | --- | --- | --- |
| rally.id |[uuid](https://mozilla.github.io/glean/book/user/metrics/uuid.html) |The id of the Rally client. |[mozilla-rally/rally-core-addon#505](https://github.com/mozilla-rally/rally-core-addon/pull/505#issuecomment-815826426)||never | |

## study-enrollment

This ping is sent when user clicks the Join button for a study
Expand All @@ -108,7 +123,7 @@ In addition to those built-in metrics, the following metrics are added to the pi

| Name | Type | Description | Data reviews | Extras | Expiration | [Data Sensitivity](https://wiki.mozilla.org/Firefox/Data_Collection) |
| --- | --- | --- | --- | --- | --- | --- |
| enrollment.schema_namespace |[string](https://mozilla.github.io/glean/book/user/metrics/string.html) |The schema namespace for the study the user has joined. |[Review 1](TODO)||never | |
| enrollment.schema_namespace |[string](https://mozilla.github.io/glean/book/user/metrics/string.html) |The schema namespace for the study the user has joined. |[Bug 1663857](https://bugzilla.mozilla.org/show_bug.cgi?id=1663857#c5)||never | |
| enrollment.study_id |[string](https://mozilla.github.io/glean/book/user/metrics/string.html) |The id of the study user has joined. |[Bug 1663857](https://bugzilla.mozilla.org/show_bug.cgi?id=1663857#c5)||never | |
| rally.id |[uuid](https://mozilla.github.io/glean/book/user/metrics/uuid.html) |The id of the Rally client. |[mozilla-rally/rally-core-addon#505](https://github.com/mozilla-rally/rally-core-addon/pull/505#issuecomment-815826426)||never | |

Expand All @@ -134,7 +149,7 @@ In addition to those built-in metrics, the following metrics are added to the pi
| Name | Type | Description | Data reviews | Extras | Expiration | [Data Sensitivity](https://wiki.mozilla.org/Firefox/Data_Collection) |
| --- | --- | --- | --- | --- | --- | --- |
| rally.id |[uuid](https://mozilla.github.io/glean/book/user/metrics/uuid.html) |The id of the Rally client. |[mozilla-rally/rally-core-addon#505](https://github.com/mozilla-rally/rally-core-addon/pull/505#issuecomment-815826426)||never | |
| unenrollment.schema_namespace |[string](https://mozilla.github.io/glean/book/user/metrics/string.html) |The schema namespace for the study the user has left. |[Review 1](TODO)||never | |
| unenrollment.schema_namespace |[string](https://mozilla.github.io/glean/book/user/metrics/string.html) |The schema namespace for the study the user has left. |[Bug 1646151](https://bugzilla.mozilla.org/show_bug.cgi?id=1646151#c32)||never | |
| unenrollment.study_id |[string](https://mozilla.github.io/glean/book/user/metrics/string.html) |The id of the study user has left. |[Bug 1646151](https://bugzilla.mozilla.org/show_bug.cgi?id=1646151#c32)||never | |

## uninstall-deletion
Expand Down
2 changes: 1 addition & 1 deletion manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"author": "Mozilla",
"manifest_version": 2,
"name": "Mozilla Rally",
"version": "1.4.2",
"version": "1.4.3",
"homepage_url": "https://github.com/mozilla-rally/rally-core-addon",
"icons": {
"48": "public/img/rally-favicon.svg",
Expand Down
1 change: 1 addition & 0 deletions metrics.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ rally:
- study-unenrollment
- demographics
- uninstall-deletion
- events
description: |
The id of the Rally client.
bugs:
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "rally_core",
"version": "1.4.2",
"version": "1.4.3",
"type": "module",
"scripts": {
"prebuild": "node scripts/setupTaskcluster.js",
Expand Down