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

Latest commit

 

History

History
139 lines (84 loc) · 11.9 KB

metrics.md

File metadata and controls

139 lines (84 loc) · 11.9 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

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.

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
rally.id uuid The id of the Rally client. This is generated by the Rally SDKs. A value of 00000000-0000-0000-0000-000000000000 indicates a test payload. A value of 11111111-1111-1111-1111-111111111111 indicates that the Rally id was not found or properly set. Review 1 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.

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
rally.id uuid The id of the Rally client. This is generated by the Rally SDKs. A value of 00000000-0000-0000-0000-000000000000 indicates a test payload. A value of 11111111-1111-1111-1111-111111111111 indicates that the Rally id was not found or properly set. Review 1 never

fbpixelhunt-journey

A page navigation event

Data reviews for this ping:

Bugs related to this ping:

Reasons this ping may be sent:

  • page-navigation-observed: Page navigation was observed.

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
rally.id uuid The id of the Rally client. This is generated by the Rally SDKs. A value of 00000000-0000-0000-0000-000000000000 indicates a test payload. A value of 11111111-1111-1111-1111-111111111111 indicates that the Rally id was not found or properly set. Review 1 never
user_journey.attention_and_audio_duration quantity How long a user audio event occurred while attention was focused on the tab. Review 1
  • unit: milliseconds
never
user_journey.attention_duration quantity How long the user attention event occurred (window/tab was focused and not idle). Review 1
  • unit: milliseconds
never
user_journey.audio_duration quantity How long a user audio event occurred. Review 1
  • unit: milliseconds
never
user_journey.max_relative_scroll_depth quantity The largest depth reach on the page, as a proportion of the total page height. Review 1
  • unit: percentage
never
user_journey.page_id string A unique ID associated with a page visit. Each page ID is 128-bit value, randomly generated with the Web Crypto API and stored as a hexadecimal string. Review 1 never
user_journey.page_visit_start_date_time datetime When did the page visit start. Review 1 never
user_journey.page_visit_start_time quantity NOTE: deprecated in favor of page_visit_start_date_time. When did the page visit start. Review 1
  • unit: millisecond
never
user_journey.page_visit_stop_date_time datetime When did the page visit stop. Review 1 never
user_journey.page_visit_stop_time quantity NOTE: deprecated in favor of page_visit_stop_date_time. When did the page visit stop. Review 1
  • unit: millisecond
never
user_journey.referrer url The HTTP Referrer URL (if set). Review 1 never
user_journey.url url The URL visited. Review 1 never

fbpixelhunt-pixel

A ping representing a tracking pixel event observed by the study. See the reasons documentation for additional information.

Data reviews for this ping:

Bugs related to this ping:

Reasons this ping may be sent:

  • tracking-pixel-observed: A Facebook pixel was observed.

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
facebook_pixel.form_data text Any HTTP POST form data sent along to the tracker. Review 1 never
facebook_pixel.has_facebook_login_cookies boolean A boolean indicating whether or not Facebook knows the login status of the participant. Note that this doesn't track if the participant is logged into facebook. Review 1 never
facebook_pixel.page_id string A unique ID associated with a page visit. Each page ID is 128-bit value, randomly generated with the Web Crypto API and stored as a hexadecimal string. NOTE: deprecated in favor of pixel_page_id. Review 1 never
facebook_pixel.pixel_page_id string A unique ID associated with a page visit. Each page ID is 128-bit value, randomly generated with the Web Crypto API and stored as a hexadecimal string. Review 1 never
facebook_pixel.url url The pixel request url that Facebook collects. Review 1 never
rally.id uuid The id of the Rally client. This is generated by the Rally SDKs. A value of 00000000-0000-0000-0000-000000000000 indicates a test payload. A value of 11111111-1111-1111-1111-111111111111 indicates that the Rally id was not found or properly set. Review 1 never

study-enrollment

This ping is sent when the user has consented to the study.

Data reviews for this ping:

Bugs related to this 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
rally.id uuid The id of the Rally client. This is generated by the Rally SDKs. A value of 00000000-0000-0000-0000-000000000000 indicates a test payload. A value of 11111111-1111-1111-1111-111111111111 indicates that the Rally id was not found or properly set. Review 1 never

Data categories are defined here.