1526343 - Make Glean.sendPing public

Status: RESOLVED FIXED

(Toolkit :: Telemetry, enhancement, P3)

Description

[Michael Droettboom [:mdroettboom]]

There's currently no way to send a custom ping, and Glean.sendPing could certainly be it. Though perhaps we want the public API to only be able to send custom pings, not built-in ones.

Comment 1

[Michael Droettboom [:mdroettboom]]

Recently, Glean.sendPing became Glean.sendPings (to support parallel sending), but the issue fundamentally still stands.

Comment 2

[Michael Droettboom [:mdroettboom]]

I feel like we can basically get away with making the existing sendPings public, however, I think for safety we shouldn't allow the public API to send pings that are internally managed and scheduled by glean (metrics, events, baseline). It seems like it would be too easy to screw up the carefully-orchestrated scheduling on those. How do others feel about that?

Comment 3

[Travis Long [:travis_]]

I think that's fine, I was also a little concerned about limiting the public access to the internal pings. As long as you are limiting the public API to only sending custom pings, then I am okay with that approach.

Comment 4

[Georg Fritzsche [:gfritzsche]]

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

I feel like we can basically get away with making the existing sendPings public, however, I think for safety we shouldn't allow the public API to send pings that are internally managed and scheduled by glean (metrics, events, baseline). It seems like it would be too easy to screw up the carefully-orchestrated scheduling on those. How do others feel about that?

+1 from me to just disallowing the pings owned by Glean for it.

Comment 5

[Alessio Placitelli [:Dexter]]

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

I feel like we can basically get away with making the existing sendPings public, however, I think for safety we shouldn't allow the public API to send pings that are internally managed and scheduled by glean (metrics, events, baseline). It seems like it would be too easy to screw up the carefully-orchestrated scheduling on those. How do others feel about that?

Yes. The only caveat there is that we want GleanDebugActivity to still be able to trigger pings we own (e.g. to test events or recorded metrics). One easy way to make this work would be to have 2 APIs:

• an internal internalSendPings (or something like that), which would be unfiltered. This would be callable from the GleanDebugActivity, which has access to internals;
• the public sendPings, which would apply ping filtering and then call internalSendPings.

Comment 6

[Michael Droettboom [:mdroettboom]]

Attachment: GitHub Pull Request

Comment 7

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/257f052724c1
[components] 1526343: Add public sendPings API