This updates a couple of links, add links to our tools
and most importantly updates the included overview image (and adds
appropriate alt text).
Also included is the source file for that image, usable on
https://draw.io, in case we need to edit or re-use that in the future.
This commit is contained in:
Jan-Erik Rediger 2022-05-06 11:58:33 +02:00
Родитель f0a26e6723
Коммит 85c28488da
4 изменённых файлов: 14 добавлений и 8 удалений

Двоичные данные
src/assets/Glean_overview.jpg

Двоичный файл не отображается.

До

Ширина:  |  Высота:  |  Размер: 30 KiB

Просмотреть файл

@ -0,0 +1 @@
<mxfile host="app.diagrams.net" modified="2022-05-06T09:56:07.739Z" agent="5.0 (Macintosh)" etag="79icHNhFp9STVcN90cO8" version="15.7.4"><diagram id="pEgxSdzWIaXeMp_UbgXY" name="Page-1">7VpbV+IwEP41PLqHtrTAIxd1z1l3j2fZi/oWmwGyhgZDENxfv1OSlt4QRC5dFB9sviTTZObLzGSg4nRG80tJxsOvggKv2FU6rzjdim1bTa+G/0Lk2SCW52lkIBk12BLosb9gwKpBp4zCJDVQCcEVG6dBXwQB+CqFESnFLD2sL3j6rWMygBzQ8wnPo78ZVUONNtzqEv8MbDCM3mxVTc+IRIMNMBkSKmYJyDmvOB0phNJPo3kHeKi9SC963sWK3nhhEgK1yQRWv+t5N48/b9qt6a1915N/2LczW0t5InxqNmwWq54jDUgxDSiEQqoVpz0bMgW9MfHD3hkaHbGhGnFsWfjYZ5x3BBdyMdehBBp9H/GJkuIBEj2e34D7PvaYBYBUMF+5MyvWFzINxAiUfMYhZkLDaNhwLLLNbGmveMgwYasYJIYjg1jyUo34YDT5Cq06BVr1OL62TdlTSrve4zS0f7svAnU2WbC/hQMsdzxfduLTwPzn0eDtpYyloFM8KUYYblDLS78D4cVa02gJlu8LCZGke1mw7E12s0OK993wz6w+getPIfUXn91QP3Y3hvv1PPcLqV/bF/VrK6n/NrNfciAB9va6X1ba+mSsansls6q7PkxAQFthvMXWPRf+Q1q9aVvAnKkb0xM+34b4J9e0uvPEsO5z1AhwIzfJRmJW2FxOW7SiedpQUezWo+kF49HK9EaA5tKAjLFws2IqfVjv9hWRA1Drzkje+AnrugXWjTAJnCj2lF5ukcXNG64FWxw8w61axmM4zQxp9DbNrGQ+kRXkZgRl2af1kBO0IGC87e056b0cZLVTkIDxgk42jAN4YlWat+ljHogAMr7CQISzQYBNH0kDiLfD888wjWyZjhGjNHxNoR9Kn45dhIVm2jZWQU7kFXDM2ZcDqb81I7J3klIUS7neKiN6N9w5MnUae8ooukQR7LxGb9oXcvSKnPK/uyDVamtvSJZ90BtSc7cJxbogv03CscPEoLZhYtA4ZmLgZM69Xd0yMYjT1VWC9pwYRA7r5cxgggzBQXThBd6Xh3fqJcsOLKvM6UEP5BPzYfKRH+hgkmXPsclTVMMsDXl+CME/mGNoUTbmrKnTant8B0omw0qYH12EhnnkB6gqHiYv9LbMC/dWZ7JWlw8Tmr4SqBJ5slawnKObIV/vu7xqfT0B3Rb5nAPrNl+36sL9dIDQLwazU9Bx8+g6Lio37fN6uWVturLxFXPt1VHHsmPdHd1MZK9nLLvp1dGz03IOXFK2impNJ86bo34ZkeVNfBN9NXEyX0bUm4clzqHrWSUgjlsm4uQuCdsSx/IO63Iih/eemOOViTmOtSPm7C5YYXP5szA9fPnrOuf8Hw==</diagram></mxfile>

Двоичные данные
src/assets/glean-overview.png Normal file

Двоичный файл не отображается.

После

Ширина:  |  Высота:  |  Размер: 73 KiB

Просмотреть файл

@ -12,21 +12,26 @@ Contents:
# Overview
![drawing](../../assets/Glean_overview.jpg)
![An overview of the Glean project: On the left the product core records data using the Glean SDK. The Glean SDK then sends out this data to the Data Platform. The analysis tools (redash, Looker, GLAM, Debug View) to the right receive the data from the data platform](../../assets/glean-overview.png)
The **Glean SDK** performs measurements and sends data from our products.
It provides a set of **[metric types](https://mozilla.github.io/glean/book/user/metrics)** for individual measurements that are carefully designed to avoid common pitfalls with measurement.
It provides a set of **[metric types](https://mozilla.github.io/glean/book/reference/metrics/index.html)** for individual measurements that are carefully designed to avoid common pitfalls with measurement.
Metrics are then rolled up into **[pings](https://mozilla.github.io/glean/book/user/pings)** to send over the network.
There are a number of built-in pings that are sent on predefined schedules, but it also possible to send custom pings at any desired cadence.
The **Data Platform** validates and stores these pings in database tables.
A fault tolerant design allows data to be retained in the event of problems such as traffic spikes or invalid data.
See [An overview of Mozillas Data Pipeline](../pipeline/gcp_data_pipeline.md) for details.
Derived and cleaned data can also be automatically created at this stage.
The **Analysis Tools** are used to query and visualize the data.
This includes [Redash], [Looker], [GLAM] and the [Debug Ping View][gdv].
Because Glean knows more about the individual data, such as its type and the ranges of acceptable values, it can in many cases provide the most appropriate visualization automatically.
<!-- TODO: Link to GLAM -->
[Redash]: https://sql.telemetry.mozilla.org/
[Looker]: https://mozilla.cloud.looker.com/
[GLAM]: https://glam.telemetry.mozilla.org/
[gdv]: https://debug-ping-preview.firebaseapp.com/
# The Glean design principles
@ -36,7 +41,7 @@ A baseline of analysis is important for all our products, from counting active u
Metrics that are common to all products, such as the operating system and architecture, are provided automatically in a consistent way.
Any issues found with these base metrics only need be fixed in Glean to benefit all SDK-using products.
Any issues found with these base metrics only need to be fixed in Glean to benefit all SDK-using products.
**Encourage specificity**
@ -70,15 +75,16 @@ This includes previously manual and error-prone steps such as updating the ping
# How to use Glean
- [Integrate the Glean SDK / library](https://mozilla.github.io/glean/book/user/adding-glean-to-your-project.html) into your product.
- [Use Redash](https://sql.telemetry.mozilla.org/) to write SQL queries & build dashboards using your products datasets, e.g.:
- [Integrate the Glean SDK](https://mozilla.github.io/glean/book/user/adding-glean-to-your-project/index.html) into your product.
- [Use Looker](https://mozilla.cloud.looker.com/) to build Explores and Dashboards using your product's datasets.
- If Looker does not provide the necessary Explores you can resort to [using Redash](https://sql.telemetry.mozilla.org/) to write SQL queries & build dashboards using your products datasets, e.g.:
- `org_mozilla_fenix.baseline`
- `org_mozilla_fenix.events`
- `org_mozilla_fenix.metrics`
- There is [more documentation about accessing Glean data](../../cookbooks/accessing_glean_data.md).
- For experimentation, you can use [Android experiments library](https://github.com/mozilla-mobile/android-components/blob/master/components/service/experiments/README.md), which integrates with Glean.
- For experimentation, you can use [Nimbus SDK](https://github.com/mozilla/application-services/blob/main/components/nimbus/README.md), which integrates with Glean.
# Contact
@ -91,4 +97,3 @@ This includes previously manual and error-prone steps such as updating the ping
- The [Glean SDK](https://github.com/mozilla/glean/) implementation.
- [Reporting issues & bugs for the Glean SDK](https://bugzilla.mozilla.org/enter_bug.cgi?product=Data%20Platform%20and%20Tools&component=Glean%3A%20SDK).
- Datasets documentation (TBD)
- [Glean Debug pings viewer](https://debug-ping-preview.firebaseapp.com/)