/* 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/. */ 'use strict'; const Ci = Components.interfaces; const Cc = Components.classes; const Cu = Components.utils; Cu.import("resource://gre/modules/Services.jsm"); const Telemetry = Services.telemetry; const bundle = Services.strings.createBundle( "chrome://global/locale/aboutTelemetry.properties"); const brandBundle = Services.strings.createBundle( "chrome://branding/locale/brand.properties"); const TelemetryPing = Cc["@mozilla.org/base/telemetry-ping;1"]. getService(Ci.nsITelemetryPing); // Maximum height of a histogram bar (in em) const MAX_BAR_HEIGHT = 18; const PREF_TELEMETRY_SERVER_OWNER = "toolkit.telemetry.server_owner"; #ifdef MOZ_TELEMETRY_ON_BY_DEFAULT const PREF_TELEMETRY_ENABLED = "toolkit.telemetry.enabledPreRelease"; #else const PREF_TELEMETRY_ENABLED = "toolkit.telemetry.enabled"; #endif const PREF_DEBUG_SLOW_SQL = "toolkit.telemetry.debugSlowSql"; const PREF_SYMBOL_SERVER_URI = "profiler.symbolicationUrl"; const DEFAULT_SYMBOL_SERVER_URI = "http://symbolapi.mozilla.org"; // Cached value of document's RTL mode let documentRTLMode = ""; /** * Helper function for fetching a config pref * * @param aPrefName Name of config pref to fetch. * @param aDefault Default value to return if pref isn't set. * @return Value of pref */ function getPref(aPrefName, aDefault) { let result = aDefault; try { let prefType = Services.prefs.getPrefType(aPrefName); if (prefType == Ci.nsIPrefBranch.PREF_BOOL) { result = Services.prefs.getBoolPref(aPrefName); } else if (prefType == Ci.nsIPrefBranch.PREF_STRING) { result = Services.prefs.getCharPref(aPrefName); } } catch (e) { // Return default if Prefs service throws exception } return result; } /** * Helper function for determining whether the document direction is RTL. * Caches result of check on first invocation. */ function isRTL() { if (!documentRTLMode) documentRTLMode = window.getComputedStyle(document.body).direction; return (documentRTLMode == "rtl"); } let observer = { enableTelemetry: bundle.GetStringFromName("enableTelemetry"), disableTelemetry: bundle.GetStringFromName("disableTelemetry"), /** * Observer is called whenever Telemetry is enabled or disabled */ observe: function observe(aSubject, aTopic, aData) { if (aData == PREF_TELEMETRY_ENABLED) { this.updatePrefStatus(); } }, /** * Updates the button & text at the top of the page to reflect Telemetry state. */ updatePrefStatus: function updatePrefStatus() { // Notify user whether Telemetry is enabled let enabledElement = document.getElementById("description-enabled"); let disabledElement = document.getElementById("description-disabled"); let toggleElement = document.getElementById("toggle-telemetry"); if (getPref(PREF_TELEMETRY_ENABLED, false)) { enabledElement.classList.remove("hidden"); disabledElement.classList.add("hidden"); toggleElement.innerHTML = this.disableTelemetry; } else { enabledElement.classList.add("hidden"); disabledElement.classList.remove("hidden"); toggleElement.innerHTML = this.enableTelemetry; } } }; let SlowSQL = { slowSqlHits: bundle.GetStringFromName("slowSqlHits"), slowSqlAverage: bundle.GetStringFromName("slowSqlAverage"), slowSqlStatement: bundle.GetStringFromName("slowSqlStatement"), mainThreadTitle: bundle.GetStringFromName("slowSqlMain"), otherThreadTitle: bundle.GetStringFromName("slowSqlOther"), /** * Render slow SQL statistics */ render: function SlowSQL_render() { let debugSlowSql = getPref(PREF_DEBUG_SLOW_SQL, false); let {mainThread, otherThreads} = Telemetry[debugSlowSql ? "debugSlowSQL" : "slowSQL"]; let mainThreadCount = Object.keys(mainThread).length; let otherThreadCount = Object.keys(otherThreads).length; if (mainThreadCount == 0 && otherThreadCount == 0) { showEmptySectionMessage("slow-sql-section"); return; } if (debugSlowSql) { document.getElementById("sql-warning").classList.remove("hidden"); } let slowSqlDiv = document.getElementById("slow-sql-tables"); // Main thread if (mainThreadCount > 0) { let table = document.createElement("table"); this.renderTableHeader(table, this.mainThreadTitle); this.renderTable(table, mainThread); slowSqlDiv.appendChild(table); slowSqlDiv.appendChild(document.createElement("hr")); } // Other threads if (otherThreadCount > 0) { let table = document.createElement("table"); this.renderTableHeader(table, this.otherThreadTitle); this.renderTable(table, otherThreads); slowSqlDiv.appendChild(table); slowSqlDiv.appendChild(document.createElement("hr")); } }, /** * Creates a header row for a Slow SQL table * Tabs & newlines added to cells to make it easier to copy-paste. * * @param aTable Parent table element * @param aTitle Table's title */ renderTableHeader: function SlowSQL_renderTableHeader(aTable, aTitle) { let caption = document.createElement("caption"); caption.appendChild(document.createTextNode(aTitle + "\n")); aTable.appendChild(caption); let headings = document.createElement("tr"); this.appendColumn(headings, "th", this.slowSqlHits + "\t"); this.appendColumn(headings, "th", this.slowSqlAverage + "\t"); this.appendColumn(headings, "th", this.slowSqlStatement + "\n"); aTable.appendChild(headings); }, /** * Fills out the table body * Tabs & newlines added to cells to make it easier to copy-paste. * * @param aTable Parent table element * @param aSql SQL stats object */ renderTable: function SlowSQL_renderTable(aTable, aSql) { for (let [sql, [hitCount, totalTime]] of Iterator(aSql)) { let averageTime = totalTime / hitCount; let sqlRow = document.createElement("tr"); this.appendColumn(sqlRow, "td", hitCount + "\t"); this.appendColumn(sqlRow, "td", averageTime.toFixed(0) + "\t"); this.appendColumn(sqlRow, "td", sql + "\n"); aTable.appendChild(sqlRow); } }, /** * Helper function for appending a column to a Slow SQL table. * * @param aRowElement Parent row element * @param aColType Column's tag name * @param aColText Column contents */ appendColumn: function SlowSQL_appendColumn(aRowElement, aColType, aColText) { let colElement = document.createElement(aColType); let colTextElement = document.createTextNode(aColText); colElement.appendChild(colTextElement); aRowElement.appendChild(colElement); } }; /** * Removes child elements from the supplied div * * @param aDiv Element to be cleared */ function clearDivData(aDiv) { while (aDiv.hasChildNodes()) { aDiv.removeChild(aDiv.lastChild); } }; let StackRenderer = { stackTitle: bundle.GetStringFromName("stackTitle"), memoryMapTitle: bundle.GetStringFromName("memoryMapTitle"), /** * Outputs the memory map associated with this hang report * * @param aDiv Output div */ renderMemoryMap: function StackRenderer_renderMemoryMap(aDiv, memoryMap) { aDiv.appendChild(document.createTextNode(this.memoryMapTitle)); aDiv.appendChild(document.createElement("br")); for (let currentModule of memoryMap) { aDiv.appendChild(document.createTextNode(currentModule.join(" "))); aDiv.appendChild(document.createElement("br")); } aDiv.appendChild(document.createElement("br")); }, /** * Outputs the raw PCs from the hang's stack * * @param aDiv Output div * @param aStack Array of PCs from the hang stack */ renderStack: function StackRenderer_renderStack(aDiv, aStack) { aDiv.appendChild(document.createTextNode(this.stackTitle)); let stackText = " " + aStack.join(" "); aDiv.appendChild(document.createTextNode(stackText)); aDiv.appendChild(document.createElement("br")); aDiv.appendChild(document.createElement("br")); }, renderStacks: function StackRenderer_renderStacks(aPrefix, aStacks, aMemoryMap, aRenderHeader) { let div = document.getElementById(aPrefix + '-data'); clearDivData(div); let fetchE = document.getElementById(aPrefix + '-fetch-symbols'); if (fetchE) { fetchE.classList.remove("hidden"); } let hideE = document.getElementById(aPrefix + '-hide-symbols'); if (hideE) { hideE.classList.add("hidden"); } if (aStacks.length == 0) { showEmptySectionMessage(aPrefix + '-section'); return; } this.renderMemoryMap(div, aMemoryMap); for (let i = 0; i < aStacks.length; ++i) { let stack = aStacks[i]; aRenderHeader(i); this.renderStack(div, stack) } }, /** * Renders the title of the stack: e.g. "Late Write #1" or * "Hang Report #1 (6 seconds)". * * @param aFormatArgs formating args to be passed to formatStringFromName. */ renderHeader: function StackRenderer_renderHeader(aPrefix, aFormatArgs) { let div = document.getElementById(aPrefix + "-data"); let titleElement = document.createElement("span"); titleElement.className = "stack-title"; let titleText = bundle.formatStringFromName( aPrefix + "-title", aFormatArgs, aFormatArgs.length); titleElement.appendChild(document.createTextNode(titleText)); div.appendChild(titleElement); div.appendChild(document.createElement("br")); } }; function SymbolicationRequest(aPrefix, aRenderHeader, aMemoryMap, aStacks) { this.prefix = aPrefix; this.renderHeader = aRenderHeader; this.memoryMap = aMemoryMap; this.stacks = aStacks; } /** * A callback for onreadystatechange. It replaces the numeric stack with * the symbolicated one returned by the symbolication server. */ SymbolicationRequest.prototype.handleSymbolResponse = function SymbolicationRequest_handleSymbolResponse() { if (this.symbolRequest.readyState != 4) return; let fetchElement = document.getElementById(this.prefix + "-fetch-symbols"); fetchElement.classList.add("hidden"); let hideElement = document.getElementById(this.prefix + "-hide-symbols"); hideElement.classList.remove("hidden"); let div = document.getElementById(this.prefix + "-data"); clearDivData(div); let errorMessage = bundle.GetStringFromName("errorFetchingSymbols"); if (this.symbolRequest.status != 200) { div.appendChild(document.createTextNode(errorMessage)); return; } let jsonResponse = {}; try { jsonResponse = JSON.parse(this.symbolRequest.responseText); } catch (e) { div.appendChild(document.createTextNode(errorMessage)); return; } for (let i = 0; i < jsonResponse.length; ++i) { let stack = jsonResponse[i]; this.renderHeader(i); for (let symbol of stack) { div.appendChild(document.createTextNode(symbol)); div.appendChild(document.createElement("br")); } div.appendChild(document.createElement("br")); } }; /** * Send a request to the symbolication server to symbolicate this stack. */ SymbolicationRequest.prototype.fetchSymbols = function SymbolicationRequest_fetchSymbols() { let symbolServerURI = getPref(PREF_SYMBOL_SERVER_URI, DEFAULT_SYMBOL_SERVER_URI); let request = {"memoryMap" : this.memoryMap, "stacks" : this.stacks, "version" : 3}; let requestJSON = JSON.stringify(request); this.symbolRequest = XMLHttpRequest(); this.symbolRequest.open("POST", symbolServerURI, true); this.symbolRequest.setRequestHeader("Content-type", "application/json"); this.symbolRequest.setRequestHeader("Content-length", requestJSON.length); this.symbolRequest.setRequestHeader("Connection", "close"); this.symbolRequest.onreadystatechange = this.handleSymbolResponse.bind(this); this.symbolRequest.send(requestJSON); } let ChromeHangs = { symbolRequest: null, /** * Renders raw chrome hang data */ render: function ChromeHangs_render() { let hangs = Telemetry.chromeHangs; let stacks = hangs.stacks; let memoryMap = hangs.memoryMap; StackRenderer.renderStacks("chrome-hangs", stacks, memoryMap, this.renderHangHeader); }, renderHangHeader: function ChromeHangs_renderHangHeader(aIndex) { let durations = Telemetry.chromeHangs.durations; StackRenderer.renderHeader("chrome-hangs", [aIndex + 1, durations[aIndex]]); } }; let Histogram = { hgramSamplesCaption: bundle.GetStringFromName("histogramSamples"), hgramAverageCaption: bundle.GetStringFromName("histogramAverage"), hgramSumCaption: bundle.GetStringFromName("histogramSum"), /** * Renders a single Telemetry histogram * * @param aParent Parent element * @param aName Histogram name * @param aHgram Histogram information */ render: function Histogram_render(aParent, aName, aHgram) { let hgram = this.unpack(aHgram); let outerDiv = document.createElement("div"); outerDiv.className = "histogram"; outerDiv.id = aName; let divTitle = document.createElement("div"); divTitle.className = "histogram-title"; divTitle.appendChild(document.createTextNode(aName)); outerDiv.appendChild(divTitle); let stats = hgram.sample_count + " " + this.hgramSamplesCaption + ", " + this.hgramAverageCaption + " = " + hgram.pretty_average + ", " + this.hgramSumCaption + " = " + hgram.sum; let divStats = document.createElement("div"); divStats.appendChild(document.createTextNode(stats)); outerDiv.appendChild(divStats); if (isRTL()) hgram.values.reverse(); this.renderValues(outerDiv, hgram.values, hgram.max); aParent.appendChild(outerDiv); }, /** * Unpacks histogram values * * @param aHgram Packed histogram * * @return Unpacked histogram representation */ unpack: function Histogram_unpack(aHgram) { let sample_count = aHgram.counts.reduceRight(function (a, b) a + b); let buckets = [0, 1]; if (aHgram.histogram_type != Telemetry.HISTOGRAM_BOOLEAN) { buckets = aHgram.ranges; } let average = Math.round(aHgram.sum * 10 / sample_count) / 10; let max_value = Math.max.apply(Math, aHgram.counts); let first = true; let last = 0; let values = []; for (let i = 0; i < buckets.length; i++) { let count = aHgram.counts[i]; if (!count) continue; if (first) { first = false; if (i) { values.push([buckets[i - 1], 0]); } } last = i + 1; values.push([buckets[i], count]); } if (last && last < buckets.length) { values.push([buckets[last], 0]); } let result = { values: values, pretty_average: average, max: max_value, sample_count: sample_count, sum: aHgram.sum }; return result; }, /** * Create histogram bars * * @param aDiv Outer parent div * @param aValues Histogram values * @param aMaxValue Largest histogram value in set */ renderValues: function Histogram_renderValues(aDiv, aValues, aMaxValue) { for (let [label, value] of aValues) { let belowEm = Math.round(MAX_BAR_HEIGHT * (value / aMaxValue) * 10) / 10; let aboveEm = MAX_BAR_HEIGHT - belowEm; let barDiv = document.createElement("div"); barDiv.className = "bar"; barDiv.style.paddingTop = aboveEm + "em"; // Add value label or an nbsp if no value barDiv.appendChild(document.createTextNode(value ? value : '\u00A0')); // Create the blue bar let bar = document.createElement("div"); bar.className = "bar-inner"; bar.style.height = belowEm + "em"; barDiv.appendChild(bar); // Add bucket label barDiv.appendChild(document.createTextNode(label)); aDiv.appendChild(barDiv); } } }; let KeyValueTable = { keysHeader: bundle.GetStringFromName("keysHeader"), valuesHeader: bundle.GetStringFromName("valuesHeader"), /** * Fill out a 2-column table with keys and values */ render: function KeyValueTable_render(aTableID, aMeasurements) { let table = document.getElementById(aTableID); this.renderHeader(table); this.renderBody(table, aMeasurements); }, /** * Create the table header * Tabs & newlines added to cells to make it easier to copy-paste. * * @param aTable Table element */ renderHeader: function KeyValueTable_renderHeader(aTable) { let headerRow = document.createElement("tr"); aTable.appendChild(headerRow); let keysColumn = document.createElement("th"); keysColumn.appendChild(document.createTextNode(this.keysHeader + "\t")); let valuesColumn = document.createElement("th"); valuesColumn.appendChild(document.createTextNode(this.valuesHeader + "\n")); headerRow.appendChild(keysColumn); headerRow.appendChild(valuesColumn); }, /** * Create the table body * Tabs & newlines added to cells to make it easier to copy-paste. * * @param aTable Table element * @param aMeasurements Key/value map */ renderBody: function KeyValueTable_renderBody(aTable, aMeasurements) { for (let [key, value] of Iterator(aMeasurements)) { if (typeof value == "object") { value = JSON.stringify(value); } let newRow = document.createElement("tr"); aTable.appendChild(newRow); let keyField = document.createElement("td"); keyField.appendChild(document.createTextNode(key + "\t")); newRow.appendChild(keyField); let valueField = document.createElement("td"); valueField.appendChild(document.createTextNode(value + "\n")); newRow.appendChild(valueField); } } }; /** * Helper function for showing "No data collected" message for a section * * @param aSectionID ID of the section element that needs to be changed */ function showEmptySectionMessage(aSectionID) { let sectionElement = document.getElementById(aSectionID); // Hide toggle captions let toggleElements = sectionElement.getElementsByClassName("toggle-caption"); toggleElements[0].classList.add("hidden"); toggleElements[1].classList.add("hidden"); // Show "No data collected" message let messageElement = sectionElement.getElementsByClassName("empty-caption")[0]; messageElement.classList.remove("hidden"); // Don't allow section to be expanded by clicking on the header text let sectionHeaders = sectionElement.getElementsByClassName("section-name"); for (let sectionHeader of sectionHeaders) { sectionHeader.removeEventListener("click", toggleSection); sectionHeader.style.cursor = "auto"; } // Don't allow section to be expanded by clicking on the toggle text let toggleLinks = sectionElement.getElementsByClassName("toggle-caption"); for (let toggleLink of toggleLinks) { toggleLink.removeEventListener("click", toggleSection); } } /** * Helper function that expands and collapses sections + * changes caption on the toggle text */ function toggleSection(aEvent) { let parentElement = aEvent.target.parentElement; let sectionDiv = parentElement.getElementsByTagName("div")[0]; sectionDiv.classList.toggle("hidden"); let toggleLinks = parentElement.getElementsByClassName("toggle-caption"); toggleLinks[0].classList.toggle("hidden"); toggleLinks[1].classList.toggle("hidden"); } /** * Sets the text of the page header based on a config pref + bundle strings */ function setupPageHeader() { let serverOwner = getPref(PREF_TELEMETRY_SERVER_OWNER, "Mozilla"); let brandName = brandBundle.GetStringFromName("brandFullName"); let subtitleText = bundle.formatStringFromName( "pageSubtitle", [serverOwner, brandName], 2); let subtitleElement = document.getElementById("page-subtitle"); subtitleElement.appendChild(document.createTextNode(subtitleText)); } /** * Initializes load/unload, pref change and mouse-click listeners */ function setupListeners() { Services.prefs.addObserver(PREF_TELEMETRY_ENABLED, observer, false); observer.updatePrefStatus(); // Clean up observers when page is closed window.addEventListener("unload", function unloadHandler(aEvent) { window.removeEventListener("unload", unloadHandler); Services.prefs.removeObserver(PREF_TELEMETRY_ENABLED, observer); }, false); document.getElementById("toggle-telemetry").addEventListener("click", function () { let value = getPref(PREF_TELEMETRY_ENABLED, false); Services.prefs.setBoolPref(PREF_TELEMETRY_ENABLED, !value); }, false); document.getElementById("chrome-hangs-fetch-symbols").addEventListener("click", function () { let hangs = Telemetry.chromeHangs; let req = new SymbolicationRequest("chrome-hangs", ChromeHangs.renderHangHeader, hangs.memoryMap, hangs.stacks); req.fetchSymbols(); }, false); document.getElementById("chrome-hangs-hide-symbols").addEventListener("click", function () { ChromeHangs.render(); }, false); document.getElementById("late-writes-fetch-symbols").addEventListener("click", function () { let lateWrites = TelemetryPing.getPayload().lateWrites; let req = new SymbolicationRequest("late-writes", LateWritesSingleton.renderHeader, lateWrites.memoryMap, lateWrites.stacks); req.fetchSymbols(); }, false); document.getElementById("late-writes-hide-symbols").addEventListener("click", function () { let ping = TelemetryPing.getPayload(); LateWritesSingleton.renderLateWrites(ping.lateWrites); }, false); // Clicking on the section name will toggle its state let sectionHeaders = document.getElementsByClassName("section-name"); for (let sectionHeader of sectionHeaders) { sectionHeader.addEventListener("click", toggleSection, false); } // Clicking on the "collapse"/"expand" text will also toggle section's state let toggleLinks = document.getElementsByClassName("toggle-caption"); for (let toggleLink of toggleLinks) { toggleLink.addEventListener("click", toggleSection, false); } } function onLoad() { window.removeEventListener("load", onLoad); // Set the text in the page header setupPageHeader(); // Set up event listeners setupListeners(); // Show slow SQL stats SlowSQL.render(); // Show chrome hang stacks ChromeHangs.render(); // Show histogram data let histograms = Telemetry.histogramSnapshots; if (Object.keys(histograms).length) { let hgramDiv = document.getElementById("histograms"); for (let [name, hgram] of Iterator(histograms)) { Histogram.render(hgramDiv, name, hgram); } } else { showEmptySectionMessage("histograms-section"); } // Show addon histogram data let addonDiv = document.getElementById("addon-histograms"); let addonHistogramsRendered = false; let addonData = Telemetry.addonHistogramSnapshots; for (let [addon, histograms] of Iterator(addonData)) { for (let [name, hgram] of Iterator(histograms)) { addonHistogramsRendered = true; Histogram.render(addonDiv, addon + ": " + name, hgram); } } if (!addonHistogramsRendered) { showEmptySectionMessage("addon-histograms-section"); } // Get the Telemetry Ping payload Telemetry.asyncFetchTelemetryData(displayPingData); }; let LateWritesSingleton = { renderHeader: function LateWritesSingleton_renderHeader(aIndex) { StackRenderer.renderHeader("late-writes", [aIndex + 1]); }, renderLateWrites: function LateWritesSingleton_renderLateWrites(lateWrites) { let stacks = lateWrites.stacks; let memoryMap = lateWrites.memoryMap; StackRenderer.renderStacks('late-writes', stacks, memoryMap, LateWritesSingleton.renderHeader); } }; /** * Helper function for sorting the startup milestones in the Simple Measurements * section into temporal order. * * @param aSimpleMeasurements Telemetry ping's "Simple Measurements" data * @return Sorted measurements */ function sortStartupMilestones(aSimpleMeasurements) { // List of startup milestones const startupMilestones = ["start", "main", "startupCrashDetectionBegin", "createTopLevelWindow", "firstPaint", "delayedStartupStarted", "firstLoadURI", "sessionRestoreInitialized", "sessionRestoreRestoring", "sessionRestored", "delayedStartupFinished", "startupCrashDetectionEnd", "AMI_startup_begin", "AMI_startup_end", "XPI_startup_begin", "XPI_startup_end", "XPI_bootstrap_addons_begin", "XPI_bootstrap_addons_end"]; let sortedKeys = Object.keys(aSimpleMeasurements); // Sort the measurements, with startup milestones at the front + ordered by time sortedKeys.sort(function keyCompare(keyA, keyB) { let isKeyAMilestone = (startupMilestones.indexOf(keyA) > -1); let isKeyBMilestone = (startupMilestones.indexOf(keyB) > -1); // First order by startup vs non-startup measurement if (isKeyAMilestone && !isKeyBMilestone) return -1; if (!isKeyAMilestone && isKeyBMilestone) return 1; // Don't change order of non-startup measurements if (!isKeyAMilestone && !isKeyBMilestone) return 0; // If both keys are startup measurements, order them by value return aSimpleMeasurements[keyA] - aSimpleMeasurements[keyB]; }); // Insert measurements into a result object in sort-order let result = {}; for (let key of sortedKeys) { result[key] = aSimpleMeasurements[key]; } return result; } function displayPingData() { let ping = TelemetryPing.getPayload(); // Show simple measurements let simpleMeasurements = sortStartupMilestones(ping.simpleMeasurements); if (Object.keys(simpleMeasurements).length) { KeyValueTable.render("simple-measurements-table", simpleMeasurements); } else { showEmptySectionMessage("simple-measurements-section"); } LateWritesSingleton.renderLateWrites(ping.lateWrites); // Show basic system info gathered if (Object.keys(ping.info).length) { KeyValueTable.render("system-info-table", ping.info); } else { showEmptySectionMessage("system-info-section"); } } window.addEventListener("load", onLoad, false);