Magic-Mirror/gecko-dev
1
0
Fork 0
mirror of https://github.com/mozilla/gecko-dev.git synced 2024-10-16 14:55:47 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Bug 1366943 - histograms.rst fix: 'enumerated' relies on 'n_values' instead of 'n_buckets' - r=gfritzsche

Browse Source 
Also clarified that values start at `0`, and that `n_values` counts
everything >= n_values.

MozReview-Commit-ID: EQrqAySZmV3

--HG--
extra : rebase_source : b3fa7ffca2b3ed928b1bcd17b4396a8b307bc38e
This commit is contained in:
Gerald Squelart 2017-05-23 15:41:34 +12:00
parent f541431711
commit 88991ce560
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
toolkit/components/telemetry/docs/collection/histograms.rst
View File

@ -63,13 +63,13 @@ Categorical histograms are similar to enumerated histograms. However, instead of
``enumerated``
--------------
This histogram type is intended for storing "enum" values, when you can't specify labels and thus cannot use ``categorical`` histograms. An enumerated histogram consists of a fixed number of *buckets*, each of which is associated with a consecutive integer value (the bucket's *label*). Each bucket corresponds to an enum value and counts the number of times its particular enum value was recorded.
This histogram type is intended for storing "enum" values, when you can't specify labels and thus cannot use ``categorical`` histograms. An enumerated histogram consists of a fixed number of *buckets* (specified by ``n_values``), each of which is associated with a consecutive integer value (the bucket's *label*), `0` to `n_values`. Each bucket corresponds to an enum value and counts the number of times its particular enum value was recorded; except for the `n_values` bucket, which counts all values greater than or equal to n_values.
You might use this type of histogram if, for example, you wanted to track the relative popularity of SSL handshake types. Whenever the browser started an SSL handshake, it would record one of a limited number of enum values which uniquely identifies the handshake type.
.. note::
Set ``n_buckets`` to a slightly larger value than needed to allow for new enum values in the future. See `Changing a histogram`_ if you need to add more enums later.
Set ``n_values`` to a slightly larger value than needed to allow for new enum values in the future. See `Changing a histogram`_ if you need to add more enums later.
``flag``
--------