Add m-esr52 at 52.6.0

1 files changed, 469 insertions, 0 deletions

diff --git a/toolkit/components/telemetry/nsITelemetry.idl b/toolkit/components/telemetry/nsITelemetry.idl
new file mode 100644
index 000000000..3b74b2d1b
--- /dev/null
+++ b/toolkit/components/telemetry/nsITelemetry.idl
@@ -0,0 +1,469 @@
+/* -*- Mode: C++; c-basic-offset: 2; indent-tabs-mode: nil; tab-width: 8 -*- */
+/* 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/. */
+
+#include "nsISupports.idl"
+#include "nsIFile.idl"
+
+[scriptable,function, uuid(3d3b9075-5549-4244-9c08-b64fefa1dd60)]
+interface nsIFetchTelemetryDataCallback : nsISupports
+{
+  void complete();
+};
+
+[scriptable, uuid(273d2dd0-6c63-475a-b864-cb65160a1909)]
+interface nsITelemetry : nsISupports
+{
+  /**
+   * Histogram types:
+   * HISTOGRAM_EXPONENTIAL - buckets increase exponentially
+   * HISTOGRAM_LINEAR - buckets increase linearly
+   * HISTOGRAM_BOOLEAN - For storing 0/1 values
+   * HISTOGRAM_FLAG - For storing a single value; its count is always == 1.
+   * HISTOGRAM_COUNT - For storing counter values without bucketing.
+   * HISTOGRAM_CATEGORICAL - For storing enumerated values by label.
+   */
+  const unsigned long HISTOGRAM_EXPONENTIAL = 0;
+  const unsigned long HISTOGRAM_LINEAR = 1;
+  const unsigned long HISTOGRAM_BOOLEAN = 2;
+  const unsigned long HISTOGRAM_FLAG = 3;
+  const unsigned long HISTOGRAM_COUNT = 4;
+  const unsigned long HISTOGRAM_CATEGORICAL = 5;
+
+  /**
+   * Scalar types:
+   * SCALAR_COUNT - for storing a numeric value
+   * SCALAR_STRING - for storing a string value
+   * SCALAR_BOOLEAN - for storing a boolean value
+   */
+  const unsigned long SCALAR_COUNT = 0;
+  const unsigned long SCALAR_STRING = 1;
+  const unsigned long SCALAR_BOOLEAN = 2;
+
+  /**
+   * Dataset types:
+   * DATASET_RELEASE_CHANNEL_OPTOUT - the basic dataset that is on-by-default on all channels
+   * DATASET_RELEASE_CHANNEL_OPTIN - the extended dataset that is opt-in on release,
+   *                                 opt-out on pre-release channels.
+   */
+  const unsigned long DATASET_RELEASE_CHANNEL_OPTOUT = 0;
+  const unsigned long DATASET_RELEASE_CHANNEL_OPTIN = 1;
+
+
+  /**
+   * An object containing a snapshot from all of the currently registered histograms.
+   * { name1: {data1}, name2:{data2}...}
+   * where data is consists of the following properties:
+   *   min - Minimal bucket size
+   *   max - Maximum bucket size
+   *   histogram_type - HISTOGRAM_EXPONENTIAL, HISTOGRAM_LINEAR, HISTOGRAM_BOOLEAN
+   *                    or HISTOGRAM_COUNT
+   *   counts - array representing contents of the buckets in the histogram
+   *   ranges -  an array with calculated bucket sizes
+   *   sum - sum of the bucket contents
+   */
+  [implicit_jscontext]
+  readonly attribute jsval histogramSnapshots;
+
+  /**
+   * Get a snapshot of the internally duplicated subsession histograms.
+   * @param clear Whether to clear out the subsession histograms after snapshotting.
+   * @return An object as histogramSnapshots, except this contains the internally duplicated histograms for subsession telemetry.
+   */
+  [implicit_jscontext]
+  jsval snapshotSubsessionHistograms([optional] in boolean clear);
+
+  /**
+   * The amount of time, in milliseconds, that the last session took
+   * to shutdown.  Reads as 0 to indicate failure.
+   */
+  readonly attribute uint32_t lastShutdownDuration;
+
+  /**
+   * The number of failed profile lock attempts that have occurred prior to 
+   * successfully locking the profile
+   */
+  readonly attribute uint32_t failedProfileLockCount;
+
+  /*
+   * An object containing information about slow SQL statements.
+   *
+   * {
+   *   mainThread: { "sqlString1": [<hit count>, <total time>], "sqlString2": [...], ... },
+   *   otherThreads: { "sqlString3": [<hit count>, <total time>], "sqlString4": [...], ... }
+   * }
+   *
+   * where:
+   *   mainThread: Slow statements that executed on the main thread
+   *   otherThreads: Slow statements that executed on a non-main thread
+   *   sqlString - String of the offending statement (see note)
+   *   hit count - The number of times this statement required longer than the threshold time to execute
+   *   total time - The sum of all execution times above the threshold time for this statement
+   *
+   * Note that dynamic SQL strings and SQL strings executed against addon DBs could contain private information.
+   * This property represents such SQL as aggregate database-level stats and the sqlString contains the database
+   * filename instead.
+   */
+  [implicit_jscontext]
+  readonly attribute jsval slowSQL;
+
+  /*
+   * See slowSQL above.
+   *
+   * An object containing full strings of every slow SQL statement if toolkit.telemetry.debugSlowSql = true
+   * The returned SQL strings may contain private information and should not be reported to Telemetry.
+   */
+  [implicit_jscontext]
+  readonly attribute jsval debugSlowSQL;
+
+  /*
+   * An object containing information about Webrtc related stats. For now it
+   * only contains local and remote ICE candidates avaiable when a Webrtc
+   * PeerConnection gets terminated.
+   */
+  [implicit_jscontext]
+  readonly attribute jsval webrtcStats;
+
+  /**
+   * A number representing the highest number of concurrent threads
+   * reached during this session.
+   */
+  readonly attribute uint32_t maximalNumberOfConcurrentThreads;
+
+  /*
+   * An array of chrome hang reports. Each element is a hang report represented
+   * as an object containing the hang duration, call stack PCs and information
+   * about modules in memory.
+   */
+  [implicit_jscontext]
+  readonly attribute jsval chromeHangs;
+
+  /*
+   * An array of thread hang stats,
+   *   [<thread>, <thread>, ...]
+   * <thread> represents a single thread,
+   *   {"name": "<name>",
+   *    "activity": <time>,
+   *    "hangs": [<hang>, <hang>, ...]}
+   * <time> represents a histogram of time intervals in milliseconds,
+   *   with the same format as histogramSnapshots
+   * <hang> represents a particular hang,
+   *   {"stack": <stack>, "nativeStack": <stack>, "histogram": <time>}
+   * <stack> represents the hang's stack,
+   *   ["<frame_0>", "<frame_1>", ...]
+   */
+  [implicit_jscontext]
+  readonly attribute jsval threadHangStats;
+
+  /*
+   * An object with two fields: memoryMap and stacks.
+   * * memoryMap is a list of loaded libraries.
+   * * stacks is a list of stacks. Each stack is a list of pairs of the form
+   *   [moduleIndex, offset]. The moduleIndex is an index into the memoryMap and
+   *   offset is an offset in the library at memoryMap[moduleIndex].
+   * This format is used to make it easier to send the stacks to the
+   * symbolication server.
+   */
+  [implicit_jscontext]
+  readonly attribute jsval lateWrites;
+
+  /**
+   * Returns an array whose values are the names of histograms defined
+   * in Histograms.json.
+   *
+   * @param dataset - DATASET_RELEASE_CHANNEL_OPTOUT or DATASET_RELEASE_CHANNEL_OPTIN
+   */
+  void registeredHistograms(in uint32_t dataset,
+                            out uint32_t count,
+                            [retval, array, size_is(count)] out string histograms);
+
+  /**
+   * Create and return a histogram registered in TelemetryHistograms.h.
+   *
+   * @param id - unique identifier from TelemetryHistograms.h
+   * The returned object has the following functions:
+   *   add(int) - Adds an int value to the appropriate bucket
+   *   snapshot() - Returns a snapshot of the histogram with the same data fields as in histogramSnapshots()
+   *   clear() - Zeros out the histogram's buckets and sum
+   *   dataset() - identifies what dataset this is in: DATASET_RELEASE_CHANNEL_OPTOUT or ...OPTIN
+   */
+  [implicit_jscontext]
+  jsval getHistogramById(in ACString id);
+
+  /*
+   * An object containing a snapshot from all of the currently registered keyed histograms.
+   * { name1: {histogramData1}, name2:{histogramData2}...}
+   * where the histogramData is as described in histogramSnapshots.
+   */
+  [implicit_jscontext]
+  readonly attribute jsval keyedHistogramSnapshots;
+
+  /**
+   * Returns an array whose values are the names of histograms defined
+   * in Histograms.json.
+   *
+   * @param dataset - DATASET_RELEASE_CHANNEL_OPTOUT or ...OPTIN
+   */
+  void registeredKeyedHistograms(in uint32_t dataset, out uint32_t count,
+                                 [retval, array, size_is(count)] out string histograms);
+
+  /**
+   * Create and return a histogram registered in TelemetryHistograms.h.
+   *
+   * @param id - unique identifier from TelemetryHistograms.h
+   * The returned object has the following functions:
+   *   add(string key, [optional] int) - Add an int value to the histogram for that key. If no histogram for that key exists yet, it is created.
+   *   snapshot([optional] string key) - If key is provided, returns a snapshot for the histogram with that key or null. If key is not provided, returns the snapshots of all the registered keys in the form {key1: snapshot1, key2: snapshot2, ...}.
+   *   keys() - Returns an array with the string keys of the currently registered histograms
+   *   clear() - Clears the registered histograms from this.
+   *   dataset() - identifies what dataset this is in: DATASET_RELEASE_CHANNEL_OPTOUT or ...OPTIN
+   */
+  [implicit_jscontext]
+  jsval getKeyedHistogramById(in ACString id);
+
+  /**
+   * A flag indicating if Telemetry can record base data (FHR data). This is true if the
+   * FHR data reporting service or self-support are enabled.
+   *
+   * In the unlikely event that adding a new base probe is needed, please check the data
+   * collection wiki at https://wiki.mozilla.org/Firefox/Data_Collection and talk to the
+   * Telemetry team.
+   */
+  attribute boolean canRecordBase;
+
+  /**
+   * A flag indicating if Telemetry is allowed to record extended data. Returns false if
+   * the user hasn't opted into "extended Telemetry" on the Release channel, when the
+   * user has explicitly opted out of Telemetry on Nightly/Aurora/Beta or if manually
+   * set to false during tests.
+   *
+   * Set this to false in tests to disable gathering of extended telemetry statistics.
+   */
+  attribute boolean canRecordExtended;
+
+  /**
+   * A flag indicating whether Telemetry can submit official results (for base or extended
+   * data). This is true on official, non-debug builds with built in support for Mozilla
+   * Telemetry reporting.
+   */
+  readonly attribute boolean isOfficialTelemetry;
+
+  /** Addon telemetry hooks */
+
+  /**
+   * Register a histogram for an addon.  Throws an error if the
+   * histogram name has been registered previously.
+   *
+   * @param addon_id - Unique ID of the addon
+   * @param name - Unique histogram name
+   * @param histogram_type - HISTOGRAM_EXPONENTIAL, HISTOGRAM_LINEAR,
+   *        HISTOGRAM_BOOLEAN or HISTOGRAM_COUNT
+   * @param min - Minimal bucket size
+   * @param max - Maximum bucket size
+   * @param bucket_count - number of buckets in the histogram
+   */
+  [optional_argc]
+  void registerAddonHistogram(in ACString addon_id, in ACString name,
+                              in unsigned long histogram_type,
+                              [optional] in uint32_t min,
+                              [optional] in uint32_t max,
+                              [optional] in uint32_t bucket_count);
+
+  /**
+   * Return a histogram previously registered via
+   * registerAddonHistogram.  Throws an error if the id/name combo has
+   * not been registered via registerAddonHistogram.
+   *
+   * @param addon_id - Unique ID of the addon
+   * @param name - Registered histogram name
+   *
+   */
+  [implicit_jscontext]
+  jsval getAddonHistogram(in ACString addon_id, in ACString name);
+
+  /**
+   * Delete all histograms associated with the given addon id.
+   *
+   * @param addon_id - Unique ID of the addon
+   */
+  void unregisterAddonHistograms(in ACString addon_id);
+
+  /**
+   * Enable/disable recording for this histogram at runtime.
+   * Recording is enabled by default, unless listed at kRecordingInitiallyDisabledIDs[].
+   * Name must be a valid Histogram identifier, otherwise an assertion will be triggered.
+   *
+   * @param id - unique identifier from histograms.json
+   * @param enabled - whether or not to enable recording from now on.
+   */
+  void setHistogramRecordingEnabled(in ACString id, in boolean enabled);
+
+  /**
+   * An object containing a snapshot from all of the currently
+   * registered addon histograms.
+   * { addon-id1 : data1, ... }
+   *
+   * where data is an object whose properties are the names of the
+   * addon's histograms and whose corresponding values are as in
+   * histogramSnapshots.
+   */
+  [implicit_jscontext]
+  readonly attribute jsval addonHistogramSnapshots;
+
+  /**
+   * Read data from the previous run. After the callback is called, the last
+   * shutdown time is available in lastShutdownDuration and any late
+   * writes in lateWrites.
+   */
+  void asyncFetchTelemetryData(in nsIFetchTelemetryDataCallback aCallback);
+
+  /**
+   * Get statistics of file IO reports, null, if not recorded.
+   *
+   * The statistics are returned as an object whose propoerties are the names
+   * of the files that have been accessed and whose corresponding values are
+   * arrays of size three, representing startup, normal, and shutdown stages.
+   * Each stage's entry is either null or an array with the layout
+   * [total_time, #creates, #reads, #writes, #fsyncs, #stats]
+   */
+  [implicit_jscontext]
+  readonly attribute jsval fileIOReports;
+
+  /**
+   * Return the number of milliseconds since process start using monotonic
+   * timestamps (unaffected by system clock changes).
+   * @throws NS_ERROR_NOT_AVAILABLE if TimeStamp doesn't have the data.
+   */
+  double msSinceProcessStart();
+
+  /**
+   * Adds the value to the given scalar.
+   *
+   * @param aName The scalar name.
+   * @param aValue The numeric value to add to the scalar. Only unsigned integers supported.
+   */
+  [implicit_jscontext]
+  void scalarAdd(in ACString aName, in jsval aValue);
+
+  /**
+   * Sets the scalar to the given value.
+   *
+   * @param aName The scalar name.
+   * @param aValue The value to set the scalar to. If the type of aValue doesn't match the
+   *        type of the scalar, the function will fail. For scalar string types, the this
+   *        is truncated to 50 characters.
+   */
+  [implicit_jscontext]
+  void scalarSet(in ACString aName, in jsval aValue);
+
+  /**
+   * Sets the scalar to the maximum of the current and the passed value.
+   *
+   * @param aName The scalar name.
+   * @param aValue The numeric value to set the scalar to. Only unsigned integers supported.
+   */
+  [implicit_jscontext]
+  void scalarSetMaximum(in ACString aName, in jsval aValue);
+
+  /**
+   * Serializes the scalars from the given dataset to a JSON-style object and resets them.
+   * The returned structure looks like:
+   *   { "group1.probe": 1, "group1.other_probe": false, ... }
+   *
+   * @param aDataset DATASET_RELEASE_CHANNEL_OPTOUT or DATASET_RELEASE_CHANNEL_OPTIN.
+   * @param [aClear=false] Whether to clear out the scalars after snapshotting.
+   */
+  [implicit_jscontext, optional_argc]
+  jsval snapshotScalars(in uint32_t aDataset, [optional] in boolean aClear);
+
+  /**
+   * Adds the value to the given keyed scalar.
+   *
+   * @param aName The scalar name.
+   * @param aKey The key name.
+   * @param aValue The numeric value to add to the scalar. Only unsigned integers supported.
+   */
+  [implicit_jscontext]
+  void keyedScalarAdd(in ACString aName, in AString aKey, in jsval aValue);
+
+  /**
+   * Sets the keyed scalar to the given value.
+   *
+   * @param aName The scalar name.
+   * @param aKey The key name.
+   * @param aValue The value to set the scalar to. If the type of aValue doesn't match the
+   *        type of the scalar, the function will fail.
+   */
+  [implicit_jscontext]
+  void keyedScalarSet(in ACString aName, in AString aKey, in jsval aValue);
+
+  /**
+   * Sets the keyed scalar to the maximum of the current and the passed value.
+   *
+   * @param aName The scalar name.
+   * @param aKey The key name.
+   * @param aValue The numeric value to set the scalar to. Only unsigned integers supported.
+   */
+  [implicit_jscontext]
+  void keyedScalarSetMaximum(in ACString aName, in AString aKey, in jsval aValue);
+
+  /**
+   * Serializes the keyed scalars from the given dataset to a JSON-style object and
+   * resets them.
+   * The returned structure looks like:
+   *   { "group1.probe": { "key_1": 2, "key_2": 1, ... }, ... }
+   *
+   * @param aDataset DATASET_RELEASE_CHANNEL_OPTOUT or DATASET_RELEASE_CHANNEL_OPTIN.
+   * @param [aClear=false] Whether to clear out the scalars after snapshotting.
+   */
+  [implicit_jscontext, optional_argc]
+  jsval snapshotKeyedScalars(in uint32_t aDataset, [optional] in boolean aClear);
+
+  /**
+   * Resets all the stored scalars. This is intended to be only used in tests.
+   */
+  void clearScalars();
+
+  /**
+   * Immediately sends any Telemetry batched on this process to the parent
+   * process. This is intended only to be used on process shutdown.
+   */
+  void flushBatchedChildTelemetry();
+
+  /**
+   * Record an event in Telemetry.
+   *
+   * @param aCategory The category name.
+   * @param aMethod The method name.
+   * @param aMethod The object name.
+   * @param aValue An optional string value to record.
+   * @param aExtra An optional object of the form (string -> string).
+   *               It should only contain registered extra keys.
+   *
+   * @throws NS_ERROR_INVALID_ARG When trying to record an unknown event.
+   */
+  [implicit_jscontext, optional_argc]
+  void recordEvent(in ACString aCategory, in ACString aMethod, in ACString aObject, [optional] in jsval aValue, [optional] in jsval extra);
+
+  /**
+   * Serializes the recorded events to a JSON-appropriate array and optionally resets them.
+   * The returned structure looks like this:
+   *   [
+   *     // [timestamp, category, method, object, stringValue, extraValues]
+   *     [43245, "category1", "method1", "object1", "string value", null],
+   *     [43258, "category1", "method2", "object1", null, {"key1": "string value"}],
+   *     ...
+   *   ]
+   *
+   * @param aDataset DATASET_RELEASE_CHANNEL_OPTOUT or DATASET_RELEASE_CHANNEL_OPTIN.
+   * @param [aClear=false] Whether to clear out the scalars after snapshotting.
+   */
+  [implicit_jscontext, optional_argc]
+  jsval snapshotBuiltinEvents(in uint32_t aDataset, [optional] in boolean aClear);
+
+  /**
+   * Resets all the stored events. This is intended to be only used in tests.
+   */
+  void clearEvents();
+};