Privacy/Reviews/Telemetry
Document Overview
| Feature/Product: | Telemetry |
| Projected Feature Freeze Date: | (tbd) |
| Product Champions: | Taras Glek |
| Privacy Champions: | Sid Stamm, Asa Dotzler |
| Security Contact: | Curtis Koenig |
| Document State: | [NEW] |
Timeline:
| Architectural Overview: | [DONE] 28-April-2011 |
| Recommendation Meeting: | (date TBD) |
| Wrap-up Meeting: | (if necessary) |
Architecture
In this section, the product's architecture is described. Any individual components or actors are identified, their "knowledge" or what data they store is identified, and data flow between components and external entities is described.
The main objective of this feature/product is: (describe the goals of the feature/product here)
Design Documents: Link to any design or architectural documents here.
- EtherPad Design Doc
- Feature Page
- bug 585196: Infrastructure Bug for Telemetry
- Chromium code similar to our plan
Components
Describe any major components in the system and how they interact. Also include any third-party APIs (those Mozilla does not control) and what type of data is sent or received via those APIs.
Client Component (Firefox)
This component gathers metrics and uploads counters and histograms to the Telemetry server.
The tables below simply summarize the data encountered by this component.
Stored Data:
| What | Where |
|---|---|
| Metrics Gathered ?? (recorded every 60 seconds) | where stored ?? |
Communication with Server Component
| Direction | Message | Data | Notes |
|---|---|---|---|
| In: | ACK | HTTP 200/OK (no additional data) | |
| Out: | HTTP POST to /submit/telemetry/ | text/plain JSON-encoded object containing historgrams and counters | The types of data represented by histograms and counters will change over
time and the submission will contain a unique ID (nonce to identify strange duplicate submissions). Pings are once per day. |
Server Component
This component receives metrics from the Client Component and creates visualizations and queries for ((whom?))
The tables below simply summarize the data encountered by this component.
Stored Data:
| What | Where |
|---|---|
| data type | where stored |
Communication with Client Component
| Direction | Message | Data | Notes |
|---|---|---|---|
| In: | Telemetry submissions | (see above) | |
| Out: | ACK | HTTP 200/OK (no additional data) |
User Data Risk Minimization
In this section, the privacy champion will identify areas of user data risk and recommendations for minimizing the risk.
Alignment with Privacy Operating Principles
In this section, the privacy champion will identify how the feature lines up with Mozilla's privacy operating principles.
See Also: Privacy/Roadmap_2011#Operating_Principles:
Principle: Transparency / No Surprises: (How the feature addresses this)
Recommendations: (what can be improved)
Principle: Real Choice:
Recommendations:
Principle: Sensible Defaults:
Recommendations:
Principle: Limited Data:
Recommendations:
Follow-up Tasks and tracking
| What | Who | Bug | Details |
|---|---|---|---|
| [NEW] Initial Overview Discussion | Sid and Taras | Meeting 28-April-2011 |