1503671 - Added Probe Dictionary link in about:telemetry to assist new users in understanding histograms.

Status: VERIFIED FIXED

(Toolkit :: Telemetry, defect)

Description

[Dan]

User Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:63.0) Gecko/20100101 Firefox/63.0

Steps to reproduce:

See pull request: https://github.com/mozilla/gecko-dev/pull/139


Actual results:

no link is there currently to direct to the probe dictionary.


Expected results:

Should've been easier to find the probe dictionary.

Comment 1

[Dan]

Attachment: edited the description line to be shorter, more easily understandable. changed 3 files, created "aboutTelemetry.telemetryProbeDictionary", added description

Comment 2

[Chris H-C :chutten]

Comment on attachment 9021629 [details] [diff] [review]
edited the description line to be shorter, more easily understandable.

changed 3 files, created "aboutTelemetry.telemetryProbeDictionary", added description

Review of attachment 9021629 [details] [diff] [review]:
-----------------------------------------------------------------

Thanks for the patch! We have a few things to do before it will be ready to land.

The commit message needs to be something like "bug 1503671 - Add Probe Dictionary link to about:telemetry r=chutten"

::: toolkit/locales/en-US/chrome/global/aboutTelemetry.dtd
@@ +23,4 @@
>  <!ENTITY aboutTelemetry.firefoxDataDoc "The <a>Firefox Data Documentation</a> contains guides about how to work with our data tools.">
>  <!ENTITY aboutTelemetry.telemetryClientDoc "The <a>Firefox Telemetry client documentation</a> includes definitions for concepts, API documentation and data references.">
>  <!ENTITY aboutTelemetry.telemetryDashboard "The <a>Telemetry dashboards</a> allow you to visualize the data Mozilla receives via Telemetry.">
> +<!ENTITY aboutTelemetry.telemetryProbeDictionary "The <a>Probe Dictionary</a> helps you to understand what each of the histogram items means, clicking on an item in the Probe Dictionary shows you a description.">

We need to keep these short. I recommend "The <a>Probe Dictionary</a> provides details and descriptions for the probes collected by Telemetry."

Comment 3

[Dan]

Comment on attachment 9021629 [details] [diff] [review]
edited the description line to be shorter, more easily understandable.

changed 3 files, created "aboutTelemetry.telemetryProbeDictionary", added description

Review of attachment 9021629 [details] [diff] [review]:
-----------------------------------------------------------------

To make it easier for new about:telemetry users to understand the items in the "histograms" menu, I've created "aboutTelemetry.telemetryProbeDictionary" and added the following description:
"The Probe Dictionary helps you to understand what each of the histogram items does, clicking on an item in the Probe Dictionary shows you a description."

Comment 4

[Chris H-C :chutten]

Comment on attachment 9021629 [details] [diff] [review]
edited the description line to be shorter, more easily understandable.

changed 3 files, created "aboutTelemetry.telemetryProbeDictionary", added description

Review of attachment 9021629 [details] [diff] [review]:
-----------------------------------------------------------------

Resetting the flag.

Comment 5

[Dan]

Comment on attachment 9021629 [details] [diff] [review]
edited the description line to be shorter, more easily understandable.

changed 3 files, created "aboutTelemetry.telemetryProbeDictionary", added description

From d3b9da0ff78caa223d6563a0bc0f6ddffa9ce23b Mon Sep 17 00:00:00 2001
From: Dani3lNL <[e-mail]>
Date: Wed, 31 Oct 2018 20:15:06 +0100
Subject: [PATCH 1/4] Update aboutTelemetry.xhtml

added aboutTelemetry.telemetryProbeDictionary
---
 toolkit/content/aboutTelemetry.xhtml | 1 +
 1 file changed, 1 insertion(+)

diff --git a/toolkit/content/aboutTelemetry.xhtml b/toolkit/content/aboutTelemetry.xhtml
index c078f31dc95d1..bb3fee30e1efd 100644
--- a/toolkit/content/aboutTelemetry.xhtml
+++ b/toolkit/content/aboutTelemetry.xhtml
@@ -142,6 +142,7 @@
           <li>&aboutTelemetry.firefoxDataDoc;</li>
           <li>&aboutTelemetry.telemetryClientDoc;</li>
           <li>&aboutTelemetry.telemetryDashboard;</li>
+          <li>&aboutTelemetry.telemetryProbeDictionary;</li>
         </ul>
       </section>
 

From 10e3ec932975623c2bb2a65abd7f081bc8ed508c Mon Sep 17 00:00:00 2001
From: Dani3lNL <[e-mail]>
Date: Wed, 31 Oct 2018 20:15:42 +0100
Subject: [PATCH 2/4] Update aboutTelemetry.dtd

added added "aboutTelemetry.telemetryProbeDictionary" with description: "The Probe Dictionary helps you to understand what each of the histogram items means, clicking on an item in the Probe Dictionary shows you a description."
---
 toolkit/locales/en-US/chrome/global/aboutTelemetry.dtd | 1 +
 1 file changed, 1 insertion(+)

diff --git a/toolkit/locales/en-US/chrome/global/aboutTelemetry.dtd b/toolkit/locales/en-US/chrome/global/aboutTelemetry.dtd
index d94a93db47618..64fcd96622700 100644
--- a/toolkit/locales/en-US/chrome/global/aboutTelemetry.dtd
+++ b/toolkit/locales/en-US/chrome/global/aboutTelemetry.dtd
@@ -23,6 +23,7 @@
 <!ENTITY aboutTelemetry.firefoxDataDoc "The <a>Firefox Data Documentation</a> contains guides about how to work with our data tools.">
 <!ENTITY aboutTelemetry.telemetryClientDoc "The <a>Firefox Telemetry client documentation</a> includes definitions for concepts, API documentation and data references.">
 <!ENTITY aboutTelemetry.telemetryDashboard "The <a>Telemetry dashboards</a> allow you to visualize the data Mozilla receives via Telemetry.">
+<!ENTITY aboutTelemetry.telemetryProbeDictionary "The <a>Probe Dictionary</a> helps you to understand what each of the histogram items means, clicking on an item in the Probe Dictionary shows you a description.">
 
 <!ENTITY aboutTelemetry.showInFirefoxJsonViewer "Open in the JSON viewer">
 

From 96ea1534422bc858277f31fa290363f8a5735e66 Mon Sep 17 00:00:00 2001
From: Dani3lNL <[e-mail]>
Date: Wed, 31 Oct 2018 20:24:39 +0100
Subject: [PATCH 3/4] Update aboutTelemetry.js

added link.
---
 toolkit/content/aboutTelemetry.js | 1 +
 1 file changed, 1 insertion(+)

diff --git a/toolkit/content/aboutTelemetry.js b/toolkit/content/aboutTelemetry.js
index 597aabd8068aa..48557bea23083 100644
--- a/toolkit/content/aboutTelemetry.js
+++ b/toolkit/content/aboutTelemetry.js
@@ -1783,6 +1783,7 @@ function setupPageHeader() {
     "https://docs.telemetry.mozilla.org/",
     "https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/index.html",
     "https://telemetry.mozilla.org/",
+    "https://telemetry.mozilla.org/probe-dictionary/",
   ];
   let htmlLink = document.querySelectorAll("#home-section > ul > li > a");
   htmlLink.forEach((a, index) => {

From da2659474633efe040c0e11a6cb8d64b6894f7f7 Mon Sep 17 00:00:00 2001
From: Dani3lNL <[e-mail]>
Date: Wed, 31 Oct 2018 21:21:11 +0100
Subject: [PATCH 4/4] edited the description text in the line

---
 toolkit/locales/en-US/chrome/global/aboutTelemetry.dtd | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/toolkit/locales/en-US/chrome/global/aboutTelemetry.dtd b/toolkit/locales/en-US/chrome/global/aboutTelemetry.dtd
index 64fcd96622700..a3babd453a71e 100644
--- a/toolkit/locales/en-US/chrome/global/aboutTelemetry.dtd
+++ b/toolkit/locales/en-US/chrome/global/aboutTelemetry.dtd
@@ -23,7 +23,7 @@
 <!ENTITY aboutTelemetry.firefoxDataDoc "The <a>Firefox Data Documentation</a> contains guides about how to work with our data tools.">
 <!ENTITY aboutTelemetry.telemetryClientDoc "The <a>Firefox Telemetry client documentation</a> includes definitions for concepts, API documentation and data references.">
 <!ENTITY aboutTelemetry.telemetryDashboard "The <a>Telemetry dashboards</a> allow you to visualize the data Mozilla receives via Telemetry.">
-<!ENTITY aboutTelemetry.telemetryProbeDictionary "The <a>Probe Dictionary</a> helps you to understand what each of the histogram items means, clicking on an item in the Probe Dictionary shows you a description.">
+<!ENTITY aboutTelemetry.telemetryProbeDictionary "The <a>Probe Dictionary</a> provides details and descriptions for the probes collected by Telemetry.">
 
 <!ENTITY aboutTelemetry.showInFirefoxJsonViewer "Open in the JSON viewer">

Comment 6

[Dan]

Attachment: edited the description line to be shorter, more easily understandable. [changed 3 files, created "aboutTelemetry.telemetryProbeDictionary", added description]

To make it easier for new about:telemetry users to understand the items in the "histograms" menu, I've created "aboutTelemetry.telemetryProbeDictionary" and added a description sentence (thanks to chutten for his suggestion of a better description)

Comment 7

[Chris H-C :chutten]

Comment on attachment 9021646 [details] [diff] [review]
edited the description line to be shorter, more easily understandable.  [changed 3 files, created "aboutTelemetry.telemetryProbeDictionary", added description]

Review of attachment 9021646 [details] [diff] [review]:
-----------------------------------------------------------------

The commit message is "Update aboutTelemetry.xhtml

added aboutTelemetry.telemetryProbeDictionary"

which isn't in the needed format. Also, the patch may not apply as the change to aboutTelemetry.dtd is repeated twice in the patch file.

Comment 8

[Dan]

Attachment: fixed commit title (I hope), edited the description line to be shorter, more easily understandable. [changed 3 files, created "aboutTelemetry.telemetryProbeDictionary", added description]

Comment 9

[Chris H-C :chutten]

Attachment: Screenshot of what about:telemetry looks like with the patch applied

Comment 10

[Chris H-C :chutten]

Attachment: 0001-bug-1503671-Add-to-about-telemetry-a-link-to-the-Pro.patch

This is the same patch as before, but condensed somewhat and with a reworded commit message.

Daniel, can you look this over and make sure everything looks good to you?

Comment 11

[Dan]

Yes looking good!

Comment 12

[Chris H-C :chutten]

No need to needinfo if there's no question :)

Comment 13

[Dan]

Oh sorry. Now we wait for this to be included into Nightly or what happens next?

Comment 14

[Chris H-C :chutten]

Now I'll mark this bug for the Sheriffs' attention to be included the next time they merge. Once there's a comment here saying it has landed in mozilla-central, then you'll know your code will be in the following Nightly.

Good job!

Now, if you're looking for more ways to help I recommend going through the documentation here: https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Introduction

It'll instruct you on how to get a code checkout and build running. It'll probably also show you how to use Phabricator for reviews, which gives us a way to get code into the tree without bothering the sheriffs each time. It's a bit of a process, especially if you're used to lighter-weight issue,code,review,merge cycles at smaller projects, but think of it as a free education in how large software projects work :)

Thank you again for your contribution!

Comment 15

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/mozilla-inbound/rev/9bbfbefd208f
Add to about:telemetry a link to the Probe Dictionary r=chutten

Comment 16

[Daniel Varga [:dvarga]]

https://hg.mozilla.org/mozilla-central/rev/9bbfbefd208f

Comment 17

[Dan]

Is there a way to see when this will land in Nightly? :)

Comment 18

[Dan]

ah I think it is the progress on this page? https://treeherder.mozilla.org/#/jobs?repo=mozilla-central&revision=2dd516cee24f58f9b833d9db676c5752b2ba2cd8 When this is at 100%, will we receive the Nightly update? :)

Comment 19

[Daniel Varga [:dvarga]]

I think in ~12h in the next merge.

Comment 20

[Dan]

Thanks so much, also for the push! :)

Comment 21

[Chris H-C :chutten]

If you look at https://hg.mozilla.org/mozilla-central/rev/9bbfbefd208f it tells you the first build with your change is Nightly build id 20181102100039 which is currently the latest release (as you can tell by clicking on its link which will direct you to 
https://hg.mozilla.org/mozilla-central/firefoxreleases#a6493a0b53a3nightlylinux3220181102100039)

Congratulations, code you wrote is shipping to Firefox users!

According to a quick query I did on the backend, it's in the hands of at least 450 users already (and the data I query is always a little out of date, so the real number is actually higher). By Monday it should reach saturation across the Nightly population. On December 10 it will ship to Beta. Then on January 28 it will ship to Release. (https://wiki.mozilla.org/Release_Management/Calendar)

Comment 22

[Dan]

OH YES, I just got the update, now it's IN! :D Thanks sooo much for your help and patience with my first pull request ("push"?) ! :) And thanks for congratulating me! :D I'm just sooo glad that "my code" didn't break the Nightly, as I just found out that there's a "try" thing on treeherder where one can test it privately first :/ :)
Can't wait for it to ship to Beta! :D I wonder, why will it take till 12.10.18 if according to the google calendar we have 2 Beta build releases every week? (this link https://goo.gl/uhWPdm )

Btw, is the query public, can I for myself find the approximate number of current revision a6493a0b53a3 users somewhere? :)
Hope you find the time to answer my questions from this comment :P

Comment 23

[Dan]

OOPS, I just noticed! We seem to have forgotten to add translation! I use Nightly in german (I'm german) and my "push" (?) of this code shows in english in my Nightly instead of german :P (I expected the sentence "The Probe Dictionary provides details and descriptions for the probes collected by Telemetry." to show up in german just like the other sentences in about:telemetry)

Comment 24

[Chris H-C :chutten]

Our localization (l10n) contributors will be helping out with translations. Since you speak German and you're enthusiastic, maybe you'll be interested in helping them out: https://l10n.mozilla.org/

Beta only picks up things when we ask for them to be included. If you'd like you can flag your patch approval-mozilla-beta? (in the Details) and fill out the form. Then someone (possibly the Release Manager) will come along and determine if it's a good fit to include in Beta. This patch is small, self-contained, and verified to be working Nightly so it's a decent candidate. It -does- have a translation requirement, though, so that may complicate things. Doesn't hurt to ask, though.

The number of users running different versions isn't something public. It's something ad hoc I calculated using internal tools. The Firefox Public Data Report (https://data.firefox.com/) does have monthly and weekly user population figures if you'd like to get a sense of scale, though.

Comment 25

[Dan]

Comment on attachment 9021870 [details] [diff] [review]
0001-bug-1503671-Add-to-about-telemetry-a-link-to-the-Pro.patch

[Beta/Release Uplift Approval Request]

Feature/Bug causing the regression: None

User impact if declined: 

Is this code covered by automated tests?: Yes

Has the fix been verified in Nightly?: Yes

Needs manual test from QE?: Yes

If yes, steps to reproduce: 

List of other uplifts needed: None

Risk to taking this patch: Low

Why is the change risky/not risky? (and alternatives if risky): not risky as only a text/description addition in about:telemetry page.

String changes made/needed:

Comment 26

[Dan]

Done! :)

about l10n, thanks, I just checked, it appears they only translate for FF Beta, not Nightly... so it'll have to wait :P (the english sentence would be in here https://pontoon.mozilla.org/de/firefox/toolkit/chrome/global/aboutTelemetry.dtd/?string=81255 )

Yes that's what I thought aswell, as it's self-contained the risk of something going wrong is very minor.

Comment 27

[Ryan VanderMeulen [:RyanVM]]

Not sure why "String changes made/needed" was left blank in comment 25 when this patch is clearly adding a new string. NI Flod for approval since Beta is supposed to be string frozen.

Comment 28

[Francesco Lodolo [:flod]]

Sorry but I don't see a good reason to uplift this change, it should ride the trains with 65.


P.S. note that the request is coming from a contributor at their first patch

Comment 29

[Ryan VanderMeulen [:RyanVM]]

Comment on attachment 9021870 [details] [diff] [review]
0001-bug-1503671-Add-to-about-telemetry-a-link-to-the-Pro.patch

Per comment 28, this can ship in 65.

Comment 30

[Francesco Lodolo [:flod]]

@Daniel

To give you more background: Beta is string frozen, and only particularly urgent patches are allowed to be uplifted if they contain string changes (that includes adding new strings).

And if you're interested in contributing to localization, see https://pontoon.mozilla.org/de/ ;-)

Comment 31

[Dan]

Alright, no big deal, can't wait for it to get into Beta mid december then :) And as I wrote in Comment 26 : "it appears they only translate for FF Beta, not Nightly... https://pontoon.mozilla.org/de/firefox/toolkit/chrome/global/aboutTelemetry.dtd/?string=81255" (Pontoon)

Ryan I'm sorry, as there was only 1 line available in "string changes made" I didn't know whether I should post several lines of code into that line.

Comment 32

[Dan]

Any idea which ESR version will most likely contain this addition? :)

Comment 33

[Chris H-C :chutten]

According to https://wiki.mozilla.org/Release_Management/Calendar the next ESR will be 68.

Comment 34

[Adrian Florinescu [:aflorinescu]]

Verified the Probe dictionary text and link addition in about:telemetry + the redirect to https://telemetry.mozilla.org/probe-dictionary/ for:
-65.0b8 20190103150357
-66.0a1 20190104093221
 on Windows 10/ Ubuntu 16.04 / OSX 10.14.2.