Closed Bug 1820326 Opened 2 years ago Closed 2 years ago

Backout documentation changes to Metrics.yaml

Categories

(Firefox :: Address Bar, defect, P1)

defect

Tracking

()

RESOLVED FIXED
112 Branch
Tracking Status
firefox-esr102 --- unaffected
firefox110 --- unaffected
firefox111 --- unaffected
firefox112 --- fixed

People

(Reporter: mak, Assigned: mcheang)

References

(Blocks 1 open bug, Regression)

Details

(Keywords: regression, Whiteboard: [snt-])

Attachments

(1 file)

Bug 1815699 has landed some documentation changes to Metrics.yaml, but the glean event telemetry changes from that patch didn't land, thus Metrics.yaml should have not been touched.

The main problem is it introduced a "quicksuggest" result, but glean event telemetry doesn't return such a thing, it would indeed be confusing to return a quicksuggest type without saying what it is.

Set release status flags based on info from the regressing bug 1815699

:mcheang, since you are the author of the regressor, bug 1815699, could you take a look?

For more information, please visit auto_nag documentation.

Hi Marco,

I added the "quicksuggest" result in Bug 1815699 intentionally. Sorry I wasn't explicit about it in my patch. Drew and I discussed on Slack about it and since the glean documentation links is missing "quicksuggest" it seemed to be a good opportunity for me to fix that in my patch while I'm working on weather.

These docs were missing "quicksuggest":
https://dictionary.telemetry.mozilla.org/apps/firefox_desktop/metrics/urlbar_impression
https://dictionary.telemetry.mozilla.org/apps/firefox_desktop/metrics/urlbar_engagement/
https://dictionary.telemetry.mozilla.org/apps/firefox_desktop/metrics/urlbar_abandonment

If I understand correctly, we return "quicksuggest" in glean telemetry here:
UrlbarUtils.telemetryTypeFromResult
https://searchfox.org/mozilla-central/rev/00ea1649b59d5f427979e2d6ba42be96f62d6e82/browser/components/urlbar/UrlbarUtils.sys.mjs#1207

We return "quicksuggest" in legacy Telemetry:
https://searchfox.org/mozilla-central/rev/00ea1649b59d5f427979e2d6ba42be96f62d6e82/browser/components/urlbar/UrlbarProviderQuickSuggest.sys.mjs#532

https://searchfox.org/mozilla-central/rev/00ea1649b59d5f427979e2d6ba42be96f62d6e82/browser/components/urlbar/UrlbarProviderQuickSuggest.sys.mjs#456

Questions:
Could you help me understand what you mean by that patch didn't land?

Bug 1815699 has landed some documentation changes to Metrics.yaml, but the glean event telemetry changes from that patch didn't land

Does this mean my entire commit is getting backed out or was it only the metrics.yaml file that is getting backed out?

Also, based on what I said above. Do you think I should remove "quicksuggest" in metrics.yaml or leave it in?

Flags: needinfo?(mcheang) → needinfo?(mak)

(In reply to Mandy Cheang [:mcheang][she/her] from comment #2)

If I understand correctly, we return "quicksuggest" in glean telemetry here:
UrlbarUtils.telemetryTypeFromResult
https://searchfox.org/mozilla-central/rev/00ea1649b59d5f427979e2d6ba42be96f62d6e82/browser/components/urlbar/UrlbarUtils.sys.mjs#1207

Glean engagement telemetry uses searchEngagementTelemetryType, not telemetryTypeFromResult https://searchfox.org/mozilla-central/rev/00ea1649b59d5f427979e2d6ba42be96f62d6e82/browser/components/urlbar/UrlbarUtils.sys.mjs#1308
The main reason is that we wanted understandable labels, and for example quicksuggest is not detailed enough.

Questions:
Could you help me understand what you mean by

Bug 1815699 has landed some documentation changes to Metrics.yaml, but the glean event telemetry changes from that patch didn't land

Does this mean my entire commit is getting backed out or was it only the metrics.yaml file that is getting backed out?

Only the changes to Metrics.yaml were wrong, because weather was already there, and it uses searchEngagementTelemetryType, not telemetryTypeFromResult
So only those changes to Metrics.yaml should be undone.

Flags: needinfo?(mak)
Assignee: nobody → mcheang
Status: NEW → ASSIGNED
Pushed by mcheang@mozilla.com: https://hg.mozilla.org/integration/autoland/rev/dc2d1a9fff4b Remove quicksuggest result from metrics.yaml because glean telemetry doesn't return quicksuggest. r=mak

Added a JIRA ticket for visibility

Whiteboard: [snt-]
Status: ASSIGNED → RESOLVED
Closed: 2 years ago
Resolution: --- → FIXED
Target Milestone: --- → 112 Branch
You need to log in before you can comment on or make changes to this bug.

Attachment

General

Created:
Updated:
Size: