summaryrefslogtreecommitdiffstats
path: root/dom/chrome-webidl/Glean.webidl
diff options
context:
space:
mode:
Diffstat (limited to 'dom/chrome-webidl/Glean.webidl')
-rw-r--r--dom/chrome-webidl/Glean.webidl45
1 files changed, 45 insertions, 0 deletions
diff --git a/dom/chrome-webidl/Glean.webidl b/dom/chrome-webidl/Glean.webidl
new file mode 100644
index 0000000000..f8f55e2418
--- /dev/null
+++ b/dom/chrome-webidl/Glean.webidl
@@ -0,0 +1,45 @@
+/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this file,
+ * You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+
+interface nsISupports;
+
+[ChromeOnly, Exposed=Window]
+interface GleanCategory {
+ /**
+ * Get a metric by name.
+ *
+ * Returns an object of the corresponding metric type,
+ * with only the allowed functions available.
+ */
+ getter nsISupports (DOMString identifier);
+};
+
+[ChromeOnly, Exposed=Window]
+interface GleanImpl {
+ /**
+ * Get a metric category by name.
+ *
+ * Returns an object for further metric lookup.
+ */
+ getter GleanCategory (DOMString identifier);
+};
+
+[ChromeOnly, Exposed=Window]
+interface GleanLabeled {
+ /**
+ * Get a specific metric for a given label.
+ *
+ * If a set of acceptable labels were specified in the `metrics.yaml` file,
+ * and the given label is not in the set, it will be recorded under the
+ * special `OTHER_LABEL` label.
+ *
+ * If a set of acceptable labels was not specified in the `metrics.yaml` file,
+ * only the first 16 unique labels will be used.
+ * After that, any additional labels will be recorded under the special
+ * `OTHER_LABEL` label.
+ */
+ getter nsISupports (DOMString identifier);
+};