Event Telemetry: Difference between revisions

(Update in-tree docs link)
 
(7 intermediate revisions by 2 users not shown)
Line 6: Line 6:
The solution here is to provide common client code, a standard data format, so we can come up with common processes and tooling for data pipeline & analysis work.
The solution here is to provide common client code, a standard data format, so we can come up with common processes and tooling for data pipeline & analysis work.
Historically we already send a form of UITelemetry data, but the current format is too complicated to work with and to maintain.
Historically we already send a form of UITelemetry data, but the current format is too complicated to work with and to maintain.
=== Dates ===
* ...: Event data explorable in re:dash (from pre-release channels)
* '''Fx52''' (~2017-03-07): Event data collection implemented in Firefox Telemetry


=== Goals for Event Telemetry ===
=== Goals for Event Telemetry ===
Line 20: Line 16:
=== Documentation ===
=== Documentation ===
* [https://docs.google.com/document/d/1hNuS9lUJMvMqgntZXbFA6xZBU9zBpQgo7x73-sXKRpI/ Event Telemetry draft]
* [https://docs.google.com/document/d/1hNuS9lUJMvMqgntZXbFA6xZBU9zBpQgo7x73-sXKRpI/ Event Telemetry draft]
* [https://gecko.readthedocs.org/en/latest/toolkit/components/telemetry/telemetry/index.html In-tree docs (to be written)]
* [https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/collection/events.html In-tree docs]
* [https://docs.google.com/document/d/1cFCymhLQE7qI-p_czzz9-KexCMMhnf9ezLTMkGAKj58/edit#heading=h.w4fgaxpswo Table of projects that will be collecting Event telemetry]
* [https://docs.google.com/document/d/1cFCymhLQE7qI-p_czzz9-KexCMMhnf9ezLTMkGAKj58/edit#heading=h.w4fgaxpswo Table of projects that will be collecting Event telemetry]


Line 32: Line 28:
* '''2016 Q3'''
* '''2016 Q3'''
** Project kickoff
** Project kickoff
** Common Event Format
** Common Event Format design
** Event registration mechanism
** Event registration mechanism design
** Dataset strategy ([https://docs.google.com/document/d/1FI-jvzE4nVdas3e0o3QauNXUf5aQg9BGuXyVz0cDC1I/edit Event Telemetry Data sets discussion])
** Dataset strategy ([https://docs.google.com/document/d/1FI-jvzE4nVdas3e0o3QauNXUf5aQg9BGuXyVz0cDC1I/edit Event Telemetry Data sets discussion])
* '''2016 Q4'''
* '''2016 Q4'''
** Telemetry events on main pings implemented in Firefox
** Activity Stream submitting events (using common format, in main ping)
** Event data accessible in Spark
** Generic Event data table available in re:dash
** Test Pilot submitting events (using common format)
** Test Pilot submitting events (using common format)
** Custom sync ping is submitting events (using common format)
** Custom sync ping is submitting events (using common format)
** Event data tables available in re:dash
** Event data accessible in Spark
* '''2017 Q1'''
* '''2017 Q1'''
** Activity Stream submitting events (using common format) (Georg please fill out)
** More custom pings submitting events (using common format)
** Event store API (Georg please fill out)
** Non-specialized, analysis-oriented datasets available
** about:telemetry (Georg please fill out)
** Mobile plan (Q1/TBD)
** Mobile plan (Q1/TBD)
** Some project (TBD) is on the main ping
** Some project (TBD) is on the main ping
Line 52: Line 49:


=== Client Testing ===
=== Client Testing ===
* [https://docs.google.com/document/d/10sZICCbsfcSTF3RPyeVDskSI9-I2E4iApmShmIWSLfg/edit#heading=h.a6hfij6xookn Test cases document]
* [https://docs.google.com/a/mozilla.com/spreadsheets/d/1YxqvjRJuuIPRegNXAFCLHA7_56vhQ6leaZLaLeFqyxY/edit#gid=0 Spreadsheet to track testing]
* [https://bugzilla.mozilla.org/show_bug.cgi?id=1302670 Bugzilla tracking]
* [https://bugzilla.mozilla.org/show_bug.cgi?id=1302670 Bugzilla tracking]
=== Event Implementation Plan ===
* [https://docs.google.com/document/d/1cFCymhLQE7qI-p_czzz9-KexCMMhnf9ezLTMkGAKj58/edit#heading=h.w4fgaxpswo List of Event groups, events, owners etc]


= Communication =
= Communication =

Latest revision as of 20:54, 19 May 2020

The Telemetry wiki page has more information about using Telemetry -- this page describes the Event Telemetry project.

Overview

There is a common need across teams (fx-team, mobile, test-pilot, heartbeat, …) to have a mechanism for recording, storing, sending & analysing application usage in an event-oriented format. The Data Platform team wants to support this with a common API and mechanisms for dealing with the collected data, without owning the individual measurements. The solution here is to provide common client code, a standard data format, so we can come up with common processes and tooling for data pipeline & analysis work. Historically we already send a form of UITelemetry data, but the current format is too complicated to work with and to maintain.

Goals for Event Telemetry

  • Standardized event format for all pings collecting events (Main Ping, Test Pilot, Shield, Sync, etc.)
  • Expand collection of UI Telemetry to support Product teams
  • Enable top line metrics for 2017
  • Standardized support for analysis of events
  • API support in client for collecting event telemetry

Documentation

Analysis and Reporting

Project

Deliverables

  • 2016 Q3
  • 2016 Q4
    • Telemetry events on main pings implemented in Firefox
    • Activity Stream submitting events (using common format, in main ping)
    • Event data accessible in Spark
    • Generic Event data table available in re:dash
    • Test Pilot submitting events (using common format)
    • Custom sync ping is submitting events (using common format)
  • 2017 Q1
    • More custom pings submitting events (using common format)
    • Non-specialized, analysis-oriented datasets available
    • Mobile plan (Q1/TBD)
    • Some project (TBD) is on the main ping

Client work

Client Testing

Communication

People and Roles

  • Georg Fritzsche (Data Platform, lead)
  • Alessio Placitelli, :Dexter (Data Platform)
  • Mark Reid (Data Platform)
  • Roberto Vitillo (Data Platform)
  • Sunah Suh (Data Platform)
  • Rebecca Weiss (PM)
  • Ilana Segall (Analysis)
  • John Dorlus (Quality Engineering)
  • Thomas Huelbert (project management)