ljm_j1/service/statistics/AnalyticsEvents.js

/**
 * Note that an event's own properties and its permanent properties are
 * are merged in one object. Because of this an event should never use
 * properties with names that are already used by permanent properties
 * (unless the intention is to override a permanent property). Here is a
 * (non-exhaustive) list of currently know permanent properties:
 *
 * abtestSuspendVideo
 * browserName
 * callstatsname
 * crossRegion
 * forceJvb121
 * region
 * roomName
 * shard
 * size
 * userAgent
 * userRegion
 *
 * The naming convention for the constants below uses "_" as a prefix or
 * suffix to indicate that known usage of the constant prepends or appends
 * a string to the name of the event.
 */

/**
 * Properties: value
 *
 * TODO: document, reformat
 *
 * Full event names (uncertain):
 * conference.muc.joined (???)
 * conference.sharingDesktop.start (???)
 * conference.sharingDesktop.stop (???)
 * xmpp.attached (???)
 * xmpp.attaching (???)
 * xmpp.connected (???)
 * xmpp.connecting (???)
 * xmpp.session-initiate (???)
 */
export const _CONNECTION_TIMES_ = '';

/**
 * TODO: document, reformat (group together with other ICE events)
 *
 * Known full event names:
 * ice.initiator.checksDuration
 * ice.responder.checksDuration
 * p2p.ice.initiator.checksDuration
 * p2p.ice.responder.checksDuration
 *
 * Properties: value
 */
export const _ICE_CHECKING_DURATION = 'checksDuration';

/**
 * TODO: document, reformat
 *
 * Known full event names:
 * ice.checking
 * ice.closed
 * ice.completed
 * ice.connected
 * ice.disconnected
 * ice.failed
 * p2p.ice.checking
 * p2p.ice.closed
 * p2p.ice.completed
 * p2p.ice.connected
 * p2p.ice.disconnected
 * p2p.ice.failed
 *
 * Properties: value
 */
export const _ICE_CONNECTION_STATE_ = 'ice';

/**
 * TODO: document, reformat (group together with other ICE events)
 *
 * Known full event names:
 * ice.initiator.establishmentDuration
 * ice.responder.establishmentDuration
 * p2p.ice.initiator.establishmentDuration
 * p2p.ice.responder.establishmentDuration
 *
 * Properties: value
 */
export const _ICE_ESTABLISHMENT_DURATION = 'establishmentDuration';

/**
 * TODO: document, reformat
 *
 * Known full event names:
 * ice.initiator.gatheringDuration
 * ice.responder.gatheringDuration
 * p2p.ice.initiator.gatheringDuration
 * p2p.ice.responder.gatheringDuration
 *
 * Properties: value
 */
export const _ICE_GATHERING_DURATION = 'gatheringDuration';

/**
 * TODO: document, reformat
 *
 * Known full event names:
 * audio.no_data_from_source
 * video.no_data_from_source
 */
export const _NO_DATA_FROM_SOURCE = 'no_data_from_source';

/**
 * TODO: document, reformat
 *
 * Known full event names:
 * audio.track_unmute
 * video.track_unmute
 */
export const _TRACK_UNMUTE = 'track_unmute';

/**
 * TODO: document, reformat
 *
 * TTMF: Time To First Media
 *
 * Known full event names:
 * audio.ttfm
 * video.ttfm
 * audio.ttfm.muted
 * video.ttfm.muted
 */
export const _TTFM_ = 'ttfm';

/**
 * All average RTP stats are currently reported under 1 event name, but with
 * different properties that allows to distinguish between a P2P call, a
 * call relayed through TURN or the JVB, and multiparty vs 1:1.
 * Example structure of an "avg.rtp.stats" analytics event:
 *
 * {
     *   p2p: true,
     *   conferenceSize: 2,
     *   localCandidateType: "relay",
     *   remoteCandidateType: "relay",
     *   transportType: "udp",
     *
     *   "stat_avg_rtt": {
     *     value: 200,
     *     samples: [ 100, 200, 300 ]
     *   },
     *   "stat_avg_packetloss_total": {
     *     value: 10,
     *     samples: [ 5, 10, 15]
     *   }
     * }
 *
 * Note that the samples array is currently emitted for debug purposes only
 * and can be removed anytime soon from the structure.
 *
 * Also not all values are always present in "avg.rtp.stats", some of the
 * values are obtained and calculated as part of different process/event
 * pipe. For example {@link ConnectionAvgStats} instances are doing the
 * reports for each {@link TraceablePeerConnection} and work independently
 * from the main stats pipe.
 */
export const AVG_RTP_STATS = 'avg.rtp.stats';

/**
 * Properties: none
 *
 * TODO: document, deprecate?
 */
export const BRIDGE_DOWN = 'conference.bridgeDown';

/**
 * Properties: none
 *
 * Known full event names:
 * conference.error.p2pSessionAcceptTimeout
 * conference.error.sessionAcceptTimeout
 *
 * TODO: document, reformat
 */
export const CONFERENCE_ERROR_ = 'conference.error';

/**
 * Properties: none
 *
 * TODO: document
 */
export const CONNECTION_INTERRUPTED = 'connection.interrupted';

/**
 * Properties: none
 *
 * Known full event names: NONE
 *
 * TODO: document, reformat?, deprecate?
 */
export const CONNECTION_DISCONNECTED_ = 'connection.disconnected';

/**
 * Properties: label
 *
 * Known full event names:
 * connection.failed.connection.droppedError
 * connection.failed.connection.otherError
 * connection.failed.connection.passwordRequired
 *
 * TODO: document, reformat
 */
export const CONNECTION_FAILED_ = 'connection.failed';

/**
 * Properties: none
 *
 * TODO: document
 */
export const CONNECTION_RESTORED = 'connection.restored';

/**
 * Properties: value
 *
 * TODO: document, deprecate (is it the same as the one which is part of
 * CONNECTION_TIMES?)
 */
export const DATA_CHANNEL_OPEN = 'conference.dataChannel.open';

/**
 * TODO: document, reformat
 */
export const DEVICE_LIST = 'devices.deviceList';

/**
 * User feedback event.
 * Properties: value, detailed
 *
 * TODO: document
 */
export const FEEDBACK = 'feedback.rating';

/**
 * Properties: none
 *
 * TODO: document
 */
export const FOCUS_LEFT = 'conference.focusLeft';

/**
 * Properties: none
 *
 * Known full event names:
 * getUserMedia.deviceNotFound.audio
 * getUserMedia.deviceNotFound.audio.video
 * getUserMedia.deviceNotFound.video
 * getUserMedia.deviceNotFound.screen
 *
 * TODO: document, reformat, merge with GET_USER_MEDIA_FAILED?
 */
export const GET_USER_MEDIA_DEVICE_NOT_FOUND_
    = 'getUserMedia.deviceNotFound';

/**
 * Properties: none
 *
 * Known full event names:
 * getUserMedia.fail.resolution.180
 * getUserMedia.fail.resolution.360
 * getUserMedia.fail.resolution.640
 * getUserMedia.fail.resolution.720
 * getUserMedia.fail.resolution.960
 *
 * TODO: reformat, merge with GET_USER_MEDIA_FAILED
 */
export const GET_USER_MEDIA_FAIL_ = 'getUserMedia.fail';

/**
 * Properties: value
 *
 * Known full event names:
 * getUserMedia.failed.Error
 * getUserMedia.failed.TypeError
 * getUserMedia.failed.audio.TypeError
 * getUserMedia.failed.audio.gum.general
 * getUserMedia.failed.audio.gum.permission_denied
 * getUserMedia.failed.audio.track.no_data_from_source
 * getUserMedia.failed.audio.video.180.gum.general
 * getUserMedia.failed.audio.video.360.gum.general
 * getUserMedia.failed.audio.video.360.gum.permission_denied
 * getUserMedia.failed.audio.video.360.track.no_data_from_source
 * getUserMedia.failed.audio.video.720.TypeError
 * getUserMedia.failed.audio.video.720.gum.constraint_failed
 * getUserMedia.failed.audio.video.720.gum.general
 * getUserMedia.failed.audio.video.720.gum.permission_denied
 * getUserMedia.failed.audio.video.720.track.no_data_from_source
 * getUserMedia.failed.audio.video.960.gum.permission_denied
 * getUserMedia.failed.audio.video.undefined.gum.general
 * getUserMedia.failed.desktop.TypeError
 * getUserMedia.failed.desktop.gum.chrome_extension_generic_error
 * getUserMedia.failed.desktop.gum.chrome_extension_installation_error
 * getUserMedia.failed.desktop.gum.chrome_extension_user_gesture_required
 * getUserMedia.failed.desktop.gum.general
 * getUserMedia.failed.desktop.track.no_data_from_source
 * getUserMedia.failed.gum.chrome_extension_generic_error
 * getUserMedia.failed.gum.chrome_extension_installation_error
 * getUserMedia.failed.gum.constraint_failed
 * getUserMedia.failed.gum.firefox_extension_needed
 * getUserMedia.failed.gum.general
 * getUserMedia.failed.gum.permission_denied
 * getUserMedia.failed.undefined
 * getUserMedia.failed.video.360.gum.permission_denied
 * getUserMedia.failed.video.720.TypeError
 * getUserMedia.failed.video.720.gum.constraint_failed
 * getUserMedia.failed.video.720.gum.general
 * getUserMedia.failed.video.720.gum.permission_denied
 * getUserMedia.failed.video.720.track.no_data_from_source
 * getUserMedia.failed.video.undefined.TypeError
 * getUserMedia.failed.video.undefined.gum.general
 * getUserMedia.failed.video.undefined.track.no_data_from_source
 *
 * TODO: reformat
 */
export const GET_USER_MEDIA_FAILED_ = 'getUserMedia.failed';

/**
 * Properties: value
 *
 * Known full event names:
 * getUserMedia.success
 * getUserMedia.success.audio
 * getUserMedia.success.audio.video.180
 * getUserMedia.success.audio.video.300
 * getUserMedia.success.audio.video.360
 * getUserMedia.success.audio.video.720
 * getUserMedia.success.audio.video.960
 * getUserMedia.success.audio.video.undefined
 * getUserMedia.success.desktop
 * getUserMedia.success.video.180
 * getUserMedia.success.video.360
 * getUserMedia.success.video.720
 * getUserMedia.success.video.960
 * getUserMedia.success.video.undefined
 *
 * TODO: document, reformat
 */
export const GET_USER_MEDIA_SUCCESS_ = 'getUserMedia.success';

/**
 * Properties: none
 *
 * Known full event names:
 * getUserMedia.userCancel.extensionInstall
 *
 * TODO: document, reformat
 */
export const GET_USER_MEDIA_USER_CANCEL_ = 'getUserMedia.userCancel';

/**
 * Properties: value
 *
 * The "value" property contains the difference in milliseconds between
 * the ICE establishment time for the P2P and JVB connections (e.g. a value
 * of 10 would indicate that the P2P was 10ms slower than JVB).
 */
export const ICE_ESTABLISHMENT_DURATION_DIFF
    = 'ice.establishmentDurationDiff';

/**
 * Properties: none
 *
 * TODO: document
 * TODO: do we need this in addition to _ICE_CONNECTION_STATE?
 */
export const ICE_FAILED = 'connection.ice_failed';

/**
 * Properties: none
 *
 * TODO: document
 */
export const P2P_ESTABLISHED = 'p2p.established';

/**
 * Properties: none
 *
 * TODO: document
 */
export const P2P_FAILED = 'p2p.failed';

/**
 * Properties: none
 *
 * TODO: document
 */
export const P2P_SWITCH_TO_JVB = 'p2p.switch_to_jvb';

/**
 * Properties: none
 *
 * TODO: document
 */
export const REMOTELY_MUTED = 'conference.remotelyMuted';

/**
 * Properties: value
 *
 * TODO: document
 *
 * The "value" property contains the delay in milliseconds between joining
 * the MUC and receiving a Jingle session-initiate from Jicofo (but not
 * P2P).
 */
export const SESSION_INITIATE = 'session.initiate';

/**
 * Properties: value
 *
 * TODO: document
 */
export const SESSION_INITIATE_RECEIVED = 'xmpp.session-initiate';

/**
 * Properties: none
 *
 * TODO: document
 */
export const SESSION_TERMINATE = 'session.terminate';

/**
 * Properties: none
 *
 * TODO: document
 */
export const SESSION_RESTART = 'session.restart';

/**
 * Properties: value
 *
 * TODO: document
 */
export const TRANSPORT_REPLACE_START = 'xmpp.transport-replace.start';

/**
 * Properties: value
 *
 * TODO: document
 */
export const TRANSPORT_REPLACE_SUCCESS = 'xmpp.transport-replace.success';