@webex/internal-plugin-metrics 3.5.0-next.2 → 3.5.0-next.21

package/dist/types/metrics.types.d.ts

@@ -8,8 +8,8 @@ export type NewEnvironmentType = NonNullable<RawEvent['origin']['newEnvironment'
 export type ClientLaunchMethodType = NonNullable<RawEvent['origin']['clientInfo']>['clientLaunchMethod'];
 export type BrowserLaunchMethodType = NonNullable<RawEvent['origin']['clientInfo']>['browserLaunchMethod'];
 export type MetricEventProduct = 'webex' | 'wxcc_desktop';
-export type MetricEventAgent = 'user' | 'browser' | 'system' | 'sdk' | 'redux' | 'service';
-export type MetricEventVerb = 'create' | 'get' | 'fetch' | 'update' | 'list' | 'delete' | 'select' | 'view' | 'set' | 'toggle' | 'load' | 'reload' | 'click' | 'hover' | 'register' | 'unregister' | 'enable' | 'disable' | 'use' | 'complete' | 'submit' | 'apply' | 'cancel' | 'abort' | 'sync' | 'login' | 'logout' | 'answer' | 'activate' | 'deactivate';
+export type MetricEventAgent = 'user' | 'browser' | 'system' | 'sdk' | 'redux' | 'service' | 'api';
+export type MetricEventVerb = 'abort' | 'accept' | 'activate' | 'apply' | 'answer' | 'authorize' | 'build' | 'cancel' | 'change' | 'click' | 'close' | 'complete' | 'connect' | 'create' | 'deactivate' | 'decrypt' | 'delete' | 'deliver' | 'destroy' | 'disable' | 'disconnect' | 'dismiss' | 'display' | 'download' | 'edit' | 'enable' | 'encrypt' | 'end' | 'expire' | 'fail' | 'fetch' | 'fire' | 'generate' | 'get' | 'hide' | 'hover' | 'ignore' | 'initialize' | 'initiate' | 'invalidate' | 'join' | 'list' | 'load' | 'login' | 'logout' | 'notify' | 'offer' | 'open' | 'press' | 'receive' | 'refer' | 'refresh' | 'register' | 'release' | 'reload' | 'reject' | 'request' | 'reset' | 'resize' | 'respond' | 'retry' | 'revoke' | 'save' | 'search' | 'select' | 'send' | 'set' | 'sign' | 'start' | 'submit' | 'switch' | 'sync' | 'toggle' | 'transfer' | 'unregister' | 'update' | 'upload' | 'use' | 'validate' | 'view' | 'visit' | 'wait' | 'warn' | 'exit';
 export type SubmitClientEventOptions = {
     meetingId?: string;
     mediaConnections?: any[];
@@ -55,6 +55,7 @@ export interface DeviceContext {
     };
 }
 export type MetricType = 'behavioral' | 'operational' | 'business';
+export type Table = 'wbxapp_callend_metrics' | 'business_metrics' | 'business_ucf' | 'default';
 type InternalEventPayload = string | number | boolean;
 export type EventPayload = Record<string, InternalEventPayload>;
 export type BehavioralEventPayload = EventPayload;
@@ -137,4 +138,18 @@ export type BuildClientEventFetchRequestOptions = (args: {
     options?: SubmitClientEventOptions;
 }) => Promise<any>;
 export type PreComputedLatencies = 'internal.client.pageJMT' | 'internal.download.time' | 'internal.get.cluster.time' | 'internal.click.to.interstitial' | 'internal.refresh.captcha.time' | 'internal.exchange.ci.token.time' | 'internal.get.u2c.time' | 'internal.call.init.join.req' | 'internal.other.app.api.time' | 'internal.api.fetch.intelligence.models';
+export interface IdType {
+    meetingId?: string;
+    callId?: string;
+}
+export interface IMetricsAttributes {
+    type: string;
+    version: string;
+    userId: string;
+    correlationId: string;
+    connectionId: string;
+    data: any[];
+    meetingId?: string;
+    callId?: string;
+}
 export {};

package/dist/types/new-metrics.d.ts

@@ -3,10 +3,11 @@ import CallDiagnosticMetrics from './call-diagnostic/call-diagnostic-metrics';
 import BehavioralMetrics from './behavioral-metrics';
 import OperationalMetrics from './operational-metrics';
 import BusinessMetrics from './business-metrics';
-import { RecursivePartial, MetricEventProduct, MetricEventAgent, MetricEventVerb, ClientEvent, FeatureEvent, EventPayload, MediaQualityEvent, InternalEvent, SubmitClientEventOptions } from './metrics.types';
+import { RecursivePartial, MetricEventProduct, MetricEventAgent, MetricEventVerb, ClientEvent, FeatureEvent, EventPayload, MediaQualityEvent, InternalEvent, SubmitClientEventOptions, Table } from './metrics.types';
 import CallDiagnosticLatencies from './call-diagnostic/call-diagnostic-metrics-latencies';
 /**
  * Metrics plugin to centralize all types of metrics.
+ * https://confluence-eng-gpk2.cisco.com/conf/pages/viewpage.action?pageId=231011379
  * @class
  */
 declare class Metrics extends WebexPlugin {
@@ -85,10 +86,11 @@ declare class Metrics extends WebexPlugin {
      * Buisness event
      * @param args
      */
-    submitBusinessEvent({ name, payload }: {
+    submitBusinessEvent({ name, payload, table, }: {
         name: string;
         payload: EventPayload;
-    }): void | Promise<void>;
+        table?: Table;
+    }): Promise<void>;
     /**
      * Call Analyzer: Media Quality Event
      * @param args

package/dist/types/rtcMetrics/constants.d.ts

@@ -0,0 +1,4 @@
+declare const RTC_METRICS: {
+    APP_ID: string;
+};
+export { RTC_METRICS as default };

package/dist/types/rtcMetrics/index.d.ts

@@ -0,0 +1,80 @@
+import { IdType } from '../metrics.types';
+/**
+ * Rtc Metrics
+ */
+export default class RtcMetrics {
+    /**
+     * Array of MetricData items to be sent to the metrics service.
+     */
+    metricsQueue: any[];
+    intervalId: number;
+    webex: any;
+    meetingId?: string;
+    callId?: string;
+    correlationId: string;
+    connectionId: string;
+    shouldSendMetricsOnNextStatsReport: boolean;
+    /**
+     * Initialize the interval.
+     *
+     * @param {object} webex - The main `webex` object.
+     * @param {IdType} Ids - Meeting or Calling id.
+     * @param {string} correlationId - The correlation id.
+     */
+    constructor(webex: any, { meetingId, callId }: IdType, correlationId: any);
+    /**
+     * Updates the call identifier with the provided value.
+     *
+     * @param {string} callId - The new call identifier to set.
+     * @returns {void}
+     */
+    updateCallId(callId: string): void;
+    /**
+     * Check to see if the metrics queue has any items.
+     *
+     * @returns {void}
+     */
+    sendMetricsInQueue(): void;
+    /**
+     * Forces sending metrics when we get the next stats-report
+     *
+     * This is useful for cases when something important happens that affects the media connection,
+     * for example when we move from lobby into the meeting.
+     *
+     * @returns {void}
+     */
+    sendNextMetrics(): void;
+    /**
+     * Add metrics items to the metrics queue.
+     *
+     * @param {object} data - An object with a payload array of metrics items.
+     *
+     * @returns {void}
+     */
+    addMetrics(data: any): void;
+    /**
+     * Clear the metrics interval.
+     *
+     * @returns {void}
+     */
+    closeMetrics(): void;
+    /**
+     * Anonymize IP addresses.
+     *
+     * @param {array} stats - An RTCStatsReport organized into an array of strings.
+     * @returns {string}
+     */
+    anonymizeIp(stats: string): string;
+    /**
+     * Set a new connection id.
+     *
+     * @returns {void}
+     */
+    private resetConnection;
+    /**
+     * Send metrics to the metrics service.
+     *
+     * @returns {void}
+     */
+    private sendMetrics;
+}

package/package.json

@@ -26,22 +26,22 @@
     "@webex/eslint-config-legacy": "0.0.0",
     "@webex/jest-config-legacy": "0.0.0",
     "@webex/legacy-tools": "0.0.0",
-    "@webex/test-helper-chai": "3.5.0-next.2",
-    "@webex/test-helper-mocha": "3.5.0-next.2",
-    "@webex/test-helper-mock-webex": "3.5.0-next.2",
-    "@webex/test-helper-test-users": "3.5.0-next.2",
+    "@webex/test-helper-chai": "3.5.0-next.21",
+    "@webex/test-helper-mocha": "3.5.0-next.21",
+    "@webex/test-helper-mock-webex": "3.5.0-next.21",
+    "@webex/test-helper-test-users": "3.5.0-next.21",
     "eslint": "^8.24.0",
     "prettier": "^2.7.1",
     "sinon": "^9.2.4"
   },
   "dependencies": {
-    "@webex/common": "3.5.0-next.2",
-    "@webex/common-timers": "3.5.0-next.2",
+    "@webex/common": "3.5.0-next.21",
+    "@webex/common-timers": "3.5.0-next.21",
     "@webex/event-dictionary-ts": "^1.0.1546",
-    "@webex/internal-plugin-metrics": "3.5.0-next.2",
-    "@webex/test-helper-chai": "3.5.0-next.2",
-    "@webex/test-helper-mock-webex": "3.5.0-next.2",
-    "@webex/webex-core": "3.5.0-next.2",
+    "@webex/internal-plugin-metrics": "3.5.0-next.21",
+    "@webex/test-helper-chai": "3.5.0-next.21",
+    "@webex/test-helper-mock-webex": "3.5.0-next.21",
+    "@webex/webex-core": "3.5.0-next.21",
     "ip-anonymize": "^0.1.0",
     "lodash": "^4.17.21",
     "uuid": "^3.3.2"
@@ -54,5 +54,5 @@
     "test:style": "eslint ./src/**/*.*",
     "test:unit": "webex-legacy-tools test --unit --runner mocha"
   },
-  "version": "3.5.0-next.2"
+  "version": "3.5.0-next.21"
 }

package/src/business-metrics.ts

@@ -1,5 +1,5 @@
 import GenericMetrics from './generic-metrics';
-import {EventPayload} from './metrics.types';
+import {EventPayload, Table} from './metrics.types';
 
 /**
  * @description Util class to handle Buisness Metrics
@@ -8,23 +8,115 @@ import {EventPayload} from './metrics.types';
  */
 export default class BusinessMetrics extends GenericMetrics {
   /**
-   * Submit a buisness metric to our metrics endpoint.
+   * unfortunately, the pinot team does not allow changes to the schema of wbxapp_callend_metrics
+   * so we have to shim this layer specifically for this
+   * https://confluence-eng-gpk2.cisco.com/conf/display/WAP/Table+wbxapp_callend_metrics
+   * @param {EventPayload} payload payload of the metric
+   * @returns {Promise<any>}
+   */
+  private submitCallEndEvent({payload}: {payload: EventPayload}) {
+    const event = {
+      type: ['business'],
+      eventPayload: {
+        key: 'callEnd',
+        client_timestamp: new Date().toISOString(),
+        appType: 'Web Client',
+        value: {
+          ...payload,
+        },
+      },
+    };
+
+    return this.submitEvent({
+      kind: 'buisness-events:wbxapp_callend_metrics -> ',
+      name: 'wbxapp_callend_metrics',
+      event,
+    });
+  }
+
+  /**
+   * Submit a buisness metric to our metrics endpoint, going to the default business_ucf table
+   * all event payload keys are converted into a hex string value
+   * unfortunately, the pinot team does not allow changes to the schema of business_metrics
+   * so we have to shim this layer specifically for this
+   * https://confluence-eng-gpk2.cisco.com/conf/display/WAP/Table%3A+business_metrics
+   * @param {string} name of the metric
+   * @param {EventPayload} payload payload of the metric
+   * @returns {Promise<any>}
+   */
+  private submitBusinessMetricsEvent({name, payload}: {name: string; payload: EventPayload}) {
+    const event = {
+      type: ['business'],
+      eventPayload: {
+        key: name,
+        client_timestamp: new Date().toISOString(),
+        appType: 'Web Client',
+        value: {
+          ...this.getContext(),
+          ...this.getBrowserDetails(),
+          ...payload,
+        },
+      },
+    };
+
+    return this.submitEvent({kind: 'buisness-events:business_metrics -> ', name, event});
+  }
+
+  /**
+   * Submit a buisness metric to our metrics endpoint, going to the default business_ucf table
+   * all event payload keys are converted into a hex string value
+   * https://confluence-eng-gpk2.cisco.com/conf/display/WAP/Business+metrics++-%3E+ROMA
    * @param {string} name of the metric
    * @param {EventPayload} user payload of the metric
    * @returns {Promise<any>}
    */
-  public submitBusinessEvent({name, payload}: {name: string; payload: EventPayload}) {
+  private submitDefaultEvent({name, payload}: {name: string; payload: EventPayload}) {
     const event = {
       type: ['business'],
       eventPayload: {
         key: name,
-        client_timestamp: Date.now(),
+        appType: 'Web Client',
+        client_timestamp: new Date().toISOString(),
         context: this.getContext(),
         browserDetails: this.getBrowserDetails(),
         value: payload,
       },
     };
 
-    this.submitEvent({kind: 'buisness-events -> ', name, event});
+    return this.submitEvent({kind: 'buisness-events:default -> ', name, event});
+  }
+
+  /**
+   * Submit a buisness metric to our metrics endpoint.
+   * routes to the correct table with the correct schema payload by table
+   * https://confluence-eng-gpk2.cisco.com/conf/display/WAP/Business+metrics++-%3E+ROMA
+   * @param {string} name of the metric, ignored if going to wbxapp_callend_metrics
+   * @param {EventPayload} payload user payload of the metric
+   * @param {Table} table optional - to submit the metric to and adapt the sent schema
+   * @returns {Promise<any>}
+   */
+  public submitBusinessEvent({
+    name,
+    payload,
+    table,
+  }: {
+    name: string;
+    payload: EventPayload;
+    table?: Table;
+  }): Promise<void> {
+    if (!table) {
+      table = 'default';
+    }
+    switch (table) {
+      case 'wbxapp_callend_metrics':
+        return this.submitCallEndEvent({payload});
+      case 'business_metrics':
+        return this.submitBusinessMetricsEvent({name, payload});
+      case 'business_ucf':
+        return this.submitDefaultEvent({name, payload});
+      case 'default':
+      default:
+        return this.submitDefaultEvent({name, payload});
+    }
   }
 }

package/src/call-diagnostic/call-diagnostic-metrics-latencies.ts

@@ -49,7 +49,7 @@ export default class CallDiagnosticLatencies extends WebexPlugin {
   private getMeeting() {
     if (this.meetingId) {
       // @ts-ignore
-      return this.webex.meetings.meetingCollection.get(this.meetingId);
+      return this.webex.meetings.getBasicMeetingInformation(this.meetingId);
     }
 
     return undefined;

package/src/call-diagnostic/call-diagnostic-metrics.ts

@@ -139,7 +139,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
   getIsConvergedArchitectureEnabled({meetingId}: {meetingId?: string}): boolean {
     if (meetingId) {
       // @ts-ignore
-      const meeting = this.webex.meetings.meetingCollection.get(meetingId);
+      const meeting = this.webex.meetings.getBasicMeetingInformation(meetingId);
 
       return meeting?.meetingInfo?.enableConvergedArchitecture;
     }
@@ -245,7 +245,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
 
       if (meetingId) {
         // @ts-ignore
-        const meeting = this.webex.meetings.meetingCollection.get(meetingId);
+        const meeting = this.webex.meetings.getBasicMeetingInformation(meetingId);
         if (meeting?.environment) {
           origin.environment = meeting.environment;
         }
@@ -289,13 +289,18 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
       sessionCorrelationId,
     } = options;
     const identifiers: Event['event']['identifiers'] = {
-      correlationId: 'unknown',
-      sessionCorrelationId: 'unknown',
+      correlationId: 'unknown', // concerned with setting this to unknown. This will fail diagnostic events parsing because it's not a uuid pattern
     };
 
     if (meeting) {
       identifiers.correlationId = meeting.correlationId;
-      identifiers.sessionCorrelationId = meeting.sessionCorrelationId;
+      if (meeting.sessionCorrelationId) {
+        identifiers.sessionCorrelationId = meeting.sessionCorrelationId;
+      }
+    }
+
+    if (sessionCorrelationId) {
+      identifiers.sessionCorrelationId = sessionCorrelationId;
     }
 
     if (sessionCorrelationId) {
@@ -306,6 +311,8 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
       identifiers.correlationId = correlationId;
     }
 
+    // TODO: should we use patterns.uuid to validate correlationId and session correlation id? they will fail the diagnostic events validation pipeline if improperly formatted
+
     if (this.device) {
       const {device} = this;
       const {installationId} = device?.config || {};
@@ -427,7 +434,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
     // events that will most likely happen in join phase
     if (meetingId) {
       // @ts-ignore
-      const meeting = this.webex.meetings.meetingCollection.get(meetingId);
+      const meeting = this.webex.meetings.getBasicMeetingInformation(meetingId);
 
       if (!meeting) {
         console.warn(
@@ -628,10 +635,11 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
       });
     }
 
-    // otherwise return unkown error
+    // otherwise return unkown error but passing serviceErrorCode and serviceErrorName so that we know the issue
     return this.getErrorPayloadForClientErrorCode({
       clientErrorCode: UNKNOWN_ERROR,
-      serviceErrorCode: UNKNOWN_ERROR,
+      serviceErrorCode: serviceErrorCode || UNKNOWN_ERROR,
+      serviceErrorName: rawError?.name,
       payloadOverrides: rawError.payloadOverrides,
       rawErrorMessage,
       httpStatusCode,
@@ -663,7 +671,7 @@ export default class CallDiagnosticMetrics extends StatelessWebexPlugin {
     } = options;
 
     // @ts-ignore
-    const meeting = this.webex.meetings.meetingCollection.get(meetingId);
+    const meeting = this.webex.meetings.getBasicMeetingInformation(meetingId);
 
     if (!meeting) {
       console.warn(

package/src/call-diagnostic/config.ts

@@ -129,6 +129,7 @@ export const ERROR_DESCRIPTIONS = {
   ICE_AND_REACHABILITY_FAILED: 'ICEAndReachabilityFailed',
   SDP_OFFER_CREATION_ERROR: 'SdpOfferCreationError',
   SDP_OFFER_CREATION_ERROR_MISSING_CODEC: 'SdpOfferCreationErrorMissingCodec',
+  WDM_RESTRICTED_REGION: 'WdmRestrictedRegion',
 };
 
 export const SERVICE_ERROR_CODES_TO_CLIENT_ERROR_CODES_MAP = {
@@ -288,6 +289,12 @@ export const SERVICE_ERROR_CODES_TO_CLIENT_ERROR_CODES_MAP = {
   100005: 4103, // Depracated because of an issue in the UCF Clients
   // If both email-hash and domain-hash are null or undefined.
   100004: 4103,
+
+  // ---- WDM ----
+  // WDM_BLOCKED_ACCESS_BY_COUNTRY_CODE_BANNED_COUNTRY_ERROR_CODE
+  4404002: 13000,
+  // WDM_BLOCKED_ACCESS_BY_COUNTRY_CODE_RESTRICTED_COUNTRY_ERROR_CODE
+  4404003: 13000,
 };
 
 export const CLIENT_ERROR_CODE_TO_ERROR_PAYLOAD: Record<number, Partial<ClientEventError>> = {
@@ -687,6 +694,11 @@ export const CLIENT_ERROR_CODE_TO_ERROR_PAYLOAD: Record<number, Partial<ClientEv
     category: 'expected',
     fatal: true,
   },
+  13000: {
+    errorDescription: ERROR_DESCRIPTIONS.WDM_RESTRICTED_REGION,
+    category: 'expected',
+    fatal: true,
+  },
 };
 
 export const CALL_DIAGNOSTIC_EVENT_FAILED_TO_SEND = 'js_sdk_call_diagnostic_event_failed_to_send';

package/src/index.ts

@@ -25,6 +25,7 @@ import CallDiagnosticLatencies from './call-diagnostic/call-diagnostic-metrics-l
 import BehavioralMetrics from './behavioral-metrics';
 import OperationalMetrics from './operational-metrics';
 import BusinessMetrics from './business-metrics';
+import RtcMetrics from './rtcMetrics';
 
 registerInternalPlugin('metrics', Metrics, {
   config,
@@ -47,6 +48,7 @@ export {
   BehavioralMetrics,
   OperationalMetrics,
   BusinessMetrics,
+  RtcMetrics,
 };
 export type {
   ClientEvent,

package/src/metrics.types.ts

@@ -22,39 +22,93 @@ export type BrowserLaunchMethodType = NonNullable<
 
 export type MetricEventProduct = 'webex' | 'wxcc_desktop';
 
-export type MetricEventAgent = 'user' | 'browser' | 'system' | 'sdk' | 'redux' | 'service';
+export type MetricEventAgent = 'user' | 'browser' | 'system' | 'sdk' | 'redux' | 'service' | 'api';
 
 export type MetricEventVerb =
+  | 'abort'
+  | 'accept'
+  | 'activate'
+  | 'apply'
+  | 'answer'
+  | 'authorize'
+  | 'build'
+  | 'cancel'
+  | 'change'
+  | 'click'
+  | 'close'
+  | 'complete'
+  | 'connect'
   | 'create'
-  | 'get'
+  | 'deactivate'
+  | 'decrypt'
+  | 'delete'
+  | 'deliver'
+  | 'destroy'
+  | 'disable'
+  | 'disconnect'
+  | 'dismiss'
+  | 'display'
+  | 'download'
+  | 'edit'
+  | 'enable'
+  | 'encrypt'
+  | 'end'
+  | 'expire'
+  | 'fail'
   | 'fetch'
-  | 'update'
+  | 'fire'
+  | 'generate'
+  | 'get'
+  | 'hide'
+  | 'hover'
+  | 'ignore'
+  | 'initialize'
+  | 'initiate'
+  | 'invalidate'
+  | 'join'
   | 'list'
-  | 'delete'
+  | 'load'
+  | 'login'
+  | 'logout'
+  | 'notify'
+  | 'offer'
+  | 'open'
+  | 'press'
+  | 'receive'
+  | 'refer'
+  | 'refresh'
+  | 'register'
+  | 'release'
+  | 'reload'
+  | 'reject'
+  | 'request'
+  | 'reset'
+  | 'resize'
+  | 'respond'
+  | 'retry'
+  | 'revoke'
+  | 'save'
+  | 'search'
   | 'select'
-  | 'view'
+  | 'send'
   | 'set'
+  | 'sign'
+  | 'start'
+  | 'submit'
+  | 'switch'
+  | 'sync'
   | 'toggle'
-  | 'load'
-  | 'reload'
-  | 'click'
-  | 'hover'
-  | 'register'
+  | 'transfer'
   | 'unregister'
-  | 'enable'
-  | 'disable'
+  | 'update'
+  | 'upload'
   | 'use'
-  | 'complete'
-  | 'submit'
-  | 'apply'
-  | 'cancel'
-  | 'abort'
-  | 'sync'
-  | 'login'
-  | 'logout'
-  | 'answer'
-  | 'activate'
-  | 'deactivate';
+  | 'validate'
+  | 'view'
+  | 'visit'
+  | 'wait'
+  | 'warn'
+  | 'exit';
 
 export type SubmitClientEventOptions = {
   meetingId?: string;
@@ -115,6 +169,8 @@ export interface DeviceContext {
 
 export type MetricType = 'behavioral' | 'operational' | 'business';
 
+export type Table = 'wbxapp_callend_metrics' | 'business_metrics' | 'business_ucf' | 'default';
+
 type InternalEventPayload = string | number | boolean;
 export type EventPayload = Record<string, InternalEventPayload>;
 export type BehavioralEventPayload = EventPayload; // for compatibilty, can be remove after wxcc-desktop did change their imports.
@@ -242,3 +298,19 @@ export type PreComputedLatencies =
   | 'internal.call.init.join.req'
   | 'internal.other.app.api.time'
   | 'internal.api.fetch.intelligence.models';
+
+export interface IdType {
+  meetingId?: string;
+  callId?: string;
+}
+
+export interface IMetricsAttributes {
+  type: string;
+  version: string;
+  userId: string;
+  correlationId: string;
+  connectionId: string;
+  data: any[];
+  meetingId?: string;
+  callId?: string;
+}

package/src/new-metrics.ts

@@ -21,6 +21,7 @@ import {
   MediaQualityEvent,
   InternalEvent,
   SubmitClientEventOptions,
+  Table,
 } from './metrics.types';
 import CallDiagnosticLatencies from './call-diagnostic/call-diagnostic-metrics-latencies';
 import {setMetricTimings} from './call-diagnostic/call-diagnostic-metrics.util';
@@ -28,6 +29,7 @@ import {generateCommonErrorMetadata} from './utils';
 
 /**
  * Metrics plugin to centralize all types of metrics.
+ * https://confluence-eng-gpk2.cisco.com/conf/pages/viewpage.action?pageId=231011379
  * @class
  */
 class Metrics extends WebexPlugin {
@@ -201,7 +203,15 @@ class Metrics extends WebexPlugin {
    * Buisness event
    * @param args
    */
-  submitBusinessEvent({name, payload}: {name: string; payload: EventPayload}) {
+  submitBusinessEvent({
+    name,
+    payload,
+    table,
+  }: {
+    name: string;
+    payload: EventPayload;
+    table?: Table;
+  }) {
     if (!this.isReady) {
       // @ts-ignore
       this.webex.logger.log(
@@ -213,7 +223,7 @@ class Metrics extends WebexPlugin {
 
     this.lazyBuildBusinessMetrics();
 
-    return this.businessMetrics.submitBusinessEvent({name, payload});
+    return this.businessMetrics.submitBusinessEvent({name, payload, table});
   }
 
   /**

package/src/rtcMetrics/constants.ts

@@ -0,0 +1,3 @@
+const RTC_METRICS = {APP_ID: 'FFB51ED5-4319-4C55-8303-B1F2FCCDE231'};
+
+export {RTC_METRICS as default};