Implementing Telemetry Firefox Source Docs documentation

April 2024 · 3 minute read

Things to note before implementation:

Procedure to follow before implementing the telemetry:

  • Contact Product team to understand the feature that we are adding telemetry to.

  • Contact the Data Science team to get the full requirements. This includes:

  • Work with the Data Science team to raise/lower expectations. Refine the requirements until every telemetry is clearly specified. This includes:

  • Consult with the Glean team if there’s any questions. (Ex: What type of data to use)

  • Procedure to follow when implementing a Glean telemetry event

  • Create an event in metrics.yaml and do a project rebuild to generate the event

  • To add feature tags see steps here.

  • Send the event from the proper place in the code with the appropriate generated method (e.g. GeneratedClassMetrics.generatedEvent.record())

  • Create pull requests

  • Submit a data review (example here). There’s also a command-line tool for generating Data Review Requests

  • Update the metrics.yaml with the data review

  • For startup metrics, make sure to manually test it

  • Review

    See example here

    After Merge

  • Make a note to revisit your telemetry changes when it makes it to beta/release.

  • Work with the data science team to make sure that they are seeing data that meet their requirements.

  • Renewing Expiring Telemetry

    See steps here

    ncG1vJloZqCdk6C8brDOnKpnpZ%2Bvtq24wGemq59doX5vv5Jmrp6ao57BpnrUrGSwnaOpenN6wKaYs6eelsS0esKopGiln5e2rbGOmqWdqp%2BesXCyxKegsWd5or2tscyepa2hnpx6lbHLnqSerKKue6nAzKU%3D