Migrating to newer Glean Events API (introduced with Glean v39)

[badboy]

API Reference for Events

Glean gained type annotations for extra keys, allowing for string, boolean and quantity (a numeric value).
This changes the calling API if specified.
Note: Data is still sent stringified.

Old metrics definition:

views:
  login_opened:
    type: event
    description: |
      Recorded when the login view is opened.
    extra_keys:
      source_of_login:
        description: The source
    ...

New metrics definition:

views:
  login_opened:
    type: event
    description: |
      Recorded when the login view is opened.
    extra_keys:
      source_of_login:
        type: string
        description: The source
    ...

Old calling API:

import org.mozilla.yourApplication.GleanMetrics.Views

Views.loginOpened.record(mapOf(Views.loginOpenedKeys.sourceOfLogin to "toolbar"))

New calling API:

import org.mozilla.yourApplication.GleanMetrics.Views

Views.loginOpened.record(Views.loginOpenedExtra(sourceOfLogin = "toolbar"))

The old calling API is deprecated as of Glean v39 (June 2021).
There are currently no plans for full removal of the deprecated API.
Any removal will only happen in another major version release and communicated accordingly.

┆Issue is synchronized with this Jira Task

[mcomella]

I imagine adding the types might make the current wrapper around glean difficult to refactor. It could be a good opportunity to move towards the recommended model for glean where we call the probes directly where they're recorded rather than moving through a wrapper.

[stale]

See: #17373 This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[mcarare]

This will be handled in parallel with the removal of the wrapper in #21292. The new calls will also take into consideration this issue. I am leaving it open tough, to check that all calls follow the new calling API.

[mcarare]

Closing as all telemetry using old metrics definitions has been migrated.