@webex/plugin-meetings 1.153.3 → 1.154.2

package/src/meeting/index.js

@@ -56,7 +56,7 @@ import {
   MEETING_STATE,
   MEETINGS,
   METRICS_JOIN_TIMES_MAX_DURATION,
-  METRICS_OPERATIONAL_MEASURES,
+  BEHAVIORAL_METRICS,
   MQA_STATS,
   NETWORK_STATUS,
   ONLINE,
@@ -1057,8 +1057,8 @@ export default class Meeting extends StatelessWebexPlugin {
       // https:// jira-eng-gpk2.cisco.com/jira/browse/SPARK-240520
       // TODO: send custom parameter explaining why the inactivity happened
       // refresh , no media or network got dsconnected or something else
-      Metrics.sendOperationalMetric(
-        METRICS_OPERATIONAL_MEASURES.DISCONNECT_DUE_TO_INACTIVITY,
+      Metrics.sendBehavioralMetric(
+        BEHAVIORAL_METRICS.DISCONNECT_DUE_TO_INACTIVITY,
         {
           correlation_id: this.correlationId,
           locus_id: this.locusId
@@ -1950,8 +1950,8 @@ export default class Meeting extends StatelessWebexPlugin {
     });
 
     this.locusInfo.on(LOCUSINFO.EVENTS.MEDIA_INACTIVITY, () => {
-      Metrics.sendOperationalMetric(
-        METRICS_OPERATIONAL_MEASURES.MEETING_MEDIA_INACTIVE,
+      Metrics.sendBehavioralMetric(
+        BEHAVIORAL_METRICS.MEETING_MEDIA_INACTIVE,
         {
           correlation_id: this.correlationId,
           locus_id: this.locusId
@@ -2344,15 +2344,19 @@ export default class Meeting extends StatelessWebexPlugin {
    * @memberof Meeting
    */
   parseMeetingInfo(meetingInfo) {
+    const webexMeetingInfo = meetingInfo?.body;
+
     // MeetingInfo will be undefined for 1:1 calls
-    if (meetingInfo && meetingInfo.body && !(meetingInfo.errors && meetingInfo.errors.length > 0)) {
-      this.conversationUrl = meetingInfo.body.conversationUrl || this.conversationUrl;
-      this.locusUrl = meetingInfo.body.locusUrl || this.locusUrl;
-      this.setSipUri(this.config.experimental.enableUnifiedMeetings ? meetingInfo.body.sipUrl : meetingInfo.body.sipMeetingUri || this.sipUri);
+    if (webexMeetingInfo && !(meetingInfo.errors && meetingInfo.errors.length > 0)) {
+      this.conversationUrl = webexMeetingInfo.conversationUrl || this.conversationUrl;
+      this.locusUrl = webexMeetingInfo.locusUrl || this.locusUrl;
+      this.setSipUri(this.config.experimental.enableUnifiedMeetings ? webexMeetingInfo.sipUrl : webexMeetingInfo.sipMeetingUri || this.sipUri);
       if (this.config.experimental.enableUnifiedMeetings) {
-        this.meetingNumber = meetingInfo.body.meetingNumber;
+        this.meetingNumber = webexMeetingInfo.meetingNumber;
+        this.meetingJoinUrl = webexMeetingInfo.meetingJoinUrl;
       }
-      this.owner = meetingInfo.body.owner || meetingInfo.body.hostId || this.owner;
+      this.owner = webexMeetingInfo.owner || webexMeetingInfo.hostId || this.owner;
+      this.permissionToken = webexMeetingInfo.permissionToken;
     }
   }
 
@@ -2491,8 +2495,8 @@ export default class Meeting extends StatelessWebexPlugin {
         }
         else {
           trackMediaID = null;
-          Metrics.sendOperationalMetric(
-            METRICS_OPERATIONAL_MEASURES.MUTE_AUDIO_FAILURE,
+          Metrics.sendBehavioralMetric(
+            BEHAVIORAL_METRICS.MUTE_AUDIO_FAILURE,
             {
               correlation_id: this.correlationId,
               locus_id: this.locusUrl.split('/').pop()
@@ -2901,6 +2905,12 @@ export default class Meeting extends StatelessWebexPlugin {
           event: eventType.MERCURY_CONNECTION_RESTORED,
           meeting: this
         });
+        Metrics.sendBehavioralMetric(
+          BEHAVIORAL_METRICS.MERCURY_CONNECTION_RESTORED,
+          {
+            correlation_id: this.correlationId
+          }
+        );
       }
       this.hasWebsocketConnected = true;
     });
@@ -2911,8 +2921,8 @@ export default class Meeting extends StatelessWebexPlugin {
         event: eventType.MERCURY_CONNECTION_LOST,
         meeting: this
       });
-      Metrics.sendOperationalMetric(
-        METRICS_OPERATIONAL_MEASURES.MERCURY_CONNECTION_FAILURE,
+      Metrics.sendBehavioralMetric(
+        BEHAVIORAL_METRICS.MERCURY_CONNECTION_FAILURE,
         {
           correlation_id: this.correlationId
         }
@@ -2989,8 +2999,8 @@ export default class Meeting extends StatelessWebexPlugin {
           data: {trigger: trigger.USER_INTERACTION, mediaType: mediaType.AUDIO}
         });
       }).catch((error) => {
-        Metrics.sendOperationalMetric(
-          METRICS_OPERATIONAL_MEASURES.MUTE_AUDIO_FAILURE,
+        Metrics.sendBehavioralMetric(
+          BEHAVIORAL_METRICS.MUTE_AUDIO_FAILURE,
           {
             correlation_id: this.correlationId,
             locus_id: this.locusUrl.split('/').pop(),
@@ -3040,8 +3050,8 @@ export default class Meeting extends StatelessWebexPlugin {
           data: {trigger: trigger.USER_INTERACTION, mediaType: mediaType.AUDIO}
         });
       }).catch((error) => {
-        Metrics.sendOperationalMetric(
-          METRICS_OPERATIONAL_MEASURES.UNMUTE_AUDIO_FAILURE,
+        Metrics.sendBehavioralMetric(
+          BEHAVIORAL_METRICS.UNMUTE_AUDIO_FAILURE,
           {
             correlation_id: this.correlationId,
             locus_id: this.locusUrl.split('/').pop(),
@@ -3090,8 +3100,8 @@ export default class Meeting extends StatelessWebexPlugin {
           data: {trigger: trigger.USER_INTERACTION, mediaType: mediaType.VIDEO}
         });
       }).catch((error) => {
-        Metrics.sendOperationalMetric(
-          METRICS_OPERATIONAL_MEASURES.MUTE_VIDEO_FAILURE,
+        Metrics.sendBehavioralMetric(
+          BEHAVIORAL_METRICS.MUTE_VIDEO_FAILURE,
           {
             correlation_id: this.correlationId,
             locus_id: this.locusUrl.split('/').pop(),
@@ -3140,8 +3150,8 @@ export default class Meeting extends StatelessWebexPlugin {
           data: {trigger: trigger.USER_INTERACTION, mediaType: mediaType.VIDEO}
         });
       }).catch((error) => {
-        Metrics.sendOperationalMetric(
-          METRICS_OPERATIONAL_MEASURES.UNMUTE_VIDEO_FAILURE,
+        Metrics.sendBehavioralMetric(
+          BEHAVIORAL_METRICS.UNMUTE_VIDEO_FAILURE,
           {
             correlation_id: this.correlationId,
             locus_id: this.locusUrl.split('/').pop(),
@@ -3203,8 +3213,8 @@ export default class Meeting extends StatelessWebexPlugin {
       .catch((error) => {
         LoggerProxy.logger.error('Meeting:index#joinWithMedia --> ', error);
 
-        Metrics.sendOperationalMetric(
-          METRICS_OPERATIONAL_MEASURES.JOIN_WITH_MEDIA_FAILURE,
+        Metrics.sendBehavioralMetric(
+          BEHAVIORAL_METRICS.JOIN_WITH_MEDIA_FAILURE,
           {
             correlation_id: this.correlationId,
             locus_id: this.locusUrl.split('/').pop(),
@@ -3293,8 +3303,8 @@ export default class Meeting extends StatelessWebexPlugin {
 
         LoggerProxy.logger.error('Meeting:index#reconnect --> Meeting reconnect failed', error);
 
-        Metrics.sendOperationalMetric(
-          METRICS_OPERATIONAL_MEASURES.MEETING_RECONNECT_FAILURE,
+        Metrics.sendBehavioralMetric(
+          BEHAVIORAL_METRICS.MEETING_RECONNECT_FAILURE,
           {
             correlation_id: this.correlationId,
             locus_id: this.locusUrl.split('/').pop(),
@@ -3359,8 +3369,8 @@ export default class Meeting extends StatelessWebexPlugin {
 
       this.triggerStopReceivingTranscriptionEvent();
 
-      Metrics.sendOperationalMetric(
-        METRICS_OPERATIONAL_MEASURES.RECEIVE_TRANSCRIPTION_FAILURE,
+      Metrics.sendBehavioralMetric(
+        BEHAVIORAL_METRICS.RECEIVE_TRANSCRIPTION_FAILURE,
         {
           correlation_id: this.correlationId,
           reason: 'unexpected error: transcription LLM web socket connection error had occured.',
@@ -3423,8 +3433,8 @@ export default class Meeting extends StatelessWebexPlugin {
     }
     catch (error) {
       LoggerProxy.logger.error(`Meeting:index#receiveTranscription --> ${error}`);
-      Metrics.sendOperationalMetric(
-        METRICS_OPERATIONAL_MEASURES.RECEIVE_TRANSCRIPTION_FAILURE,
+      Metrics.sendBehavioralMetric(
+        BEHAVIORAL_METRICS.RECEIVE_TRANSCRIPTION_FAILURE,
         {
           correlation_id: this.correlationId,
           reason: error.message,
@@ -3516,13 +3526,6 @@ export default class Meeting extends StatelessWebexPlugin {
       data: {trigger: trigger.USER_INTERACTION}
     });
 
-    Metrics.sendOperationalMetric(
-      METRICS_OPERATIONAL_MEASURES.JOIN_ATTEMPT,
-      {
-        correlation_id: this.correlationId
-      }
-    );
-
     LoggerProxy.logger.log('Meeting:index#join --> Joining a meeting');
 
     if (this.meetingFiniteStateMachine.state === MEETING_STATE_MACHINE.STATES.ENDED) {
@@ -3593,6 +3596,12 @@ export default class Meeting extends StatelessWebexPlugin {
       .then((join) => {
         joinSuccess(join);
         this.deferJoin = undefined;
+        Metrics.sendBehavioralMetric(
+          BEHAVIORAL_METRICS.JOIN_SUCCESS,
+          {
+            correlation_id: this.correlationId
+          }
+        );
 
         return join;
       }).then(async (join) => {
@@ -3616,8 +3625,8 @@ export default class Meeting extends StatelessWebexPlugin {
         LoggerProxy.logger.error('Meeting:index#join --> Failed', error);
 
         // TODO:  change this to error codes and pre defined dictionary
-        Metrics.sendOperationalMetric(
-          METRICS_OPERATIONAL_MEASURES.JOIN_FAILURE,
+        Metrics.sendBehavioralMetric(
+          BEHAVIORAL_METRICS.JOIN_FAILURE,
           {
             correlation_id: this.correlationId,
             reason: error.error?.message,
@@ -3690,8 +3699,8 @@ export default class Meeting extends StatelessWebexPlugin {
     }).then((res) => {
       this.locusInfo.onFullLocus(res.body.locus);
     }).catch((error) => {
-      Metrics.sendOperationalMetric(
-        METRICS_OPERATIONAL_MEASURES.ADD_DIAL_IN_FAILURE,
+      Metrics.sendBehavioralMetric(
+        BEHAVIORAL_METRICS.ADD_DIAL_IN_FAILURE,
         {
           correlation_id: this.correlationId,
           dial_in_url: this.dialInUrl,
@@ -3729,8 +3738,8 @@ export default class Meeting extends StatelessWebexPlugin {
     }).then((res) => {
       this.locusInfo.onFullLocus(res.body.locus);
     }).catch((error) => {
-      Metrics.sendOperationalMetric(
-        METRICS_OPERATIONAL_MEASURES.ADD_DIAL_OUT_FAILURE,
+      Metrics.sendBehavioralMetric(
+        BEHAVIORAL_METRICS.ADD_DIAL_OUT_FAILURE,
         {
           correlation_id: this.correlationId,
           dial_out_url: this.dialOutUrl,
@@ -3956,10 +3965,10 @@ export default class Meeting extends StatelessWebexPlugin {
           )
             .catch((error) => {
               // Whenever there is a failure when trying to access a user's device
-              // report it as an operational metric
+              // report it as an Behavioral metric
               // This gives visibility into common errors and can help
               // with further troubleshooting
-              const metricName = METRICS_OPERATIONAL_MEASURES.GET_USER_MEDIA_FAILURE;
+              const metricName = BEHAVIORAL_METRICS.GET_USER_MEDIA_FAILURE;
               const data = {
                 correlation_id: this.correlationId,
                 locus_id: this.locusUrl?.split('/').pop(),
@@ -3970,7 +3979,7 @@ export default class Meeting extends StatelessWebexPlugin {
                 type: error.name
               };
 
-              Metrics.sendOperationalMetric(metricName, data, metadata);
+              Metrics.sendBehavioralMetric(metricName, data, metadata);
               throw new MediaError('Unable to retrieve media streams', error);
             }));
     }
@@ -4098,8 +4107,8 @@ export default class Meeting extends StatelessWebexPlugin {
         .catch((error) => {
           LoggerProxy.logger.error(`${LOG_HEADER} Error adding media , setting up peerconnection, `, error);
 
-          Metrics.sendOperationalMetric(
-            METRICS_OPERATIONAL_MEASURES.ADD_MEDIA_FAILURE,
+          Metrics.sendBehavioralMetric(
+            BEHAVIORAL_METRICS.ADD_MEDIA_FAILURE,
             {
               correlation_id: this.correlationId,
               locus_id: this.locusUrl.split('/').pop(),
@@ -4182,6 +4191,14 @@ export default class Meeting extends StatelessWebexPlugin {
             this.floorGrantPending = true;
           }
 
+          Metrics.sendBehavioralMetric(
+            BEHAVIORAL_METRICS.ADD_MEDIA_SUCCESS,
+            {
+              correlation_id: this.correlationId,
+              locus_id: this.locusUrl.split('/').pop()
+            }
+          );
+
           return Promise.resolve();
         }))
       .catch((error) => {
@@ -4197,8 +4214,8 @@ export default class Meeting extends StatelessWebexPlugin {
 
         LoggerProxy.logger.error(`${LOG_HEADER} Error adding media failed to initiate PC and send request, `, error);
 
-        Metrics.sendOperationalMetric(
-          METRICS_OPERATIONAL_MEASURES.ADD_MEDIA_FAILURE,
+        Metrics.sendBehavioralMetric(
+          BEHAVIORAL_METRICS.ADD_MEDIA_FAILURE,
           {
             correlation_id: this.correlationId,
             locus_id: this.locusUrl.split('/').pop(),
@@ -4351,8 +4368,8 @@ export default class Meeting extends StatelessWebexPlugin {
         .catch((error) => {
           LoggerProxy.logger.error(`${LOG_HEADER} Error updatedMedia, `, error);
 
-          Metrics.sendOperationalMetric(
-            METRICS_OPERATIONAL_MEASURES.UPDATE_MEDIA_FAILURE,
+          Metrics.sendBehavioralMetric(
+            BEHAVIORAL_METRICS.UPDATE_MEDIA_FAILURE,
             {
               correlation_id: this.correlationId,
               locus_id: this.locusUrl.split('/').pop(),
@@ -4750,8 +4767,8 @@ export default class Meeting extends StatelessWebexPlugin {
           EVENTS.REQUEST_UPLOAD_LOGS,
           this
         );
-        Metrics.sendOperationalMetric(
-          METRICS_OPERATIONAL_MEASURES.MEETING_LEAVE_FAILURE,
+        Metrics.sendBehavioralMetric(
+          BEHAVIORAL_METRICS.MEETING_LEAVE_FAILURE,
           {
             correlation_id: this.correlationId,
             locus_id: this.locusUrl.split('/').pop(),
@@ -4804,8 +4821,8 @@ export default class Meeting extends StatelessWebexPlugin {
         .catch((error) => {
           LoggerProxy.logger.error('Meeting:index#startWhiteboardShare --> Error ', error);
 
-          Metrics.sendOperationalMetric(
-            METRICS_OPERATIONAL_MEASURES.MEETING_START_WHITEBOARD_SHARE_FAILURE,
+          Metrics.sendBehavioralMetric(
+            BEHAVIORAL_METRICS.MEETING_START_WHITEBOARD_SHARE_FAILURE,
             {
               correlation_id: this.correlationId,
               locus_id: this.locusUrl.split('/').pop(),
@@ -4844,8 +4861,8 @@ export default class Meeting extends StatelessWebexPlugin {
         .catch((error) => {
           LoggerProxy.logger.error('Meeting:index#stopWhiteboardShare --> Error ', error);
 
-          Metrics.sendOperationalMetric(
-            METRICS_OPERATIONAL_MEASURES.STOP_WHITEBOARD_SHARE_FAILURE,
+          Metrics.sendBehavioralMetric(
+            BEHAVIORAL_METRICS.STOP_WHITEBOARD_SHARE_FAILURE,
             {
               correlation_id: this.correlationId,
               locus_id: this.locusUrl.split('/').pop(),
@@ -4891,8 +4908,8 @@ export default class Meeting extends StatelessWebexPlugin {
         .catch((error) => {
           LoggerProxy.logger.error('Meeting:index#share --> Error ', error);
 
-          Metrics.sendOperationalMetric(
-            METRICS_OPERATIONAL_MEASURES.MEETING_SHARE_FAILURE,
+          Metrics.sendBehavioralMetric(
+            BEHAVIORAL_METRICS.MEETING_SHARE_FAILURE,
             {
               correlation_id: this.correlationId,
               locus_id: this.locusUrl.split('/').pop(),
@@ -4954,8 +4971,8 @@ export default class Meeting extends StatelessWebexPlugin {
         .catch((error) => {
           LoggerProxy.logger.error('Meeting:index#stopFloorRequest --> Error ', error);
 
-          Metrics.sendOperationalMetric(
-            METRICS_OPERATIONAL_MEASURES.STOP_FLOOR_REQUEST_FAILURE,
+          Metrics.sendBehavioralMetric(
+            BEHAVIORAL_METRICS.STOP_FLOOR_REQUEST_FAILURE,
             {
               correlation_id: this.correlationId,
               locus_id: this.locusUrl.split('/').pop(),
@@ -5273,8 +5290,8 @@ export default class Meeting extends StatelessWebexPlugin {
 
         LoggerProxy.logger.error(`Meeting:index#setMeetingQuality --> ${error.message}`);
 
-        Metrics.sendOperationalMetric(
-          METRICS_OPERATIONAL_MEASURES.SET_MEETING_QUALITY_FAILURE,
+        Metrics.sendBehavioralMetric(
+          BEHAVIORAL_METRICS.SET_MEETING_QUALITY_FAILURE,
           {
             correlation_id: this.correlationId,
             locus_id: this.locusUrl.split('/').pop(),
@@ -5317,13 +5334,13 @@ export default class Meeting extends StatelessWebexPlugin {
       }))
       .catch((error) => {
         // Whenever there is a failure when trying to access a user's display
-        // report it as an operational metric
+        // report it as an Behavioral metric
         // This gives visibility into common errors and can help
         // with further troubleshooting
 
         // This metrics will get erros for getDisplayMedia and share errors for now
         // TODO: The getDisplayMedia errors need to be moved inside `media.getDisplayMedia`
-        const metricName = METRICS_OPERATIONAL_MEASURES.GET_DISPLAY_MEDIA_FAILURE;
+        const metricName = BEHAVIORAL_METRICS.GET_DISPLAY_MEDIA_FAILURE;
         const data = {
           correlation_id: this.correlationId,
           locus_id: this.locusUrl.split('/').pop(),
@@ -5334,7 +5351,7 @@ export default class Meeting extends StatelessWebexPlugin {
           type: error.name
         };
 
-        Metrics.sendOperationalMetric(metricName, data, metadata);
+        Metrics.sendBehavioralMetric(metricName, data, metadata);
         throw new MediaError('Unable to retrieve display media stream', error);
       });
   }

package/src/meeting/request.js

@@ -50,8 +50,9 @@ export default class MeetingRequest extends StatelessWebexPlugin {
   async joinMeeting(options) {
     const {
       asResourceOccupant,
-      sipUri,
+      inviteeAddress,
       meetingNumber,
+      permissionToken,
       deviceUrl,
       locusUrl,
       resourceId,
@@ -98,6 +99,10 @@ export default class MeetingRequest extends StatelessWebexPlugin {
       body.moderator = moderator;
     }
 
+    if (permissionToken) {
+      body.permissionToken = permissionToken;
+    }
+
     if (pin !== undefined) {
       body.pin = pin;
     }
@@ -105,16 +110,16 @@ export default class MeetingRequest extends StatelessWebexPlugin {
     if (locusUrl) {
       url = `${locusUrl}/${PARTICIPANT}`;
     }
-    else if (sipUri || meetingNumber) {
+    else if (inviteeAddress || meetingNumber) {
       try {
         await this.webex.internal.services.waitForCatalog('postauth');
         url = `${this.webex.internal.services.get('locus')}/${LOCI}/${CALL}`;
         body.invitee = {
-          address: sipUri || `wbxmn:${meetingNumber}`
+          address: inviteeAddress || `wbxmn:${meetingNumber}`
         };
       }
       catch (e) {
-        LoggerProxy.logger.error(`Meeting:request#joinMeeting ${sipUri ? 'sipUri' : 'meetingNumber'} --> ${e}`);
+        LoggerProxy.logger.error(`Meeting:request#joinMeeting Error Joining ${inviteeAddress || meetingNumber} --> ${e}`);
         throw (e);
       }
     }
@@ -123,7 +128,7 @@ export default class MeetingRequest extends StatelessWebexPlugin {
     // TODO: -- this will be resolved in SDK request
     url = url.concat(`?${ALTERNATE_REDIRECT_TRUE}`);
 
-    if (resourceId === sipUri) {
+    if (resourceId === inviteeAddress) {
       body.callPreferences = {
         requestedMedia: [_SLIDES_]
       };

package/src/meeting/util.js

@@ -90,12 +90,13 @@ MeetingUtil.joinMeeting = (meeting, options) => {
   // if Joining state termintate the request as user might click multiple times
   return meeting.meetingRequest
     .joinMeeting({
-      sipUri: meeting.sipUri,
+      inviteeAddress: meeting.meetingJoinUrl || meeting.sipUri,
       meetingNumber: meeting.meetingNumber,
       deviceUrl: meeting.deviceUrl,
       locusUrl: meeting.locusUrl,
       correlationId: meeting.correlationId,
       roapMessage: options.roapMessage,
+      permissionToken: meeting.permissionToken,
       resourceId: options.resourceId || null,
       moderator: options.moderator,
       pin: options.pin,

package/src/meetings/index.js

@@ -38,7 +38,7 @@ import {
   MEETING_REMOVED_REASON,
   _CONVERSATION_URL_,
   CONVERSATION_URL,
-  METRICS_OPERATIONAL_MEASURES
+  BEHAVIORAL_METRICS
 } from '../constants';
 import MeetingInfo from '../meeting-info';
 import MeetingInfoV2 from '../meeting-info/meeting-info-v2';
@@ -456,10 +456,21 @@ export default class Meetings extends WebexPlugin {
           EVENT_TRIGGERS.MEETINGS_REGISTERED
         );
         this.registered = true;
+        Metrics.sendBehavioralMetric(
+          BEHAVIORAL_METRICS.MEETINGS_REGISTRATION_SUCCESS,
+        );
       })
         .catch((error) => {
           LoggerProxy.logger.error(`Meetings:index#register --> ERROR, Unable to register, ${error.message}`);
 
+          Metrics.sendBehavioralMetric(
+            BEHAVIORAL_METRICS.MEETINGS_REGISTRATION_FAILED,
+            {
+              reason: error.message,
+              stack: error.stack
+            }
+          );
+
           return Promise.reject(error);
         });
     }
@@ -542,8 +553,8 @@ export default class Meetings extends WebexPlugin {
             }
           );
 
-          Metrics.sendOperationalMetric(
-            METRICS_OPERATIONAL_MEASURES.UPLOAD_LOGS_FAILURE,
+          Metrics.sendBehavioralMetric(
+            BEHAVIORAL_METRICS.UPLOAD_LOGS_FAILURE,
             {
               meetingId: options.meetingsId,
               reason: uploadError.message,

package/src/metrics/config.js

@@ -320,3 +320,4 @@ export const OS_NAME = {
 };
 
 export const CLIENT_NAME = 'webex-js-sdk';
+export const PLATFORM = 'Web';

package/src/metrics/index.js

@@ -14,7 +14,7 @@ import BrowserDetection from '../common/browser-detection';
 
 import {
   error, eventType, errorCodes as ERROR_CODE, OS_NAME, UNKNOWN, CLIENT_NAME,
-  mediaType
+  mediaType, PLATFORM
 } from './config';
 
 const OSMap = {
@@ -489,11 +489,11 @@ class Metrics {
   }
 
   /**
-   * Uploads given metric to the Metrics service as an operational metric.
+   * Uploads given metric to the Metrics service as an Behavioral metric.
    * Metadata about the environment such as browser, OS, SDK and their versions
    * are automatically added when the metric is sent.
    *
-   * The Metrics service will send an operational metric to InfluxDB for
+   * The Metrics service will send an Behavioral metric to InfluxDB for
    * aggregation.
    * See https://confluence-eng-gpk2.cisco.com/conf/display/WBXT/Getting+started+with+Metrics+Service.
    *
@@ -503,12 +503,24 @@ class Metrics {
    *
    * @returns {void}
    */
-  sendOperationalMetric(metricName, metricFields = {}, metricTags = {}) {
+  sendBehavioralMetric(metricName, metricFields = {}, metricTags = {}) {
     const fields = {
       ...metricFields,
       browser_version: getBrowserVersion(),
       os_version: getOSVersion(),
-      sdk_version: this.webex.version
+      sdk_version: this.webex.version,
+      platform: PLATFORM
+    };
+
+    const context = {
+      app: {
+        version: this.webex.version
+      },
+      locale: 'en-US',
+      os: {
+        name: getOSName(),
+        version: getOSVersion()
+      }
     };
 
     const tags = {
@@ -517,17 +529,19 @@ class Metrics {
       org_id: this.webex.credentials.getOrgId(),
       os: getOSName(),
       domain: window.location.hostname,
-      client_id: this.webex.credentials.config.client_id
+      client_id: this.webex.credentials.config.client_id,
+      user_id: this.webex.internal.device.userId
     };
 
     if (!metricName) {
-      throw Error('Missing operational metric name. Please provide one');
+      throw Error('Missing behavioral metric name. Please provide one');
     }
 
     this.webex.internal.metrics.submitClientMetrics(metricName, {
-      type: ['operational'],
+      type: ['behavioral', 'operational'],
       fields,
-      tags
+      tags,
+      context
     });
   }
 }