From b31564d5fc3c2df25ed50ec8a5598b03d6f956fb Mon Sep 17 00:00:00 2001 From: Alessio Placitelli Date: Tue, 21 Jul 2020 03:55:41 +0200 Subject: [PATCH] Remove the duplicated/outdated 'activation' ping docs (#12421) This additionally overhauls the Fenix telemetry docs to point at the Glean autogenerated docs, to prevent documentation getting outdated again. --- docs/activation.md | 36 ------------------------------------ docs/telemetry.md | 17 +++-------------- 2 files changed, 3 insertions(+), 50 deletions(-) delete mode 100644 docs/activation.md diff --git a/docs/activation.md b/docs/activation.md deleted file mode 100644 index 9c05c1755..000000000 --- a/docs/activation.md +++ /dev/null @@ -1,36 +0,0 @@ -# The `activation` ping - -## Description -This ping provides a measure of the activation of mobile products. - -## Scheduling -The `activation` ping is automatically sent at the very first startup, after Glean is initialized. -It is only sent once and only re-attempted a subsequent startups if it hasn't been sent yet. - -## Contents -This ping contains the following fields: - -| Field name | Type | Description | -|---|---|---| -| `identifier` | String | An hashed and salted version of the Google Advertising ID from the device. | -| `activation_id` | UUID | An alternate identifier, not correlated with the client_id, generated once and only sent with the activation ping. | - -The `activation` ping also includes the common [ping sections](https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/docs/pings/pings.md#ping-sections) -found in all pings, with the exclusion of the `client_id` (as defined by the [`pings.yaml`](../app/pings.yaml) file). - -## Example `activation` ping - -```json -{ - "ping_info": { }, - "client_info": { }, - "metrics": { - "string": { - "activation.identifier": "d+lnddDYN2ILBDGvhBIBHORRMrmVwTCp6rGLLFi8SMo=" - }, - "uuid": { - "activation.activation_id": "c0c40a5f-bd75-41ca-8097-9a38103de7fe" - } - } -} -``` diff --git a/docs/telemetry.md b/docs/telemetry.md index a98347111..fb73dfc4a 100644 --- a/docs/telemetry.md +++ b/docs/telemetry.md @@ -2,21 +2,10 @@ Fenix uses Mozilla's telemetry service (Glean) and LeanPlum to measure feature performance and engagement. -## Baseline ping +## Glean pings and metrics +By using the Glean SDK, Fenix can send the pings the SDK owns and defines, as documented [in the Glean SDK docs](https://mozilla.github.io/glean/book/user/pings/index.html). -Fenix creates and tries to send a "baseline" ping when the app goes to the background. This baseline ping is defined by the [Glean](https://github.com/mozilla/glean/tree/master/docs/user/pings) component and [documented in the Android Components repository](https://github.com/mozilla/glean/blob/master/docs/user/pings/baseline.md). - -## Metrics ping - -Fenix creates and tries to send a "baseline" ping. It is defined inside the [`metrics.yaml`](https://github.com/mozilla-mobile/fenix/blob/master/app/metrics.yaml) file. This ping includes things like whether or not Fenix is currently the default browser. - -## Events - -Fenix sends event pings that allows us to measure feature performance. These are defined inside the [`metrics.yaml`](https://github.com/mozilla-mobile/fenix/blob/master/app/metrics.yaml) file. - -## Activation - -Fenix sends an activation ping once, at startup. Further documentation can be found in the [`activation` ping](activation.md) docs. +Additional metrics or pings defined by Fenix are documented in the [Glean SDK autogenerated docs](metrics.md). ## Leanplum See [here](https://github.com/mozilla-mobile/fenix/blob/master/docs/mma.md) for details on Leanplum usage in Firefox Preview.