Skip to content

Commit 4ad0dbe

Browse files
committed
Bumped version to 4.0.0-pre.3
1 parent a3d4030 commit 4ad0dbe

File tree

5 files changed

+52
-5
lines changed

5 files changed

+52
-5
lines changed

CHANGELOG.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
# Unreleased changes
22

3-
[Full changelog](https://github.com/mozilla/glean.js/compare/v4.0.0-pre.2...main)
3+
[Full changelog](https://github.com/mozilla/glean.js/compare/v4.0.0-pre.3...main)
4+
5+
# v4.0.0-pre.3 (2023-12-22)
6+
7+
[Full changelog](https://github.com/mozilla/glean.js/compare/v4.0.0-pre.2...v4.0.0-pre.3)
48

59
* [#1848](https://github.com/mozilla/glean.js/pull/1848): Support for automatically collecting element click events (first version)
610
* [#1849](https://github.com/mozilla/glean.js/pull/1849): Truncate event extra strings to 500 bytes. This also updates other string-based metrics to truncate based on max bytes rather than a set number of characters.

docs/reference/metrics.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ This means you might have to go searching through the dependency tree to get a f
1010

1111
- [all-pings](#all-pings)
1212
- [deletion-request](#deletion-request)
13+
- [events](#events)
1314

1415
## all-pings
1516

@@ -60,6 +61,48 @@ All Glean pings contain built-in metrics in the [`ping_info`](https://mozilla.gi
6061

6162
This ping contains no metrics.
6263

64+
## events
65+
66+
This is a built-in ping that is assembled out of the box by the Glean SDK.
67+
68+
See the Glean SDK documentation for the [`events` ping](https://mozilla.github.io/glean/book/user/pings/events.html).
69+
70+
This ping includes the [client id](https://mozilla.github.io/glean/book/user/pings/index.html#the-client_info-section).
71+
72+
**Data reviews for this ping:**
73+
74+
- <https://bugzilla.mozilla.org/show_bug.cgi?id=1512938#c3>
75+
76+
**Bugs related to this ping:**
77+
78+
- <https://bugzilla.mozilla.org/1512938>
79+
80+
**Reasons this ping may be sent:**
81+
82+
- `inactive`: The ping was submitted when becoming inactive. In earlier versions, this
83+
was called `background`.
84+
85+
NOTE: It is not possible to find a definition of "inactivity" that spans
86+
all of the platforms served by the Glean JavaScript SDK.
87+
This reason is only listed here for documentation purposes.
88+
It is never reported by the JavaScript SDK.
89+
90+
- `max_capacity`: The maximum number of events was reached (default 1 event).
91+
92+
- `startup`: The ping was submitted at startup.
93+
The events ping is always sent if there are any pending events at startup,
94+
because event timestamps are not as reliable across application runs.
95+
96+
97+
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.
98+
99+
In addition to those built-in metrics, the following metrics are added to the ping:
100+
101+
| Name | Type | Description | Data reviews | Extras | Expiration | [Data Sensitivity](https://wiki.mozilla.org/Firefox/Data_Collection) |
102+
| --- | --- | --- | --- | --- | --- | --- |
103+
| glean.element_click |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |A event triggered whenever an html element is clicked on a page. **Clicks are recorded only for those html elements that have at least one of the `data-glean-*` data attributes. By default, this event is not collected automatically. Collection can be turned on by clients via Glean configuration object (`enableAutoElementClickEvents`). Glean also provides a separate API for clients to record element clicks manually.** |[Bug 1867294](https://bugzilla.mozilla.org/show_bug.cgi?id=1867294#c29)|<ul><li>id: An identifier of the element clicked. For automatic collection, its value is the element's `data-glean-id` data attribute value.</li><li>label: The label of the element clicked. For automatic collection, its value is the element's `data-glean-label` data attribute value.</li><li>type: The type of the element clicked. For automatic collection, its value is the element's `data-glean-type` data attribute value.</li></ul>|never |2 |
104+
| glean.page_load |[event](https://mozilla.github.io/glean/book/user/metrics/event.html) |A event triggered whenever a page is loaded. **This event by default is not collected automatically. This can be turned on by the client in the Glean configuration object (`enableAutoPageLoadEvents`). Glean provides a separate API for collecting the same page load data if the client wants to collect page loads manually.** |[Bug 1867126](https://bugzilla.mozilla.org/show_bug.cgi?id=1867126#c8)|<ul><li>referrer: The page referrer.</li><li>title: The page title.</li><li>url: The page URL.</li></ul>|never |2 |
105+
63106
Data categories are [defined here](https://wiki.mozilla.org/Firefox/Data_Collection).
64107

65108
<!-- AUTOGENERATED BY glean_parser v10.0.3. DO NOT EDIT. -->

glean/package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

glean/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@mozilla/glean",
3-
"version": "4.0.0-pre.2",
3+
"version": "4.0.0-pre.3",
44
"description": "An implementation of the Glean SDK, a modern cross-platform telemetry client, for JavaScript environments.",
55
"type": "module",
66
"sideEffects": false,

glean/src/core/constants.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ export const GLEAN_SCHEMA_VERSION = 1;
88
//
99
// PACKAGE_VERSION is defined as a global by webpack,
1010
// we need a default here for testing when the app is not build with webpack.
11-
export const GLEAN_VERSION = "4.0.0-pre.2";
11+
export const GLEAN_VERSION = "4.0.0-pre.3";
1212

1313
// The name of a "ping" that will include Glean ping_info metrics,
1414
// such as ping sequence numbers.

0 commit comments

Comments
 (0)