1513939 - Add an "app_id" field to the common information

Status: RESOLVED FIXED

(Toolkit :: Telemetry, enhancement, P1)

Description

[Alessio Placitelli [:Dexter]]

Looks like we're lacking a field to tell applications that use glean apart. Right now, we have "app_build" [1] but each application can have multiple builds.

We need a unique identifier to distinguish things coming off the reference browser and, for example, Fenix. Such an ID will also be used in [2].

We could also make glean initialization fail hard (throw exceptions from Glean.initialize()) in case no `app_id` is provided.

[1] - https://github.com/mozilla-mobile/android-components/blob/master/components/service/glean/docs/pings.md
[2] - https://docs.google.com/document/u/1/d/1S8nDWcSj4zVKZjP1whXuOZhTDSIerZP5Ixm92u0a2uQ/edit

Comment 1

[Alessio Placitelli [:Dexter]]

Attachment: GitHub Pull Request

Comment 2

[Michael Droettboom [:mdroettboom]]

Attachment: GitHub Pull Request

Comment 3

[Michael Droettboom [:mdroettboom]]

In the discussion here, it was determined that the app id name must not contain any periods in order to work with the backend infrastructure. We probably should submit a PR to android-components to enforce this. I think it's reasonable to use the app store id, replacing all . with - as a default, and then validate any name that the application gives to glean explicitly.

Comment 4

[Chris H-C :chutten]

Idle thought: Do we know whether or not we'll ever want to transform the name back? If so a different escaping scheme may be warranted to avoid something like:

org.mozilla.my-glean-app -> org-mozilla-my-glean-app -> org.mozilla.my.glean.app

Comment 5

[Alessio Placitelli [:Dexter]]

(In reply to Chris H-C :chutten from comment #4)

Idle thought: Do we know whether or not we'll ever want to transform the name back? If so a different escaping scheme may be warranted to avoid something like:

org.mozilla.my-glean-app -> org-mozilla-my-glean-app -> org.mozilla.my.glean.app

I didn't hear any requirement about this, so I'm assuming no. I guess that if we care that much about id/names, we can add that as a specific field to the baseline/ping_info

Comment 6

[Alessio Placitelli [:Dexter]]

Attachment: PR for sanitizing app id

Comment 7

[Alessio Placitelli [:Dexter]]

Everything was merged. Closing this.