Bug 1533866: add a note about what a scalar is r=chutten
authorEthan Glasser-Camp <ethan@betacantrips.com>
Mon, 11 Mar 2019 16:16:58 +0000
changeset 524400 e04346181aceac703ce2a4272dcc1ccbf3e6141c
parent 524399 e510d3ed595a6e133bfcdbb4db71b3eb74918839
child 524401 364ed778d761aa064a5da484ced1ed2b9e83c699
push id2032
push userffxbld-merge
push dateMon, 13 May 2019 09:36:57 +0000
treeherdermozilla-release@455c1065dcbe [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewerschutten
bugs1533866
milestone67.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 1533866: add a note about what a scalar is r=chutten Differential Revision: https://phabricator.services.mozilla.com/D22765
toolkit/components/telemetry/docs/collection/scalars.rst
--- a/toolkit/components/telemetry/docs/collection/scalars.rst
+++ b/toolkit/components/telemetry/docs/collection/scalars.rst
@@ -1,12 +1,17 @@
 =======
 Scalars
 =======
 
+A *scalar* metric can be used to track a single value. Unlike
+histograms, which collect every measurement taken, a scalar only
+tracks a single value, with later values completely replacing earlier
+ones.
+
 Historically we started to overload our histogram mechanism to also collect scalar data,
 such as flag values, counts, labels and others.
 The scalar measurement types are the suggested way to collect that kind of scalar data.
 The serialized scalar data is submitted with the :doc:`main pings <../data/main-ping>`. Adding scalars is supported in artifact builds and build faster workflows.
 
 .. important::
 
     Every new data collection in Firefox needs a `data collection review <https://wiki.mozilla.org/Firefox/Data_Collection#Requesting_Approval>`_ from a data collection peer. Just set the feedback? flag for one of the data peers. We try to reply within a business day.