@@ -8,7 +8,7 @@ A client-side telemetry SDK for collecting metrics and sending them to Mozilla's
-[Setting up the dependency](#setting-up-the-dependency)
-[Integrating with the build system](#integrating-with-the-build-system)
-[Initializing glean](#initializing-glean)
-[Defining metrics](#defining-metrics)
-[Adding new metrics](#adding-new-metrics)
-[Providing UI to enable / disable metrics](#providing-ui-to-enable--disable-metrics)
-[Debugging products using glean](#debugging-products-using-glean)
-[License](#license)
@@ -16,7 +16,7 @@ A client-side telemetry SDK for collecting metrics and sending them to Mozilla's
## Before using the library
Products using glean to collect telemetry **must**:
- add documentation for any new metric collected with the library in its repository (see [an example](https://github.com/mozilla-mobile/android-components/blob/df429df1a193516f796f2330863af384cce820bc/components/service/glean/docs/pings.md));
- add documentation for any new metric collected with the library in its repository (see [an example](https://github.com/mozilla-mobile/android-components/blob/df429df1a193516f796f2330863af384cce820bc/components/service/glean/docs/pings/pings.md));
- go through data review for the newly collected data by following [this process](https://wiki.mozilla.org/Firefox/Data_Collection);
- provide a way for users to turn data collection off (e.g. providing settings to control
`Glean.setUploadEnabled()`).
@@ -80,7 +80,7 @@ class SampleApplication : Application() {
```
Once initialized, if collection is enabled, glean will automatically start collecting [baseline metrics](metrics.yaml)
and sending its [pings](docs/pings.md).
and sending its [pings](docs/pings/pings.md).
Glean should be initialized as soon as possible, and importantly, before any
other libraries in the application start using Glean. Library code should never
