Skip to content
This repository has been archived by the owner on Feb 20, 2023. It is now read-only.

Automate Fenix telemetry documentation to probe-scraper #1156

Closed
liuche opened this issue Mar 22, 2019 · 11 comments
Closed

Automate Fenix telemetry documentation to probe-scraper #1156

liuche opened this issue Mar 22, 2019 · 11 comments
Assignees
Labels
E3 Estimation Point: average, 2 - 3 days eng:documentation Documentation for our team processes eng:health Improve code health Feature:Telemetry P1 Current sprint
Milestone

Comments

@liuche
Copy link
Contributor

liuche commented Mar 22, 2019

Why/User Benefit/User Problem

Generate telemetry documentation using an existing scraper.

What / Requirements

Add Fenix to the probe-scraper scripts (which is already generating docs for reference browser)

Acceptance Criteria (how do I know when I’m done?)

Docs are generated from metrics.yaml

┆Issue is synchronized with this Jira Task

@liuche
Copy link
Contributor Author

liuche commented Mar 22, 2019

@fbertsch do you manage the probe-scraper and could you do this for Fenix after #1067 lands?

@liuche liuche changed the title Add Fenix telemetry to probe-scraper Automate Fenix telemetry documentation to probe-scraper Mar 22, 2019
@vesta0 vesta0 added eng:documentation Documentation for our team processes P2 Upcoming release labels Apr 3, 2019
@vesta0 vesta0 added this to the Backlog (After MVP) milestone Apr 3, 2019
@bifleming
Copy link

@vesta0 do we want to make this a blocker and add it to the board?

@vesta0 vesta0 added Release Blocker Blocks a Release and removed P2 Upcoming release labels Jun 4, 2019
@fbertsch
Copy link

fbertsch commented Jun 5, 2019

@bifleming @liuche yes, I do manage the probe-scraper, and the data is available: https://probeinfo.telemetry.mozilla.org/glean/fenix/metrics

Are you looking to get this integrated into the probe-dictionary before launch? That is probably a Q3 goal at the earliest.

@vesta0
Copy link
Collaborator

vesta0 commented Jun 5, 2019

@fbertsch thanks for the info on probe-scraper!

Considering I didn't know there was a probe-dictionary (so cool!) I'd say no that's not the goal before launch but would be great for Q3. For now we are just looking to have a list of probes publicly documented similar to Focus.

@vesta0 vesta0 added this to Ready for Dev in Fenix Sprint Kanban Jun 5, 2019
@liuche
Copy link
Contributor Author

liuche commented Jun 5, 2019

@vesta0 we have a meeting set up for later this week about documentation of probes, but I'm wondering, could you clarify with Michael if linking to the metrics.yaml file would be acceptable to fulfill the requirements? I'm concerned that documenting probes similar to Focus in a wiki would be duplicated work (that the probe scraper will do) and engineering seems pretty overloaded with requirements at the moment.

@vesta0
Copy link
Collaborator

vesta0 commented Jun 5, 2019

@liuche the only legal requirement is that this is user readable and accessible. Let's chat about what we can do tomorrow. I hope that there is an interim solution that I can implement with minimum Eng effort.

@liuche
Copy link
Contributor Author

liuche commented Jun 5, 2019

@vesta0 does the metrics.yaml file work? for probe documentation at least.

@vesta0 vesta0 added this to the Reserved Backlog milestone Jul 11, 2019
@sblatz sblatz added eng:health Improve code health P2 Upcoming release labels Jul 19, 2019
@sblatz sblatz added this to Prioritized Eng Backlog in Fenix Sprint Kanban Jul 19, 2019
@vesta0 vesta0 modified the milestone: Feature Backlog Jul 26, 2019
@sblatz
Copy link
Contributor

sblatz commented Aug 8, 2019

See this document for more information from our meeting with Glean.

@sblatz sblatz added P1 Current sprint and removed P2 Upcoming release labels Aug 9, 2019
@sblatz
Copy link
Contributor

sblatz commented Aug 9, 2019

I'm estimating this as an E3 since #2706 will hold most of the refactor and this can piggy-back off of that :)

@sblatz sblatz added the E3 Estimation Point: average, 2 - 3 days label Aug 9, 2019
@bifleming bifleming added this to Prioritized Backlog in Fennec to Fenix Transition Aug 14, 2019
@liuche
Copy link
Contributor Author

liuche commented Aug 16, 2019

@sblatz will follow up w/ Glean team to see if they can do it this quarter, or if Fenix should.

@sblatz
Copy link
Contributor

sblatz commented Sep 12, 2019

Closed by #5101

@sblatz sblatz closed this as completed Sep 12, 2019
Fenix Sprint Kanban automation moved this from Prioritized Eng Backlog to Done Sep 12, 2019
Fenix Q3 Feature Backlog automation moved this from Must to Done! Sep 12, 2019
@sblatz sblatz added this to the v2.1 milestone Sep 12, 2019
@sblatz sblatz assigned Dexterp37 and unassigned boek Sep 12, 2019
@data-sync-user data-sync-user changed the title Automate Fenix telemetry documentation to probe-scraper FNX2-16554 ⁃ Automate Fenix telemetry documentation to probe-scraper Aug 1, 2020
@data-sync-user data-sync-user changed the title FNX2-16554 ⁃ Automate Fenix telemetry documentation to probe-scraper FNX3-14723 ⁃ Automate Fenix telemetry documentation to probe-scraper Aug 11, 2020
@data-sync-user data-sync-user changed the title FNX3-14723 ⁃ Automate Fenix telemetry documentation to probe-scraper FNX-4833 ⁃ Automate Fenix telemetry documentation to probe-scraper Aug 11, 2020
@data-sync-user data-sync-user changed the title FNX-4833 ⁃ Automate Fenix telemetry documentation to probe-scraper FNX2-16554 ⁃ Automate Fenix telemetry documentation to probe-scraper Aug 11, 2020
@data-sync-user data-sync-user changed the title FNX2-16554 ⁃ Automate Fenix telemetry documentation to probe-scraper Automate Fenix telemetry documentation to probe-scraper May 19, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
E3 Estimation Point: average, 2 - 3 days eng:documentation Documentation for our team processes eng:health Improve code health Feature:Telemetry P1 Current sprint
Projects
No open projects
Development

No branches or pull requests

9 participants