1649357 - Clarify in telemetry API docs that only events flushed to storage are cleared

Status: RESOLVED FIXED

(Toolkit :: Telemetry, task)

Description

[Matthew N. [:MattN]]

[Event] telemetry from outside the parent process only gets flushed to the parent process on a 2s interval and Services.telemetry.clearEvents() won’t clear this buffer or prevent those buffered values from being added to the ping data. This can cause confusing failures in tests.
A pref was added to workaround this but it still seems like a footgun for events recorded before clearEvents to be added to storage after. For now I think we can make this a bit clearer and point to the pref from the .idl docs.

Comment 1

[Matthew N. [:MattN]]

Attachment: Bug 1649357 - Clarify in telemetry API docs that only events flushed to storage are cleared. r=janerik

Comment 2

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/61865ea6582e
Clarify in telemetry API docs that only events flushed to storage are cleared. r=Dexter

Comment 3

[Cristian Brindusan [:cbrindusan]]

https://hg.mozilla.org/mozilla-central/rev/61865ea6582e