michael@0: /* -*- Mode: C++; c-basic-offset: 2; indent-tabs-mode: nil; tab-width: 8 -*- */
michael@0: /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0:  * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0:  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0: 
michael@0: #include "nsISupports.idl"
michael@0: #include "nsIFile.idl"
michael@0: 
michael@0: [scriptable,function, uuid(3d3b9075-5549-4244-9c08-b64fefa1dd60)]
michael@0: interface nsIFetchTelemetryDataCallback : nsISupports
michael@0: {
michael@0:   void complete();
michael@0: };
michael@0: 
michael@0: [scriptable, uuid(4e4bfc35-dac6-4b28-ade4-7e45760051d5)]
michael@0: interface nsITelemetry : nsISupports
michael@0: {
michael@0:   /**
michael@0:    * Histogram types:
michael@0:    * HISTOGRAM_EXPONENTIAL - buckets increase exponentially
michael@0:    * HISTOGRAM_LINEAR - buckets increase linearly
michael@0:    * HISTOGRAM_BOOLEAN - For storing 0/1 values
michael@0:    * HISTOGRAM_FLAG - For storing a single value; its count is always == 1.
michael@0:    */
michael@0:   const unsigned long HISTOGRAM_EXPONENTIAL = 0;
michael@0:   const unsigned long HISTOGRAM_LINEAR = 1;
michael@0:   const unsigned long HISTOGRAM_BOOLEAN = 2;
michael@0:   const unsigned long HISTOGRAM_FLAG = 3;
michael@0: 
michael@0:   /*
michael@0:    * An object containing a snapshot from all of the currently registered histograms.
michael@0:    * { name1: {data1}, name2:{data2}...}
michael@0:    * where data is consists of the following properties:
michael@0:    *   min - Minimal bucket size
michael@0:    *   max - Maximum bucket size
michael@0:    *   histogram_type - HISTOGRAM_EXPONENTIAL, HISTOGRAM_LINEAR, or HISTOGRAM_BOOLEAN
michael@0:    *   counts - array representing contents of the buckets in the histogram
michael@0:    *   ranges -  an array with calculated bucket sizes
michael@0:    *   sum - sum of the bucket contents
michael@0:    *   static - true for histograms defined in TelemetryHistograms.h, false for ones defined with newHistogram
michael@0:    */
michael@0:   [implicit_jscontext]
michael@0:   readonly attribute jsval histogramSnapshots;
michael@0: 
michael@0:   /**
michael@0:    * The amount of time, in milliseconds, that the last session took
michael@0:    * to shutdown.  Reads as 0 to indicate failure.
michael@0:    */
michael@0:   readonly attribute uint32_t lastShutdownDuration;
michael@0: 
michael@0:   /**
michael@0:    * The number of failed profile lock attempts that have occurred prior to 
michael@0:    * successfully locking the profile
michael@0:    */
michael@0:   readonly attribute uint32_t failedProfileLockCount;
michael@0: 
michael@0:   /*
michael@0:    * An object containing information about slow SQL statements.
michael@0:    *
michael@0:    * {
michael@0:    *   mainThread: { "sqlString1": [<hit count>, <total time>], "sqlString2": [...], ... },
michael@0:    *   otherThreads: { "sqlString3": [<hit count>, <total time>], "sqlString4": [...], ... }
michael@0:    * }
michael@0:    *
michael@0:    * where:
michael@0:    *   mainThread: Slow statements that executed on the main thread
michael@0:    *   otherThreads: Slow statements that executed on a non-main thread
michael@0:    *   sqlString - String of the offending statement (see note)
michael@0:    *   hit count - The number of times this statement required longer than the threshold time to execute
michael@0:    *   total time - The sum of all execution times above the threshold time for this statement
michael@0:    *
michael@0:    * Note that dynamic SQL strings and SQL strings executed against addon DBs could contain private information.
michael@0:    * This property represents such SQL as aggregate database-level stats and the sqlString contains the database
michael@0:    * filename instead.
michael@0:    */
michael@0:   [implicit_jscontext]
michael@0:   readonly attribute jsval slowSQL;
michael@0: 
michael@0:   /*
michael@0:    * See slowSQL above.
michael@0:    *
michael@0:    * An object containing full strings of every slow SQL statement if toolkit.telemetry.debugSlowSql = true
michael@0:    * The returned SQL strings may contain private information and should not be reported to Telemetry.
michael@0:    */
michael@0:   [implicit_jscontext]
michael@0:   readonly attribute jsval debugSlowSQL;
michael@0: 
michael@0:   /**
michael@0:    * A number representing the highest number of concurrent threads
michael@0:    * reached during this session.
michael@0:    */
michael@0:   readonly attribute uint32_t maximalNumberOfConcurrentThreads;
michael@0: 
michael@0:   /*
michael@0:    * An array of chrome hang reports. Each element is a hang report represented
michael@0:    * as an object containing the hang duration, call stack PCs and information
michael@0:    * about modules in memory.
michael@0:    */
michael@0:   [implicit_jscontext]
michael@0:   readonly attribute jsval chromeHangs;
michael@0: 
michael@0:   /*
michael@0:    * An array of thread hang stats,
michael@0:    *   [<thread>, <thread>, ...]
michael@0:    * <thread> represents a single thread,
michael@0:    *   {"name": "<name>",
michael@0:    *    "activity": <time>,
michael@0:    *    "hangs": [<hang>, <hang>, ...]}
michael@0:    * <time> represents a histogram of time intervals in milliseconds,
michael@0:    *   with the same format as histogramSnapshots
michael@0:    * <hang> represents a particular hang,
michael@0:    *   {"stack": <stack>, "histogram": <time>}
michael@0:    * <stack> represents the hang's stack,
michael@0:    *   ["<frame_0>", "<frame_1>", ...]
michael@0:    */
michael@0:   [implicit_jscontext]
michael@0:   readonly attribute jsval threadHangStats;
michael@0: 
michael@0:   /*
michael@0:    * An object with two fields: memoryMap and stacks.
michael@0:    * * memoryMap is a list of loaded libraries.
michael@0:    * * stacks is a list of stacks. Each stack is a list of pairs of the form
michael@0:    *   [moduleIndex, offset]. The moduleIndex is an index into the memoryMap and
michael@0:    *   offset is an offset in the library at memoryMap[moduleIndex].
michael@0:    * This format is used to make it easier to send the stacks to the
michael@0:    * symbolication server.
michael@0:    */
michael@0:   [implicit_jscontext]
michael@0:   readonly attribute jsval lateWrites;
michael@0: 
michael@0:   /**
michael@0:    * Returns an array whose values are the names of histograms defined
michael@0:    * in Histograms.json.
michael@0:    */
michael@0:   void registeredHistograms(out uint32_t count,
michael@0:                             [retval, array, size_is(count)] out string histograms);
michael@0: 
michael@0:   /** 
michael@0:    * Create and return a histogram.  Parameters:
michael@0:    *
michael@0:    * @param name Unique histogram name
michael@0:    * @param expiration Expiration version
michael@0:    * @param min - Minimal bucket size
michael@0:    * @param max - Maximum bucket size
michael@0:    * @param bucket_count - number of buckets in the histogram.
michael@0:    * @param type - HISTOGRAM_EXPONENTIAL, HISTOGRAM_LINEAR or HISTOGRAM_BOOLEAN
michael@0:    * The returned object has the following functions:
michael@0:    *   add(int) - Adds an int value to the appropriate bucket
michael@0:    *   snapshot() - Returns a snapshot of the histogram with the same data fields as in histogramSnapshots()
michael@0:    *   clear() - Zeros out the histogram's buckets and sum
michael@0:    */
michael@0:   [implicit_jscontext]
michael@0:   jsval newHistogram(in ACString name, in ACString expiration, in uint32_t min, in uint32_t max, in uint32_t bucket_count, in unsigned long histogram_type);
michael@0: 
michael@0:   /**
michael@0:    * Create a histogram using the current state of an existing histogram.  The
michael@0:    * existing histogram must be registered in TelemetryHistograms.h.
michael@0:    *
michael@0:    * @param name Unique histogram name
michael@0:    * @param existing_name Existing histogram name
michael@0:    * The returned object has the same functions as a histogram returned from newHistogram.
michael@0:    */
michael@0:   [implicit_jscontext]
michael@0:   jsval histogramFrom(in ACString name, in ACString existing_name);
michael@0: 
michael@0:   /**
michael@0:    * Same as newHistogram above, but for histograms registered in TelemetryHistograms.h.
michael@0:    *
michael@0:    * @param id - unique identifier from TelemetryHistograms.h
michael@0:    */
michael@0:   [implicit_jscontext]
michael@0:   jsval getHistogramById(in ACString id);
michael@0: 
michael@0:   /**
michael@0:    * Set this to false to disable gathering of telemetry statistics.
michael@0:    */
michael@0:   attribute boolean canRecord;
michael@0: 
michael@0:   /**
michael@0:    * A flag indicating whether Telemetry can submit official results.
michael@0:    */
michael@0:   readonly attribute boolean canSend;
michael@0: 
michael@0:   /** Addon telemetry hooks */
michael@0: 
michael@0:   /**
michael@0:    * Register a histogram for an addon.  Throws an error if the
michael@0:    * histogram name has been registered previously.
michael@0:    *
michael@0:    * @param addon_id - Unique ID of the addon
michael@0:    * @param name - Unique histogram name
michael@0:    * @param min - Minimal bucket size
michael@0:    * @param max - Maximum bucket size
michael@0:    * @param bucket_count - number of buckets in the histogram
michael@0:    * @param histogram_type - HISTOGRAM_EXPONENTIAL, HISTOGRAM_LINEAR, or
michael@0:    *        HISTOGRAM_BOOLEAN
michael@0:    */
michael@0:   void registerAddonHistogram(in ACString addon_id, in ACString name,
michael@0:                               in uint32_t min, in uint32_t max,
michael@0:                               in uint32_t bucket_count,
michael@0:                               in unsigned long histogram_type);
michael@0: 
michael@0:   /**
michael@0:    * Return a histogram previously registered via
michael@0:    * registerAddonHistogram.  Throws an error if the id/name combo has
michael@0:    * not been registered via registerAddonHistogram.
michael@0:    *
michael@0:    * @param addon_id - Unique ID of the addon
michael@0:    * @param name - Registered histogram name
michael@0:    *
michael@0:    * The returned object has the same functions as a histogram returned
michael@0:    * from newHistogram.
michael@0:    */
michael@0:   [implicit_jscontext]
michael@0:   jsval getAddonHistogram(in ACString addon_id, in ACString name);
michael@0: 
michael@0:   /**
michael@0:    * Delete all histograms associated with the given addon id.
michael@0:    *
michael@0:    * @param addon_id - Unique ID of the addon
michael@0:    */
michael@0:   void unregisterAddonHistograms(in ACString addon_id);
michael@0: 
michael@0:   /**
michael@0:    * An object containing a snapshot from all of the currently
michael@0:    * registered addon histograms.
michael@0:    * { addon-id1 : data1, ... }
michael@0:    *
michael@0:    * where data is an object whose properties are the names of the
michael@0:    * addon's histograms and whose corresponding values are as in
michael@0:    * histogramSnapshots.
michael@0:    */
michael@0:   [implicit_jscontext]
michael@0:   readonly attribute jsval addonHistogramSnapshots;
michael@0: 
michael@0:   /**
michael@0:    * Read data from the previous run. After the callback is called, the last
michael@0:    * shutdown time is available in lastShutdownDuration and any late
michael@0:    * writes in lateWrites.
michael@0:    */
michael@0:   void asyncFetchTelemetryData(in nsIFetchTelemetryDataCallback aCallback);
michael@0: 
michael@0:   /**
michael@0:    * Get statistics of file IO reports, null, if not recorded.
michael@0:    *
michael@0:    * The statistics are returned as an object whose propoerties are the names
michael@0:    * of the files that have been accessed and whose corresponding values are
michael@0:    * arrays of size three, representing startup, normal, and shutdown stages.
michael@0:    * Each stage's entry is either null or an array with the layout
michael@0:    * [total_time, #creates, #reads, #writes, #fsyncs, #stats]
michael@0:    */
michael@0:   [implicit_jscontext]
michael@0:   readonly attribute jsval fileIOReports;
michael@0: 
michael@0:   /**
michael@0:    * Return the number of seconds since process start using monotonic
michael@0:    * timestamps (unaffected by system clock changes).
michael@0:    * @throws NS_ERROR_NOT_AVAILABLE if TimeStamp doesn't have the data.
michael@0:    */
michael@0:   double msSinceProcessStart();
michael@0: };