Skip to content

metrics.md

Latest commit

 

History

History
112 lines (68 loc) · 8.67 KB

metrics.md

File metadata and controls

112 lines (68 loc) · 8.67 KB

Metrics

This document enumerates the metrics collected by this project using the Glean SDK. This project may depend on other projects which also collect metrics. This means you might have to go searching through the dependency tree to get a full picture of everything collected by this project.

Pings

all-pings

These metrics are sent in every ping.

All Glean pings contain built-in metrics in the ping_info and client_info 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
glean.client.annotation.experimentation_id string An experimentation identifier derived and provided by the application for the purpose of experimentation enrollment. Bug 1848201 never 1
glean.error.invalid_label labeled_counter Counts the number of times a metric was set with an invalid label. The labels are the category.name identifier of the metric. Bug 1499761 never 1
glean.error.invalid_overflow labeled_counter Counts the number of times a metric was set a value that overflowed. The labels are the category.name identifier of the metric. Bug 1591912 never 1
glean.error.invalid_state labeled_counter Counts the number of times a timing metric was used incorrectly. The labels are the category.name identifier of the metric. Bug 1499761 never 1
glean.error.invalid_type labeled_counter Counts the number of times a metric set a value which was not of the expected type. The labels are the category.name identifier of the metric. This error type is only recorded by the Glean JavaScript SDK. This error may only happen in dynamically typed languages. Bug 1591912 never 1
glean.error.invalid_value labeled_counter Counts the number of times a metric was set to an invalid value. The labels are the category.name identifier of the metric. Bug 1499761 never 1
glean.restarted event Event that signals an application restart. This event is included in all pings (custom or otherwise) that contain events. mozilla/glean.js#526 never 1

deletion-request

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

See the Glean SDK documentation for the deletion-request ping.

This ping is sent if empty.

This ping includes the client id.

Data reviews for this ping:

Bugs related to this ping:

Reasons this ping may be sent:

  • at_init: The ping was submitted at startup. Glean discovered that between the last time it was run and this time, upload of data has been disabled.

  • set_upload_enabled: The ping was submitted between Glean init and Glean shutdown. Glean was told after init but before shutdown that upload has changed from enabled to disabled.

All Glean pings contain built-in metrics in the ping_info and client_info sections.

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.

This ping includes the client id.

Data reviews for this ping:

Bugs related to this ping:

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 and client_info 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
glean.element_click event 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
  • id: An identifier of the element clicked. For automatic collection, its value is the element's data-glean-id data attribute value.
  • label: The label of the element clicked. For automatic collection, its value is the element's data-glean-label data attribute value.
  • referrer: The referrer of the page where the element was clicked.
  • title: The title of the page where the element was clicked.
  • type: The type of the element clicked. For automatic collection, its value is the element's data-glean-type data attribute value.
  • url: The URL of the page where the element was clicked.
 never 2
glean.page_id uuid Uniquely identifies a page_load, not the page itself, for the purpose of associating other events with the specific page load event. This gets rotated with each page load and is sent along with each event ping. Bug 1888430 never 1
glean.page_load event 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
  • referrer: The page referrer.
  • title: The page title.
  • url: The page URL.
 never 2

Data categories are defined here.