Skip to content

Commit 838f159

Browse files
committed
Telemetry is now marked obsolete, so adjust the URLs
and ignore formerly-obsolete-now-removed docs.
1 parent b37885a commit 838f159

12 files changed

Lines changed: 33 additions & 31 deletions

.linkcheck.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@
2424
{ "pattern": "^#looker-pdts--aggregate-awareness$" },
2525
{ "pattern": "^#experiment-unpacking$" },
2626
{ "pattern": "/v2-system-addon/data_events.html" },
27-
{ "pattern": "^https://console.cloud.google.com/gcr/images/" }
27+
{ "pattern": "^https://console.cloud.google.com/gcr/images/" },
28+
{ "pattern": "^https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/obsolete/" },
29+
{ "pattern": "^https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/obsolete/" }
2830
]
2931
}

src/concepts/analysis_gotchas.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -169,9 +169,9 @@ Beta, Nightly or Developer Edition (the latter is similar to Beta).
169169
If you want to encourage users to collect good information for Mozilla, ask them to install a Beta release.
170170

171171
[environment]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/data/environment.html
172-
[histograms]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/histograms.html
173-
[scalars]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/scalars.html
174-
[events]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/events.html
172+
[histograms]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/obsolete/collection/histograms.html
173+
[scalars]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/obsolete/collection/scalars.html
174+
[events]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/obsolete/collection/events.html
175175

176176
## Trusting Dates
177177

src/concepts/history.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ Telemetry pings can contain several different types of measurements:
131131
events are preserved, which clarifies sequences of user actions
132132

133133
Data types are discussed in more depth in the [telemetry data
134-
collection](https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/index.html)
134+
collection](https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/obsolete/collection/index.html)
135135
documentation.
136136

137137
## Firefox Desktop Telemetry: The Next Generation

src/concepts/pipeline/data_pipeline.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -168,17 +168,17 @@ No, not really. If you want to read more, check out [this article](data_pipeline
168168

169169
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.
170170

171-
[collect data]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/index.html
172-
[histograms]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/histograms.html
173-
[scalars]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/scalars.html
174-
[timings]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/measuring-time.html
175-
[events]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/events.html
171+
[collect data]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/obsolete/collection/index.html
172+
[histograms]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/obsolete/collection/histograms.html
173+
[scalars]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/obsolete/collection/scalars.html
174+
[timings]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/obsolete/collection/measuring-time.html
175+
[events]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/obsolete/collection/events.html
176176
[probes]: ../../datasets/new_data.md
177177
[collection policy]: https://wiki.mozilla.org/Firefox/Data_Collection
178178
[subsessions]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/concepts/sessions.html#subsessions
179179
[main ping]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/data/main-ping.html
180180
[ping types]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/concepts/pings.html#ping-types
181-
[create their own ping types]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/custom-pings.html
181+
[create their own ping types]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/obsolete/collection/custom-pings.html
182182
[api]: https://searchfox.org/mozilla-central/rev/501eb4718d73870892d28f31a99b46f4783efaa0/toolkit/components/telemetry/app/TelemetryController.jsm#231
183183
[submit]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/concepts/submission.html#submission
184184
[load balancer]: https://aws.amazon.com/elasticloadbalancing/

src/concepts/pipeline/data_pipeline_detail.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -377,7 +377,7 @@ graph LR
377377
[firefox hardware report]: https://data.firefox.com/dashboard/hardware
378378
[datadog]: http://datadoghq.com/
379379
[cerberus]: https://github.com/mozilla/cerberus
380-
[histogram measures]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/histograms.html
380+
[histogram measures]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/obsolete/collection/histograms.html
381381
[airflow]: https://github.com/mozilla/telemetry-airflow
382382
[redash]: https://redash.io
383383
[stmo]: ../../tools/stmo.md

src/concepts/pipeline/event_pipeline.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ Where the individual fields are:
8686
- `value`: `String`, optional, may be null. This is a user defined value, providing context for the event.
8787
- `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.
8888

89-
See also the [Firefox Telemetry documentation](https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/events.html#serialization-format).
89+
See also the [Firefox Telemetry documentation](https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/obsolete/collection/events.html#serialization-format).
9090

9191
# Event data collection
9292

@@ -95,9 +95,9 @@ See also the [Firefox Telemetry documentation](https://firefox-source-docs.mozil
9595
To collect this event data in Firefox there are different APIs in Firefox, all addressing different
9696
use cases:
9797

98-
- The [_Telemetry event API_](https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/events.html)
98+
- The [_Telemetry event API_](https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/obsolete/collection/events.html)
9999
allows easy recording of events from Firefox code.
100-
- The [_dynamic event API_](https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/events.html#registerevents)
100+
- The [_dynamic event API_](https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/obsolete/collection/events.html#registerevents)
101101
allows code from Mozilla addons to record new events into Telemetry without shipping Firefox
102102
code.
103103
- 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
108108
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.
109109
From Firefox 61, all events recorded through these APIs are [automatically counted in scalars](https://bugzilla.mozilla.org/show_bug.cgi?id=1440673).
110110

111-
Finally, [_custom pings_](https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/custom-pings.html)
111+
Finally, [_custom pings_](https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/obsolete/collection/custom-pings.html)
112112
can follow the event data format and potentially connect to the existing tooling with some integration work.
113113

114114
## Mobile event collection

src/concepts/pipeline/gcp_data_pipeline.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -202,18 +202,18 @@ effort (and improving over time) ETL jobs that scrub incoming data of
202202
potentially identifying information, which reduces risk. When possible, we
203203
build and work with aggregate datasets rather than individual-level data.
204204

205-
[collect data]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/index.html
206-
[histograms]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/histograms.html
207-
[scalars]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/scalars.html
208-
[timings]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/measuring-time.html
209-
[events]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/events.html
205+
[collect data]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/obsolete/collection/index.html
206+
[histograms]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/obsolete/collection/histograms.html
207+
[scalars]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/obsolete/collection/scalars.html
208+
[timings]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/obsolete/collection/measuring-time.html
209+
[events]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/obsolete/collection/events.html
210210
[probes]: ../../datasets/new_data.md
211211
[collection policy]: https://wiki.mozilla.org/Firefox/Data_Collection
212212
[collection categories]: https://wiki.mozilla.org/Data_Collection#Data_Collection_Categories
213213
[subsessions]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/concepts/sessions.html#subsessions
214214
[main ping]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/data/main-ping.html
215215
[ping types]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/concepts/pings.html#ping-types
216-
[create their own ping types]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/custom-pings.html
216+
[create their own ping types]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/obsolete/collection/custom-pings.html
217217
[api]: https://searchfox.org/mozilla-central/rev/501eb4718d73870892d28f31a99b46f4783efaa0/toolkit/components/telemetry/app/TelemetryController.jsm#231
218218
[submit]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/concepts/submission.html#submission
219219
[airflow]: https://github.com/mozilla/telemetry-airflow/

src/cookbooks/events_best_practices.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ In the meantime, please consult [the Glean event documentation](https://mozilla.
55

66
## Overview:
77

8-
[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.
8+
[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.
99

10-
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:
10+
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:
1111

1212
- timestamp
1313
- category

src/cookbooks/main_ping_exponential_histograms.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This tutorial tries to build up an understanding and intuition of how things wor
66

77
Assumptions:
88

9-
- 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)
9+
- 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)
1010
- You have read [the introduction to STMO](../tools/stmo.md).
1111
- You understand the [main ping tables](../datasets/main_ping_tables.md) (`telemetry.main_1pct` and `telemetry.main_nightly`).
1212

@@ -19,7 +19,7 @@ Assumptions:
1919
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
2020
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).
2121

22-
`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:
22+
`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:
2323

2424
![example visualization of an exponential histogram](../assets/exponential_histograms_tutorial/example_visualization_of_an_exponential_histogram.png)
2525
[link](https://telemetry.mozilla.org/histogram-simulator/index.html#low=1&high=1000&n_buckets=20&kind=exponential&generate=normal)

src/cookbooks/new_ping.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ specific, concrete asks that can be translated to data points. This will also ma
1616
the line as you start data review.
1717

1818
More detail on how to design and implement new pings for Firefox Desktop [can be found
19-
here](https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/custom-pings.html).
19+
here](https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/obsolete/collection/custom-pings.html).
2020

2121
## Choose a Namespace and DocType
2222

@@ -163,7 +163,7 @@ schemas can be viewed at
163163
## Start Sending Data
164164

165165
Use the built-in Telemetry APIs when possible. A few examples are the [Gecko Telemetry
166-
APIs](https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/custom-pings.html),
166+
APIs](https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/obsolete/collection/custom-pings.html),
167167
or the [iOS Telemetry APIs](https://github.com/mozilla-mobile/telemetry-ios).
168168

169169
**Users on Android should use [Glean](../concepts/glean/glean.md)**, which does not require building out custom pings.

0 commit comments

Comments
 (0)