Closed Bug 1510988 Opened 10 months ago Closed 8 months ago

Possible improvements for the new telemetry snapshot APIs

Categories

(Toolkit :: Telemetry, enhancement, P1)

enhancement

Tracking

()

RESOLVED FIXED
mozilla66
Tracking Status
firefox66 --- fixed

People

(Reporter: standard8, Assigned: janerik)

References

Details

Attachments

(3 files)

I've just come across these as I'm working on a patch that was using the old APIs. 

There's a few things that I don't understand with the new APIs. It could be that I don't have enough context here to know the reasoning behind them, if so, please enlighten me.

- The aClearStore parameter seems like it could be made optional. The old version of the API had it default to false, and I don't see why it couldn't be made to default false here as well.

- I find the documentation for the aStoreName parameter strange: 'Something like "main"' doesn't really tell me what it is about or where I would find out what names to actually use. After digging, I found a comment in https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/scalars.html#optional-fields that stores are still a WIP.

Maybe this could be changed to 'Use "main" for now' or '@see <url>' (with a bit of documentation behind it)?

- I don't know the future of stores, or what they will be, but could the aStoreName parameter also default to "main"?
Assignee: nobody → jrediger
Blocks: 1498159
Priority: -- → P2
Thanks for reporting. We are indeed lacking some better documentation currently, but plan to add that in the follow-ups after mozlando.
I take the other suggestions into consideration as well.
Priority: P2 → P3
Priority: P3 → P2
Priority: P2 → P1
Pushed by jrediger@mozilla.com:
https://hg.mozilla.org/integration/autoland/rev/95779bb37958
Make the clear flag optional in snapshot API r=chutten
https://hg.mozilla.org/integration/autoland/rev/12d1bf5d9b30
Clearly document what the store name in snapshot APIs is for r=chutten
https://hg.mozilla.org/integration/autoland/rev/85ba084b3f90
Make store name optional and default to "main" r=chutten
Status: NEW → RESOLVED
Closed: 8 months ago
Resolution: --- → FIXED
Target Milestone: --- → mozilla66
You need to log in before you can comment on or make changes to this bug.