diff --git a/.linkcheck.json b/.linkcheck.json index 00c21b33a..5a79c9831 100644 --- a/.linkcheck.json +++ b/.linkcheck.json @@ -24,6 +24,9 @@ { "pattern": "^#looker-pdts--aggregate-awareness$" }, { "pattern": "^#experiment-unpacking$" }, { "pattern": "/v2-system-addon/data_events.html" }, - { "pattern": "^https://console.cloud.google.com/gcr/images/" } + { "pattern": "^https://console.cloud.google.com/gcr/images/" }, + { "pattern": "^https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/obsolete/" }, + { "pattern": "^https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/obsolete/" }, + { "pattern": "^https://cwiki.apache.org" } ] } diff --git a/src/concepts/analysis_gotchas.md b/src/concepts/analysis_gotchas.md index e344b6bc9..b12a9e4d8 100644 --- a/src/concepts/analysis_gotchas.md +++ b/src/concepts/analysis_gotchas.md @@ -169,9 +169,9 @@ Beta, Nightly or Developer Edition (the latter is similar to Beta). If you want to encourage users to collect good information for Mozilla, ask them to install a Beta release. [environment]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/data/environment.html -[histograms]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/histograms.html -[scalars]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/scalars.html -[events]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/events.html +[histograms]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/obsolete/collection/histograms.html +[scalars]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/obsolete/collection/scalars.html +[events]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/obsolete/collection/events.html ## Trusting Dates diff --git a/src/concepts/history.md b/src/concepts/history.md index da9bd1a89..751e713be 100644 --- a/src/concepts/history.md +++ b/src/concepts/history.md @@ -131,7 +131,7 @@ Telemetry pings can contain several different types of measurements: events are preserved, which clarifies sequences of user actions Data types are discussed in more depth in the [telemetry data -collection](https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/index.html) +collection](https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/obsolete/collection/index.html) documentation. ## Firefox Desktop Telemetry: The Next Generation diff --git a/src/concepts/pipeline/data_pipeline.md b/src/concepts/pipeline/data_pipeline.md index ad17cb6ad..405a1d179 100644 --- a/src/concepts/pipeline/data_pipeline.md +++ b/src/concepts/pipeline/data_pipeline.md @@ -168,17 +168,17 @@ No, not really. If you want to read more, check out [this article](data_pipeline There is a vast ecosystem of tools for processing data at scale, each with their pros & cons. The pipeline grew organically and we added new tools as new use-cases came up that we couldn’t solve with our existing stack. There are still scars left from that growth though which require some effort to get rid of, like ingesting data from schema-less format. -[collect data]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/index.html -[histograms]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/histograms.html -[scalars]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/scalars.html -[timings]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/measuring-time.html -[events]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/events.html +[collect data]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/obsolete/collection/index.html +[histograms]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/obsolete/collection/histograms.html +[scalars]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/obsolete/collection/scalars.html +[timings]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/obsolete/collection/measuring-time.html +[events]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/obsolete/collection/events.html [probes]: ../../datasets/new_data.md [collection policy]: https://wiki.mozilla.org/Firefox/Data_Collection [subsessions]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/concepts/sessions.html#subsessions [main ping]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/data/main-ping.html [ping types]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/concepts/pings.html#ping-types -[create their own ping types]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/custom-pings.html +[create their own ping types]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/obsolete/collection/custom-pings.html [api]: https://searchfox.org/mozilla-central/rev/501eb4718d73870892d28f31a99b46f4783efaa0/toolkit/components/telemetry/app/TelemetryController.jsm#231 [submit]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/concepts/submission.html#submission [load balancer]: https://aws.amazon.com/elasticloadbalancing/ diff --git a/src/concepts/pipeline/data_pipeline_detail.md b/src/concepts/pipeline/data_pipeline_detail.md index 7f8a27364..4b9526f0b 100644 --- a/src/concepts/pipeline/data_pipeline_detail.md +++ b/src/concepts/pipeline/data_pipeline_detail.md @@ -377,7 +377,7 @@ graph LR [firefox hardware report]: https://data.firefox.com/dashboard/hardware [datadog]: http://datadoghq.com/ [cerberus]: https://github.com/mozilla/cerberus -[histogram measures]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/histograms.html +[histogram measures]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/obsolete/collection/histograms.html [airflow]: https://github.com/mozilla/telemetry-airflow [redash]: https://redash.io [stmo]: ../../tools/stmo.md diff --git a/src/concepts/pipeline/event_pipeline.md b/src/concepts/pipeline/event_pipeline.md index 231dc6ad8..e0f20efd7 100644 --- a/src/concepts/pipeline/event_pipeline.md +++ b/src/concepts/pipeline/event_pipeline.md @@ -86,7 +86,7 @@ Where the individual fields are: - `value`: `String`, optional, may be null. This is a user defined value, providing context for the event. - `extra`: `Object`, optional, may be null. This is an object of the form `{"key": "value", ...}`, both keys and values need to be strings. This is used for events when additional richer context is needed. -See also the [Firefox Telemetry documentation](https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/events.html#serialization-format). +See also the [Firefox Telemetry documentation](https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/obsolete/collection/events.html#serialization-format). # Event data collection @@ -95,9 +95,9 @@ See also the [Firefox Telemetry documentation](https://firefox-source-docs.mozil To collect this event data in Firefox there are different APIs in Firefox, all addressing different use cases: -- The [_Telemetry event API_](https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/events.html) +- The [_Telemetry event API_](https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/obsolete/collection/events.html) allows easy recording of events from Firefox code. -- The [_dynamic event API_](https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/events.html#registerevents) +- The [_dynamic event API_](https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/obsolete/collection/events.html#registerevents) allows code from Mozilla addons to record new events into Telemetry without shipping Firefox code. - The _[Telemetry WebExtension API](https://searchfox.org/mozilla-central/rev/55da592d85c2baf8d8818010c41d9738c97013d2/toolkit/components/extensions/schemas/telemetry.json#87)_ ([introduced here](https://bugzilla.mozilla.org/show_bug.cgi?id=1280234)) @@ -108,7 +108,7 @@ For all these APIs, events will get sent to the pipeline through the Before Firefox 62, events were sent through the [main ping](https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/data/main-ping.html) instead, with a hard limit of 500 events per ping. From Firefox 61, all events recorded through these APIs are [automatically counted in scalars](https://bugzilla.mozilla.org/show_bug.cgi?id=1440673). -Finally, [_custom pings_](https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/custom-pings.html) +Finally, [_custom pings_](https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/obsolete/collection/custom-pings.html) can follow the event data format and potentially connect to the existing tooling with some integration work. ## Mobile event collection diff --git a/src/concepts/pipeline/gcp_data_pipeline.md b/src/concepts/pipeline/gcp_data_pipeline.md index 2a850cc35..f3a0e88c1 100644 --- a/src/concepts/pipeline/gcp_data_pipeline.md +++ b/src/concepts/pipeline/gcp_data_pipeline.md @@ -202,18 +202,18 @@ effort (and improving over time) ETL jobs that scrub incoming data of potentially identifying information, which reduces risk. When possible, we build and work with aggregate datasets rather than individual-level data. -[collect data]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/index.html -[histograms]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/histograms.html -[scalars]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/scalars.html -[timings]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/measuring-time.html -[events]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/events.html +[collect data]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/obsolete/collection/index.html +[histograms]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/obsolete/collection/histograms.html +[scalars]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/obsolete/collection/scalars.html +[timings]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/obsolete/collection/measuring-time.html +[events]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/obsolete/collection/events.html [probes]: ../../datasets/new_data.md [collection policy]: https://wiki.mozilla.org/Firefox/Data_Collection [collection categories]: https://wiki.mozilla.org/Data_Collection#Data_Collection_Categories [subsessions]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/concepts/sessions.html#subsessions [main ping]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/data/main-ping.html [ping types]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/concepts/pings.html#ping-types -[create their own ping types]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/custom-pings.html +[create their own ping types]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/obsolete/collection/custom-pings.html [api]: https://searchfox.org/mozilla-central/rev/501eb4718d73870892d28f31a99b46f4783efaa0/toolkit/components/telemetry/app/TelemetryController.jsm#231 [submit]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/concepts/submission.html#submission [airflow]: https://github.com/mozilla/telemetry-airflow/ diff --git a/src/cookbooks/events_best_practices.md b/src/cookbooks/events_best_practices.md index 6131c2b5c..74c4b96cf 100644 --- a/src/cookbooks/events_best_practices.md +++ b/src/cookbooks/events_best_practices.md @@ -5,9 +5,9 @@ In the meantime, please consult [the Glean event documentation](https://mozilla. ## Overview: -[The Telemetry Events API](https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/events.html) allows users to define and record events in the browser. +[The Telemetry Events API](https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/obsolete/collection/events.html) allows users to define and record events in the browser. -Events are defined in [`Events.yaml`](https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/events.html#the-yaml-definition-file) and each events creates records with the following properties: +Events are defined in [`Events.yaml`](https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/obsolete/collection/events.html#the-yaml-definition-file) and each events creates records with the following properties: - timestamp - category diff --git a/src/cookbooks/main_ping_exponential_histograms.md b/src/cookbooks/main_ping_exponential_histograms.md index 46517432e..2688455f8 100644 --- a/src/cookbooks/main_ping_exponential_histograms.md +++ b/src/cookbooks/main_ping_exponential_histograms.md @@ -6,7 +6,7 @@ This tutorial tries to build up an understanding and intuition of how things wor Assumptions: -- You have some idea of what a histogram is (if not, the [Wikipedia article](https://en.wikipedia.org/wiki/Histogram) is a great place to start), have at least skimmed over [the Firefox documentation on histograms](https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/collection/histograms.html) +- You have some idea of what a histogram is (if not, the [Wikipedia article](https://en.wikipedia.org/wiki/Histogram) is a great place to start), have at least skimmed over [the Firefox documentation on histograms](https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/obsolete/collection/histograms.html) - You have read [the introduction to STMO](../tools/stmo.md). - You understand the [main ping tables](../datasets/main_ping_tables.md) (`telemetry.main_1pct` and `telemetry.main_nightly`). @@ -19,7 +19,7 @@ Assumptions: For the purposes of this tutorial, let's look at a typical performance-oriented histogram: [`FX_TAB_SWITCH_SPINNER_VISIBLE_MS`](https://probes.telemetry.mozilla.org/?view=detail&probeId=histogram%2FFX_TAB_SWITCH_SPINNER_VISIBLE_MS) which we use to count the number of times a tab spinner appears after a switch tab operation in Firefox, along with the duration of its appearance in milliseconds (ms). This is an unwanted operation (especially if it's long), as it makes the browser appear unresponsive and [confuses / disturbs users](https://support.mozilla.org/en-US/questions/1198062). -`FX_TAB_SWITCH_SPINNER_VISIBLE_MS` is what's called an [exponential histogram](https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/collection/histograms.html#exponential): it represents an exponentially increasing distribution of values in each of its "buckets". It's probably easier to visualize this using the histogram viewer than describe: +`FX_TAB_SWITCH_SPINNER_VISIBLE_MS` is what's called an [exponential histogram](https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/obsolete/collection/histograms.html#exponential): it represents an exponentially increasing distribution of values in each of its "buckets". It's probably easier to visualize this using the histogram viewer than describe: ![example visualization of an exponential histogram](../assets/exponential_histograms_tutorial/example_visualization_of_an_exponential_histogram.png) [link](https://telemetry.mozilla.org/histogram-simulator/index.html#low=1&high=1000&n_buckets=20&kind=exponential&generate=normal) diff --git a/src/cookbooks/new_ping.md b/src/cookbooks/new_ping.md index babe1e380..fbd77942a 100644 --- a/src/cookbooks/new_ping.md +++ b/src/cookbooks/new_ping.md @@ -16,7 +16,7 @@ specific, concrete asks that can be translated to data points. This will also ma the line as you start data review. More detail on how to design and implement new pings for Firefox Desktop [can be found -here](https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/custom-pings.html). +here](https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/obsolete/collection/custom-pings.html). ## Choose a Namespace and DocType @@ -163,7 +163,7 @@ schemas can be viewed at ## Start Sending Data Use the built-in Telemetry APIs when possible. A few examples are the [Gecko Telemetry -APIs](https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/custom-pings.html), +APIs](https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/obsolete/collection/custom-pings.html), or the [iOS Telemetry APIs](https://github.com/mozilla-mobile/telemetry-ios). **Users on Android should use [Glean](../concepts/glean/glean.md)**, which does not require building out custom pings. diff --git a/src/datasets/batch_view/events/reference.md b/src/datasets/batch_view/events/reference.md index d9a885304..d795e873b 100644 --- a/src/datasets/batch_view/events/reference.md +++ b/src/datasets/batch_view/events/reference.md @@ -64,6 +64,6 @@ This dataset is generated by [BigQuery ETL](https://github.com/mozilla/bigquery- ## More Information Firefox has an API to record events, which are then submitted through the `event` ping. -The format and mechanism of event collection in Firefox is documented [in the Firefox source documentation](https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/events.html). +The format and mechanism of event collection in Firefox is documented [in the Firefox source documentation](https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/obsolete/collection/events.html). The full events data pipeline is [documented in the event pipeline documentation](../../../concepts/pipeline/event_pipeline.md). diff --git a/src/datasets/dynamic_telemetry.md b/src/datasets/dynamic_telemetry.md index 927afab29..c792a1a33 100644 --- a/src/datasets/dynamic_telemetry.md +++ b/src/datasets/dynamic_telemetry.md @@ -22,6 +22,6 @@ for these probes. | 2019-10 | [Delegated credentials](https://bugzilla.mozilla.org/show_bug.cgi?id=1594926) | event | `delegatedcredentials#connectDC`, `#connectNoDC` | https://github.com/kjacobs-moz/dc-experiment-addon | | 2019-10 | [DNS over HTTPS heuristics](https://bugzilla.mozilla.org/show_bug.cgi?id=1573840) | event | `doh#evaluate.heuristics`, `doh#state` | https://github.com/mozilla/doh-rollout/blob/6787458a6901ef3b2a8fef86a179899213809534/docs/telemetry.md | -[scalar]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/collection/scalars.html -[event]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/collection/events.html +[scalar]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/obsolete/collection/scalars.html +[event]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/obsolete/collection/events.html [probe dictionary]: https://probes.telemetry.mozilla.org/