The chromoting client logs connection statistics to the server.

remoting/webapp/me2mom/log_to_server.js

 // Copyright (c) 2011 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 /**
  * @fileoverview
  * Module for sending log entries to the server.
  */
 
 'use strict';
 
 /** @suppress {duplicate} */
 var remoting = remoting || {};
 
 /**
  * @constructor
  */
 remoting.LogToServer = function() {
-  /** @type Array.<string> */ this.pendingEntries = [];
+  /** @type Array.<string> */
+  this.pendingEntries = [];
+  /** @type {remoting.StatsAccumulator} */
+  this.statsAccumulator = new remoting.StatsAccumulator();
 };
 
 // Local storage keys.
 /** @private */
 remoting.LogToServer.prototype.KEY_ENABLED_ = 'remoting.LogToServer.enabled';
 /** @private */
 remoting.LogToServer.prototype.KEY_ID_ = 'remoting.LogToServer.id';
 
 // Constants used for generating an ID.
 /** @private */
@@ skipping 19 matching lines @@
  */
 remoting.LogToServer.prototype.logClientSessionStateChange =
     function(state, connectionError) {
   var entry = remoting.ServerLogEntry.prototype.makeClientSessionStateChange(
       state, connectionError);
   entry.addHostFields();
   entry.addChromeVersionField();
   entry.addWebappVersionField();
   entry.addIdField(this.getId());
   this.log(entry);
+  // Don't accumulate connection statistics across state changes.
+  this.logAccumulatedStatistics();
+  this.statsAccumulator.empty();
 };
 
 /**
+ * Logs connection statistics.
+ * @param {Object.<string, number>} stats the connection statistics
+ */
+remoting.LogToServer.prototype.logStatistics = function(stats) {
+  // Store the statistics.
+  this.statsAccumulator.add(stats);
+  // Send statistics to the server if they've been accumulating for at least
+  // 60 seconds.
+  if (this.statsAccumulator.getTimeSinceFirstValue() >= 60 * 1000) {
+    this.logAccumulatedStatistics();
+  }
+};
+
+/**
+ * Moves connection statistics from the accumulator to the log server.
+ *
+ * If all the statistics are zero, then the accumulator is still emptied,
+ * but the statistics are not sent to the log server.
+ *
+ * @private
+ */
+remoting.LogToServer.prototype.logAccumulatedStatistics = function() {
+  var entry = remoting.ServerLogEntry.prototype.makeStats(
+      this.statsAccumulator);

[Jamie, 2011/12/09 19:47:56]

Directly invoking a method on the prototype seems very odd to me. Is this an
oversight, or am I missing something? I realize that it's done the same way
above, but I think that's wrong too :)

[simonmorris, 2011/12/09 21:12:12]

This was just because I didn't have the convention that static methods
don't go in the prototype.

Done.

+  if (entry) {
+    entry.addHostFields();
+    entry.addChromeVersionField();
+    entry.addWebappVersionField();
+    entry.addIdField(this.getId());
+    this.log(entry);
+  }
+  this.statsAccumulator.empty();
+};
+
+/**
  * Sends a log entry to the server.
  *
  * @private
  * @param {remoting.ServerLogEntry} entry
  */
 remoting.LogToServer.prototype.log = function(entry) {
   if (!this.isEnabled()) {
     return;
   }
-  // Store a stanza for the entry
+  // Send the stanza to the debug log.
+  remoting.debug.logIndent(0, 'Enqueueing log entry:');
+  entry.toDebugLog(1);
+  // Store a stanza for the entry.
   this.pendingEntries.push(entry.toStanza());
   // Stop if there's no connection to the server.
   if (!remoting.wcs) {
     return;
   }
   // Send all pending entries to the server.
+  remoting.debug.log('Sending ' + this.pendingEntries.length + ' log ' +
+      ((this.pendingEntries.length == 1) ? 'entry' : 'entries') +
+      '  to the server.');
   var stanza = '<cli:iq to="remoting@bot.talk.google.com" type="set" ' +
       'xmlns:cli="jabber:client"><gr:log xmlns:gr="google:remoting">';
   while (this.pendingEntries.length > 0) {
     stanza += /** @type string */ this.pendingEntries.shift();
   }
   stanza += '</gr:log></cli:iq>';
-  remoting.debug.logIq(true, stanza);
   remoting.wcs.sendIq(stanza);
 };
 
 /**
  * Whether logging is enabled.
  *
  * @private
  * @return {boolean} whether logging is enabled
  */
 remoting.LogToServer.prototype.isEnabled = function() {
@@ skipping 30 matching lines @@
  * @return {string} an ID
  */
 remoting.LogToServer.prototype.generateId = function() {
   var idArray = [];
   for (var i = 0; i < this.ID_LEN_; i++) {
     var index = Math.random() * this.ID_ALPHABET_.length;
     idArray.push(this.ID_ALPHABET_.slice(index, index + 1));
   }
   return idArray.join('');
 };
+
+/**
+ * Sends a message describing a log entry to the debug log.
+ *
+ * @private
+ * @param {remoting.ServerLogEntry} entry
+ */
+remoting.LogToServer.prototype.logToConsole = function(entry) {
+  remoting.debug.logIndent(0, 'Queueing log entry:');
+  entry.toDebugLog(1)
+};

[Jamie, 2011/12/09 19:47:56]

This function looks like it's unused.

[simonmorris, 2011/12/09 21:12:12]

Done.