Bug 1498168 - Mention new snapshot APIs in documentation r=chutten
authorJan-Erik Rediger <jrediger@mozilla.com>
Tue, 27 Nov 2018 07:40:17 +0000
changeset 504641 93fccab4f951f154e61e87081ceae912d16db025
parent 504640 ad857edac6a5944891e6ee1637f85f45c7f4f027
child 504642 f2ce8f83a2242f896a25043077539882993335ec
push id10290
push userffxbld-merge
push dateMon, 03 Dec 2018 16:23:23 +0000
treeherdermozilla-beta@700bed2445e6 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewerschutten
bugs1498168
milestone65.0a1
first release with
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
last release without
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
Bug 1498168 - Mention new snapshot APIs in documentation r=chutten Differential Revision: https://phabricator.services.mozilla.com/D12891
toolkit/components/telemetry/docs/start/adding-a-new-probe.rst
--- a/toolkit/components/telemetry/docs/start/adding-a-new-probe.rst
+++ b/toolkit/components/telemetry/docs/start/adding-a-new-probe.rst
@@ -115,19 +115,22 @@ The *about:telemetry* page allows to vie
 
 If you need to confirm when - or if - pings are getting sent, you can run an instance of the `gzipServer <https://github.com/mozilla/gzipServer>`_ locally. It emulates roughly how the official Telemetry servers respond, and saves all received pings to disk for inspection.
 
 Test coverage
 -------------
 
 Any data collection that you need to base decisions on needs to have test coverage. Using JS, you can access the recorded values for your data collection. You can use the following functions:
 
-- for scalars, `snapshotScalars() <https://dxr.mozilla.org/mozilla-central/rev/720b9177c6856c1c4339d0fac1bf5149c0d53950/toolkit/components/telemetry/nsITelemetry.idl#444>`_ or `snapshotKeyedScalars() <https://dxr.mozilla.org/mozilla-central/rev/720b9177c6856c1c4339d0fac1bf5149c0d53950/toolkit/components/telemetry/nsITelemetry.idl#487>`_
-- `histogram.snapshot()` for `histograms <https://dxr.mozilla.org/mozilla-central/rev/720b9177c6856c1c4339d0fac1bf5149c0d53950/services/fxaccounts/tests/xpcshell/test_accounts.js#236-237>`_ or `keyed histograms <https://dxr.mozilla.org/mozilla-central/rev/720b9177c6856c1c4339d0fac1bf5149c0d53950/browser/components/search/test/browser_healthreport.js#39-42>`_
-- for events, `snapshotBuiltinEvents() <https://dxr.mozilla.org/mozilla-central/rev/720b9177c6856c1c4339d0fac1bf5149c0d53950/browser/modules/test/browser/browser_UsageTelemetry_content.js#83-85>`_
+- for scalars, `getSnapshotForScalars() <https://searchfox.org/mozilla-central/rev/f997bd6bbfc4773e774fdb6cd010142370d186f9/toolkit/components/telemetry/core/nsITelemetry.idl#90-102>`_
+  or `getSnapshotForKeyedScalars() <https://searchfox.org/mozilla-central/rev/f997bd6bbfc4773e774fdb6cd010142370d186f9/toolkit/components/telemetry/core/nsITelemetry.idl#104-116>`_
+- for histograms, `getSnapshotForHistograms() <https://searchfox.org/mozilla-central/rev/f997bd6bbfc4773e774fdb6cd010142370d186f9/toolkit/components/telemetry/core/nsITelemetry.idl#54-74>`_
+  or `getSnapshotForKeyedHistograms() <https://searchfox.org/mozilla-central/rev/f997bd6bbfc4773e774fdb6cd010142370d186f9/toolkit/components/telemetry/core/nsITelemetry.idl#76-88>`_
+   * Optionally, histogram objects have a `snapshot() <https://searchfox.org/mozilla-central/rev/f997bd6bbfc4773e774fdb6cd010142370d186f9/toolkit/components/telemetry/core/nsITelemetry.idl#285-287,313-315>`_ method.
+- for events, `snapshotEvents() <https://searchfox.org/mozilla-central/rev/f997bd6bbfc4773e774fdb6cd010142370d186f9/toolkit/components/telemetry/core/nsITelemetry.idl#542-558>`_
 
 If you need to test that pings were correctly passed to Telemetry, you can use `TelemetryArchiveTesting <https://dxr.mozilla.org/mozilla-central/search?q=TelemetryArchiveTesting&redirect=false>`_.
 
 Validation
 ----------
 
 While it's important to confirm that the data collection works on your machine, the Firefox user population is very diverse. Before basing decisions on any new data, it should be validated. This could take various forms.