Merge branch 'release-v4.0.0-pre.3' into release

Author: Dexterp37

.dictionary

@@ -50,6 +50,7 @@ firefox
 getters
 gzip
 gzipping
+html
 init
 instantiation
 janerik

CHANGELOG.md

@@ -1,25 +1,32 @@
 # Unreleased changes
 
-[Full changelog](https://github.com/mozilla/glean.js/compare/v4.0.0-pre.2...main)
+[Full changelog](https://github.com/mozilla/glean.js/compare/v4.0.0-pre.3...main)
+
+# v4.0.0-pre.3 (2023-12-22)
+
+[Full changelog](https://github.com/mozilla/glean.js/compare/v4.0.0-pre.2...v4.0.0-pre.3)
+
+* [#1848](https://github.com/mozilla/glean.js/pull/1848): Support for automatically collecting element click events (first version)
+* [#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.
 
 # v4.0.0-pre.2 (2023-12-06)
 
 [Full changelog](https://github.com/mozilla/glean.js/compare/v4.0.0-pre.1...v4.0.0-pre.2)
 
-[#1835](https://github.com/mozilla/glean.js/pull/1835): Added support for automatic page load instrumentation.
+* [#1835](https://github.com/mozilla/glean.js/pull/1835): Added support for automatic page load instrumentation.
+* [#1846](https://github.com/mozilla/glean.js/pull/1846): Add logging messages when using the debugging APIs from the browser console.
 
 # v4.0.0-pre.1 (2023-12-01)
 
 [Full changelog](https://github.com/mozilla/glean.js/compare/v4.0.0-pre.0...v4.0.0-pre.1)
 
-[#1834](https://github.com/mozilla/glean.js/pull/1834): Added support for `navigator.sendBeacon`. This is not turned on by default and needs to be enabled manually.
+* [#1834](https://github.com/mozilla/glean.js/pull/1834): Added support for `navigator.sendBeacon`. This is not turned on by default and needs to be enabled manually.
 
 # v4.0.0-pre.0 (2023-11-27)
 
 [Full changelog](https://github.com/mozilla/glean.js/compare/v3.0.0...v4.0.0-pre.0)
 
-[#1808](https://github.com/mozilla/glean.js/pull/1808): **BREAKING CHANGE**: Make glean.js fully synchronous.
-
+* [#1808](https://github.com/mozilla/glean.js/pull/1808): **BREAKING CHANGE**: Make glean.js fully synchronous.
 * [#1835](https://github.com/mozilla/glean.js/pull/1835): Automatic instrumentation of page load events for simple web properties.
 
 # v3.0.0 (2023-11-16)

docs/reference/metrics.md

@@ -10,6 +10,7 @@ This means you might have to go searching through the dependency tree to get a f
 
 - [all-pings](#all-pings)
 - [deletion-request](#deletion-request)
+- [events](#events)
 
 ## all-pings
 
@@ -60,6 +61,48 @@ All Glean pings contain built-in metrics in the [`ping_info`](https://mozilla.gi
 
 This ping contains no metrics.
 
+## 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).
+
+This ping includes the [client id](https://mozilla.github.io/glean/book/user/pings/index.html#the-client_info-section).
+
+**Data reviews for this ping:**
+
+- <https://bugzilla.mozilla.org/show_bug.cgi?id=1512938#c3>
+
+**Bugs related to this ping:**
+
+- <https://bugzilla.mozilla.org/1512938>
+
+**Reasons this ping may be sent:**
+
+- `inactive`: The ping was submitted when becoming inactive. In earlier versions, this
+      was called `background`.
+
+      NOTE: It is not possible to find a definition of "inactivity" that spans
+      all of the platforms served by the Glean JavaScript SDK.
+      This reason is only listed here for documentation purposes.
+      It is never reported by the JavaScript SDK.
+
+- `max_capacity`: The maximum number of events was reached (default 1 event).
+
+- `startup`: The ping was submitted at startup.
+      The events ping is always sent if there are any pending events at startup,
+      because event timestamps are not as reliable across application runs.
+
+
+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) |
+| --- | --- | --- | --- | --- | --- | --- |
+| 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 |
+| 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 |
+
 Data categories are [defined here](https://wiki.mozilla.org/Firefox/Data_Collection).
 
 <!-- AUTOGENERATED BY glean_parser v10.0.3. DO NOT EDIT. -->