1557046 - Document why events pings can have timestamps outside of their duration

Status: RESOLVED FIXED

(Data Platform and Tools :: Glean: SDK, defect, P3)

Description

[Michael Droettboom [:mdroettboom]]

A follow-up to this bug -- we should explain why timestamps in an events ping can be greater than the duration of the ping.

Comment 1

[Michael Droettboom [:mdroettboom]]

This really relates to the format of the ping contents, which isn't really documented anywhere outside of the glean schema in mozilla-pipeline-schemas. I think we should have some narrative documentation of the ping contents -- but where should that go? We could make a new chapter in the docs for this, or we could document it with each metric type. I kind of like the latter -- let's document everything about a particular metric on one page -- but I know there are those who prefer to keep the SDK docs just for SDK users.

Thoughts?

Comment 2

[Alessio Placitelli [:Dexter]]

(In reply to Michael Droettboom [:mdroettboom] from comment #1)

This really relates to the format of the ping contents, which isn't really documented anywhere outside of the glean schema in mozilla-pipeline-schemas.

Any specific content you're thinking about? I was specifically only considering event timestamps and the ping start_time, end_time.

I think we should have some narrative documentation of the ping contents -- but where should that go? We could make a new chapter in the docs for this, or we could document it with each metric type. I kind of like the latter -- let's document everything about a particular metric on one page -- but I know there are those who prefer to keep the SDK docs just for SDK users.

Thoughts?

If the narrative is about the content mentioned above, maybe it could simply live here: https://mozilla.github.io/glean/book/user/pings/events.html - what do you think?