dom/webidl/Glean.webidl

   1 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this file,
   4  * You can obtain one at http://mozilla.org/MPL/2.0/.
   5  */
   6
   7 [Func="nsGlobalWindowInner::IsGleanNeeded", Exposed=Window]
   8 interface GleanCategory {
   9   /**
  10    * Get a metric by name.
  11    *
  12    * Returns an object of the corresponding metric type,
  13    * with only the allowed functions available.
  14    */
  15   getter GleanMetric (DOMString identifier);
  16 };
  17
  18 [Func="nsGlobalWindowInner::IsGleanNeeded", Exposed=Window]
  19 interface GleanImpl {
  20   /**
  21    * Get a metric category by name.
  22    *
  23    * Returns an object for further metric lookup.
  24    */
  25   getter GleanCategory (DOMString identifier);
  26 };
  27
  28 [Func="nsGlobalWindowInner::IsGleanNeeded", Exposed=Window]
  29 interface GleanLabeled {
  30   /**
  31    * Get a specific metric for a given label.
  32    *
  33    * If a set of acceptable labels were specified in the `metrics.yaml` file,
  34    * and the given label is not in the set, it will be recorded under the
  35    * special `OTHER_LABEL` label.
  36    *
  37    * If a set of acceptable labels was not specified in the `metrics.yaml` file,
  38    * only the first 16 unique labels will be used.
  39    * After that, any additional labels will be recorded under the special
  40    * `OTHER_LABEL` label.
  41    */
  42   getter GleanMetric (DOMString identifier);
  43 };