Bug 1510988 - Clearly document what the store name in snapshot APIs is for r=chutten
authorJan-Erik Rediger <jrediger@mozilla.com>
Fri, 18 Jan 2019 19:03:26 +0000
changeset 454701 12d1bf5d9b3057c483c149826c0ca090fbe2b79c
parent 454700 95779bb379580b2ebf57acef5e400258e4dfa88d
child 454702 85ba084b3f903f4b479bf07f2c62f5184f61e44c
push id35411
push usercsabou@mozilla.com
push dateTue, 22 Jan 2019 03:53:40 +0000
treeherdermozilla-central@ada22b635f8d [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewerschutten
bugs1510988
milestone66.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 1510988 - Clearly document what the store name in snapshot APIs is for r=chutten Depends on D16966 Differential Revision: https://phabricator.services.mozilla.com/D16967
toolkit/components/telemetry/core/nsITelemetry.idl
--- a/toolkit/components/telemetry/core/nsITelemetry.idl
+++ b/toolkit/components/telemetry/core/nsITelemetry.idl
@@ -59,62 +59,74 @@ interface nsITelemetry : nsISupports
    * Each histogram is represented in a packed format and has the following properties:
    *   bucket_count - Number of buckets of this histogram
    *   histogram_type - HISTOGRAM_EXPONENTIAL, HISTOGRAM_LINEAR, HISTOGRAM_BOOLEAN,
    *                    HISTOGRAM_FLAG, HISTOGRAM_COUNT, or HISTOGRAM_CATEGORICAL
    *   sum - sum of the bucket contents
    *   range - A 2-item array of minimum and maximum bucket size
    *   values - Map from bucket to the bucket's count
    *
-   * @param aStoreName The name of the store to snapshot. Something like "main".
+   * @param aStoreName The name of the store to snapshot. "main" will be generally available.
+   *                   Custom stores are available when probes have them defined.
+   *                   See the `record_into_store` attribute on histograms.
+   *                   @see https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/histograms.html#record-into-store
    * @param aClearStore Whether to clear out the histograms in the named store after snapshotting.
    *                    Defaults to false.
    * @param aFilterTest If true, `TELEMETRY_TEST_` histograms will be filtered out.
                         Filtered histograms are still cleared if `aClearStore` is true.
    *                    Defaults to false.
    */
   [implicit_jscontext]
   jsval getSnapshotForHistograms(in ACString aStoreName, [optional] in boolean aClearStore, [optional] in boolean aFilterTest);
 
   /**
    * Serializes the keyed histograms from the given store to a JSON-style object.
    * The returned structure looks like:
    *   { "process": { "name1": { "key_1": histogramData1, "key_2": histogramData2 }, ...}, ... }
    *
-   * @param aStoreName The name of the store to snapshot. Something like "main".
+   * @param aStoreName The name of the store to snapshot. "main" will be generally available.
+   *                   Custom stores are available when probes have them defined.
+   *                   See the `record_into_store` attribute on histograms.
+   *                   @see https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/histograms.html#record-into-store
    * @param aClearStore Whether to clear out the keyed histograms in the named store after snapshotting.
    *                    Defaults to false.
    * @param aFilterTest If true, `TELEMETRY_TEST_` histograms will be filtered out.
                         Filtered histograms are still cleared if `aClearStore` is true.
    *                    Defaults to false.
    */
   [implicit_jscontext]
   jsval getSnapshotForKeyedHistograms(in ACString aStoreName, [optional] in boolean aClearStore, [optional] in boolean aFilterTest);
 
   /**
    * Serializes the scalars from the given store to a JSON-style object.
    * The returned structure looks like:
    *   { "process": { "category1.probe": 1,"category1.other_probe": false, ... }, ... }.
    *
-   * @param aStoreName The name of the store to snapshot. Something like "main".
+   * @param aStoreName The name of the store to snapshot. "main" will be generally available.
+   *                   Custom stores are available when probes have them defined.
+   *                   See the `record_into_store` attribute on scalars.
+   *                   @see https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/scalars.html#optional-fields
    * @param aClearStore Whether to clear out the scalars in the named store after snapshotting.
    *                    Defaults to false.
    * @param aFilterTest If true, `telemetry.test` scalars will be filtered out.
                         Filtered scalars are still cleared if `aClearStore` is true.
    *                    Defaults to false.
    */
   [implicit_jscontext]
   jsval getSnapshotForScalars(in ACString aStoreName, [optional] in boolean aClearStore, [optional] in boolean aFilterTest);
 
   /**
    * Serializes the keyed scalars from the given store to a JSON-style object.
    * The returned structure looks like:
    *   { "process": { "category1.probe": { "key_1": 2, "key_2": 1, ... }, ... }, ... }
    *
-   * @param aStoreName The name of the store to snapshot. Something like "main".
+   * @param aStoreName The name of the store to snapshot. "main" will be generally available.
+   *                   Custom stores are available when probes have them defined.
+   *                   See the `record_into_store` attribute on scalars.
+   *                   @see https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/scalars.html#optional-fields
    * @param aClearStore Whether to clear out the keyed scalars in the named store after snapshotting.
    *                    Defaults to false.
    * @param aFilterTest If true, `telemetry.test` scalars will be filtered out.
                         Filtered scalars are still cleared if `aClearStore` is true.
    *                    Defaults to false.
    */
   [implicit_jscontext]
   jsval getSnapshotForKeyedScalars(in ACString aStoreName, [optional] in boolean aClearStore, [optional] in boolean aFilterTest);