Metrics¶
This document enumerates the metrics collected by Firefox 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¶
fog-validation¶
This ping is intended to evaluate the behaviour of FOG before it ships beyond Nightly. This is a temporary ping. It is sent one hour after FOG is initialized, and every hour thereafter.
This ping is sent if empty.
This ping includes the client id.
Data reviews for this ping:
Bugs related to this ping:
The following metrics are added to the ping:
| Name | Type | Description | Data reviews | Extras | Expiration | Data Sensitivity |
|---|---|---|---|---|---|---|
| fog_validation.legacy_telemetry_client_id | uuid | The Telemetry client_id. To be sent only in the "fog-validation" ping. | 1 | 89 | 1, 4 | |
| fog_validation.os_version | string | The version of the OS running Firefox, as detected by Gecko. To be sent only in the "fog-validation" ping. | 1 | 89 | 1 | |
| fog_validation.profile_disk_is_ssd | boolean | True iff the type of the disk the current Firefox profile is stored on is an SSD. (Windows only). | 1 | 89 | 1 |
metrics¶
This is a built-in ping that is assembled out of the box by the Glean SDK.
See the Glean SDK documentation for the metrics ping.
The following metrics are added to the ping:
| Name | Type | Description | Data reviews | Extras | Expiration | Data Sensitivity |
|---|---|---|---|---|---|---|
| fog.initialization | timespan | Time the FOG initialization takes. | 1 | never | 1 | |
| fog.ipc.replay_failures | counter | The number of times the ipc buffer failed to be replayed in the parent process. | 1 | never | 1 |
one-ping-only¶
This ping is for tests only.
This ping is sent if empty.
Data reviews for this ping:
Bugs related to this ping:
This ping contains no metrics.
store1¶
The following metrics are added to the ping:
| Name | Type | Description | Data reviews | Extras | Expiration | Data Sensitivity |
|---|---|---|---|---|---|---|
| test_only.ipc.a_bool | boolean | This is a test-only metric. Just flagging things. | 1 | never | 1 | |
| test_only.ipc.a_counter | counter | This is a test-only metric. Just counting things. | 1 | never | 1 | |
| test_only.ipc.a_date | datetime | This is a test-only metric. Just putting things on the calendar. | 1 | never | 1 | |
| test_only.ipc.a_memory_dist | memory_distribution | This is a test-only metric. Just measuring memory. | 1 | never | 1 | |
| test_only.ipc.a_string | string | This is a test-only metric. Just setting some strings. | 1 | never | 1 | |
| test_only.ipc.a_string_list | string_list | This is a test-only metric. Just appending some strings. | 1 | never | 1 | |
| test_only.ipc.a_timing_dist | timing_distribution | This is a test-only metric. Just measuring time. | 1 | never | 1 | |
| test_only.ipc.a_uuid | uuid | This is a test-only metric. Just recording some unique identifiers. | 1 | never | 1 | |
| test_only.ipc.an_event | event | This is a test-only metric. Just recording some events. | 1 |
|
never | 1 |
| test_only.ipc.no_extra_event | event | This is a test-only metric. Just recording some events without the extra fuss. | 1 | never | 1 |
test-ping¶
The following metrics are added to the ping:
| Name | Type | Description | Data reviews | Extras | Expiration | Data Sensitivity |
|---|---|---|---|---|---|---|
| test_only.bad_code | counter | Number of times we encountered bad code. This is a test-only metric. | 1 | never | 1 | |
| test_only.can_we_flag_it | boolean | Test metric for a boolean. This is a test-only metric. | 1 | never | 1 | |
| test_only.can_we_time_it | timespan | Test metric for a timespan. This is a test-only metric. | 1 | never | 1 | |
| test_only.cheesy_string | string | Only the cheesiest of strings. This is a test-only metric. | 1 | never | 1 | |
| test_only.cheesy_string_list | string_list | Only the cheesiest of strings. In list form! This is a test-only metric. | 1 | never | 1 | |
| test_only.do_you_remember | memory_distribution | They say it's the second thing to go. This is a test-only metric. | 1 | never | 1 | |
| test_only.what_a_date | datetime | ...To be writing FOG code. This is a test-only metric. | 1 | never | 1 | |
| test_only.what_id_it | uuid | Just a UUID. This is a test-only metric. | 1 | never | 1 | |
| test_only.what_time_is_it | timing_distribution | Adheres to at least two of the top ten fallacies programmers believe about time. This is a test-only metric. | 1 | never | 1 |
Data categories are defined here.