1331091 - Document special behaviour of the "experiments" session

Status: RESOLVED FIXED

(Firefox for Android Graveyard :: Metrics, defect, P1)

Description

[:Grisha Kruglov]

The "experiments" session is not like the others, so lets document its behaviour in the tree. See Bug 1331059, Bug 1330179 and the server-side code at [0] for details.

This session's suffix (e.g. "experiments.1:grishasExperiment") is used to denote an active experiment, for which we have a separate column ("experiments"). We may have multiple experiment sessions active, and so this column is populated with a JSON array.

Currently the "experiments" session itself is not recorded.

[0] https://github.com/mozilla-services/data-pipeline/blob/master/reports/android-events/android-events.ipynb

Comment 1

[:Grisha Kruglov]

Attachment: Bug 1331091 - Document behaviour of special "experiment" telemetry sessions

Review commit: https://reviewboard.mozilla.org/r/106894/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/106894/

Comment 2

[Chenxia Liu [:liuche]]

Comment on attachment 8829925 [details]
Bug 1331091 - Document behaviour of special "experiment" telemetry sessions

https://reviewboard.mozilla.org/r/106894/#review108364

Nice, thanks for this extra clear documentation and context of bug numbers.

::: mobile/android/docs/uitelemetry.rst:64
(Diff revision 1)
> +
> +**Experiment** is a special type of a session. Experiments denote an "experiment scope".
> +Just like sessions, multiple experiments might be active at the same time. Experiments are recorded
> +by tagging events with an ``experiments.1:varying_experiment_name`` session. However, on the data
> +pipeline side, experiment's name is parsed and stored separately (in the ``experiments`` column).
> +Original ``experiment`` session is stripped away.

Slight clarification: The original ``experiment`` substring of the session name is stripped away.

::: mobile/android/docs/uitelemetry.rst:288
(Diff revision 1)
> +
>  ``awesomescreen.1``
>    Awesomescreen (including frecency search) is active.
>  
> +``experiment.1``
> +  Special, non-recorded session which is used to denote experiments. See ``Experiments`` section above.

Nit: I might mention that this is used in conjunction with an experiment name for clarity, or add the experiment format to the title (e.g. ``experiment.1:varying_experiment_name``), but that's up to you.

Comment 3

[:Grisha Kruglov]

Comment on attachment 8829925 [details]
Bug 1331091 - Document behaviour of special "experiment" telemetry sessions

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/106894/diff/1-2/

Comment 4

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/a62b71f67085
Document behaviour of special "experiment" telemetry sessions r=liuche

Comment 5

[Phil Ringnalda (:philor)]

https://hg.mozilla.org/mozilla-central/rev/a62b71f67085