Merge pull request #320 from jitsi/log_collector

Log collector

JitsiConferenceEventManager.js

@@ -548,6 +548,11 @@ JitsiConferenceEventManager.prototype.setupStatisticsListeners = function () {
 
         conference.rtc.setAudioLevel(resource, level);
     });
+    // Forward the "before stats disposed" event
+    conference.statistics.addBeforeDisposedListener(function () {
+        conference.eventEmitter.emit(
+            JitsiConferenceEvents.BEFORE_STATISTICS_DISPOSED);
+    });
     conference.statistics.addConnectionStatsListener(function (stats) {
         var ssrc2resolution = stats.resolution;
 

JitsiConferenceEvents.js

@@ -14,6 +14,14 @@ export const AVAILABLE_DEVICES_CHANGED = "conference.availableDevicesChanged";
  * A participant avatar has changed.
  */
 export const AVATAR_CHANGED = "conference.avatarChanged";
+
+/**
+ * Fired just before the statistics module is disposed and it's the last chance
+ * to submit some logs to the statistics service (ex. CallStats if enabled),
+ * before it's disconnected.
+ */
+export const BEFORE_STATISTICS_DISPOSED = "conference.beforeStatisticsDisposed";
+
 /**
  * Indicates that an error occured.
  */

JitsiMeetJS.js

@@ -142,6 +142,32 @@ var LibJitsiMeet = {
     setLogLevel: function (level) {
         Logger.setLogLevel(level);
     },
+    /**
+     * Sets the log level to the <tt>Logger</tt> instance with given id.
+     * @param {Logger.levels} level the logging level to be set
+     * @param {string} id the logger id to which new logging level will be set.
+     * Usually it's the name of the JavaScript source file including the path
+     * ex. "modules/xmpp/ChatRoom.js"
+     */
+    setLogLevelById: function (level, id) {
+        Logger.setLogLevelById(level, id);
+    },
+    /**
+     * Registers new global logger transport to the library logging framework.
+     * @param globalTransport
+     * @see Logger.addGlobalTransport
+     */
+    addGlobalLogTransport: function (globalTransport) {
+        Logger.addGlobalTransport(globalTransport);
+    },
+    /**
+     * Removes global logging transport from the library logging framework.
+     * @param globalTransport
+     * @see Logger.removeGlobalTransport
+     */
+    removeGlobalLogTransport: function (globalTransport) {
+        Logger.removeGlobalTransport(globalTransport);
+    },
     /**
      * Creates the media tracks and returns them trough the callback.
      * @param options Object with properties / settings specifying the tracks which should be created.

doc/API.md

@@ -121,6 +121,7 @@ JitsiMeetJS.setLogLevel(JitsiMeetJS.logLevels.ERROR);
         - STARTED_MUTED - notifies that the local user has started muted
         - AVAILABLE_DEVICES_CHANGED - notifies that available participant devices changed (camera or microphone was added or removed) (parameters - id(string), devices(JS object with 2 properties - audio(boolean), video(boolean)))
         - CONNECTION_STATS - New local connection statistics are received. (parameters - stats(object))
+        - BEFORE_STATISTICS_DISPOSED - fired just before the statistics module is disposed and it's the last chance to submit some logs to the statistics service, before it gets disconnected
         - AUTH_STATUS_CHANGED - notifies that authentication is enabled or disabled, or local user authenticated (logged in). (parameters - isAuthEnabled(boolean), authIdentity(string))
         - ENDPOINT_MESSAGE_RECEIVED - notifies that a new message
         from another participant is received on a data channel.

modules/statistics/statistics.js

@@ -144,6 +144,15 @@ Statistics.prototype.removeAudioLevelListener = function(listener) {
     this.eventEmitter.removeListener(StatisticsEvents.AUDIO_LEVEL, listener);
 };
 
+Statistics.prototype.addBeforeDisposedListener = function (listener) {
+    this.eventEmitter.on(StatisticsEvents.BEFORE_DISPOSED, listener);
+};
+
+Statistics.prototype.removeBeforeDisposedListener = function (listener) {
+    this.eventEmitter.removeListener(
+        StatisticsEvents.BEFORE_DISPOSED, listener);
+};
+
 Statistics.prototype.addConnectionStatsListener = function (listener) {
     this.eventEmitter.on(StatisticsEvents.CONNECTION_STATS, listener);
 };
@@ -162,6 +171,9 @@ Statistics.prototype.removeByteSentStatsListener = function (listener) {
 };
 
 Statistics.prototype.dispose = function () {
+    if (this.eventEmitter) {
+        this.eventEmitter.emit(StatisticsEvents.BEFORE_DISPOSED);
+    }
     this.stopCallStats();
     this.stopRemoteStats();
     if(this.eventEmitter)

service/statistics/Events.js

@@ -10,6 +10,13 @@
  */
 export const AUDIO_LEVEL = "statistics.audioLevel";
 
+/**
+ * An event fired just before the statistics module gets disposes and it's
+ * the last chance to submit some logs that will end up in stats services like
+ * CallStats (if enabled).
+ */
+export const BEFORE_DISPOSED = "statistics.before_disposed";
+
 /**
  * An event carrying all statistics by ssrc.
  */