@webex/internal-plugin-metrics 3.12.0-webex-services-ready.4 → 3.13.0

package/src/index.ts

@@ -2,6 +2,8 @@
  * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
  */
 
+/* eslint-disable valid-jsdoc */
+
 import {registerInternalPlugin} from '@webex/webex-core';
 
 import Metrics from './metrics';
@@ -21,6 +23,7 @@ import {
   PreComputedLatencies,
   SubmitFeatureEvent,
   LocusSyncLatencyEventName,
+  PrivacyAndSecurityPermission,
 } from './metrics.types';
 import * as CALL_DIAGNOSTIC_CONFIG from './call-diagnostic/config';
 import * as CallDiagnosticUtils from './call-diagnostic/call-diagnostic-metrics.util';
@@ -34,6 +37,13 @@ import PreLoginMetrics from './prelogin-metrics';
 
 registerInternalPlugin('metrics', Metrics, {
   config,
+  /**
+   * Stops network telemetry before SDK logout.
+   * @returns
+   */
+  onBeforeLogout() {
+    return this.stopNetworkTelemetry();
+  },
 });
 
 registerInternalPlugin('newMetrics', NewMetrics, {
@@ -70,4 +80,5 @@ export type {
   PreComputedLatencies,
   SubmitFeatureEvent,
   LocusSyncLatencyEventName,
+  PrivacyAndSecurityPermission,
 };

package/src/metrics.js

@@ -1,4 +1,5 @@
 /* eslint-disable default-param-last */
+/* eslint-disable valid-jsdoc */
 
 /*!
  * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
@@ -11,6 +12,7 @@ import {OS_NAME, OSMap, CLIENT_NAME} from './config';
 import Batcher from './batcher';
 import ClientMetricsBatcher from './client-metrics-batcher';
 import ClientMetricsPreloginBatcher from './client-metrics-prelogin-batcher';
+import {createNetworkTelemetryCollector} from './network-telemetry';
 
 const {getOSName, getOSVersion, getBrowserName, getBrowserVersion} = BrowserDetection();
 
@@ -43,6 +45,119 @@ const Metrics = WebexPlugin.extend({
 
   namespace: 'Metrics',
 
+  /**
+   * Registers SDK request outcome monitoring.
+   * @param args
+   * @returns
+   */
+  initialize(...args) {
+    WebexPlugin.prototype.initialize.call(this, ...args);
+
+    // Metrics may also be constructed as a standalone plugin. Request events are
+    // available only when it is attached to a Webex instance.
+    if (!this.parent && !this.collection) {
+      return;
+    }
+
+    const initializeNetworkTelemetry = () => {
+      if (
+        this.networkTelemetry ||
+        this.webex?.config?.metrics?.networkTelemetry?.enabled !== true
+      ) {
+        return;
+      }
+
+      this.networkTelemetry = createNetworkTelemetryCollector({
+        intervalMs: this.webex.config.metrics.networkTelemetry.intervalMs,
+        submitMetric: this.submitNetworkTelemetryMetric.bind(this),
+        onSubmissionFailure: this.handleNetworkTelemetrySubmissionFailure.bind(this),
+      });
+      this.listenTo(this.webex, 'request:start', this.recordNetworkRequestStart);
+      this.listenTo(this.webex, 'request:success', this.recordNetworkRequestSuccess);
+      this.listenTo(this.webex, 'request:failure', this.recordNetworkRequestFailure);
+    };
+
+    // Ampersand initializes children before WebexCore.initialize() populates
+    // webex.config. Run immediately for already-configured hosts (including
+    // MockWebex), and listen for the real core's post-initialization notification.
+    this.listenToOnce(this.webex, 'change:config', initializeNetworkTelemetry);
+    initializeNetworkTelemetry();
+  },
+
+  /**
+   * Records an SDK request being sent in the current reporting window.
+   * @param options
+   * @returns
+   */
+  recordNetworkRequestStart(options) {
+    this.networkTelemetry.recordRequest(options);
+  },
+
+  /**
+   * Records a successful SDK request for the current reporting window.
+   * @param options
+   * @returns
+   */
+  recordNetworkRequestSuccess(options) {
+    this.networkTelemetry.recordResponse(options);
+  },
+
+  /**
+   * Records a failed SDK request for the current reporting window.
+   * @param options
+   * @param reason
+   * @returns
+   */
+  recordNetworkRequestFailure(options, reason) {
+    this.networkTelemetry.recordFailure(options, reason);
+  },
+
+  /**
+   * Submits the current network telemetry window immediately.
+   * @returns
+   */
+  flushNetworkTelemetry() {
+    if (!this.networkTelemetry) {
+      return Promise.resolve();
+    }
+
+    return this.networkTelemetry.flush();
+  },
+
+  /**
+   * Submits a completed network telemetry window through client metrics.
+   * @param name
+   * @param properties
+   * @returns
+   */
+  submitNetworkTelemetryMetric(name, properties) {
+    return this.submitClientMetrics(name, properties);
+  },
+
+  /**
+   * Logs a network telemetry submission failure without affecting SDK requests.
+   * @returns
+   */
+  handleNetworkTelemetrySubmissionFailure() {
+    this.webex.logger?.warn('metrics: failed to submit network request summary telemetry');
+  },
+
+  /**
+   * Stops network telemetry collection and submission.
+   * @returns
+   */
+  stopNetworkTelemetry() {
+    if (!this.networkTelemetry) {
+      return Promise.resolve();
+    }
+
+    this.stopListening(this.webex, 'request:start', this.recordNetworkRequestStart);
+    this.stopListening(this.webex, 'request:success', this.recordNetworkRequestSuccess);
+    this.stopListening(this.webex, 'request:failure', this.recordNetworkRequestFailure);
+
+    return this.networkTelemetry.stop();
+  },
+
   submit(key, value) {
     return this.batcher.request({key, ...value});
   },
@@ -60,17 +175,20 @@ const Metrics = WebexPlugin.extend({
     const payload = {metricName: eventName};
     // @ts-ignore
     const providedClientVersion = this.webex.meetings?.config?.metrics?.clientVersion;
+    const {appName, appVersion} = this.webex.config;
+    // Browser location is unavailable when the SDK runs in Node.js.
+    // eslint-disable-next-line no-undef
+    const browserLocation = typeof window !== 'undefined' ? window.location : undefined;
 
     payload.tags = {
       ...props.tags,
+      app_name: appName ?? 'unknown',
+      app_url: browserLocation?.origin || browserLocation?.hostname || 'non-browser',
+      app_version: appVersion ?? 'unknown',
       browser: getBrowserName(),
       os: getOSNameInternal(),
       appVersion: providedClientVersion,
-
-      // Node does not like this so we need to check if it exists or not
-      // eslint-disable-next-line no-undef
-      domain:
-        typeof window !== 'undefined' ? window.location.hostname || 'non-browser' : 'non-browser', // Check what else we could measure
+      domain: browserLocation?.hostname || 'non-browser',
     };
 
     payload.fields = {

package/src/metrics.types.ts

@@ -23,6 +23,15 @@ export type ClientUserNameInput = NonNullable<RawClientEvent['userNameInput']>;
 
 export type ClientEmailInput = NonNullable<RawClientEvent['emailInput']>;
 
+export type PrivacyAndSecurityPermission = NonNullable<
+  RawClientEvent['privacyAndSecurityPermission']
+>;
+
+export type PrivacyAndSecurityPermissionResource = keyof PrivacyAndSecurityPermission;
+
+export type PrivacyAndSecurityPermissionState =
+  PrivacyAndSecurityPermission[PrivacyAndSecurityPermissionResource];
+
 export type BrowserLaunchMethodType = NonNullable<
   RawEvent['origin']['clientInfo']
 >['browserLaunchMethod'];
@@ -133,6 +142,7 @@ export type SubmitClientEventOptions = {
   browserLaunchMethod?: BrowserLaunchMethodType;
   webexConferenceIdStr?: string;
   globalMeetingId?: string;
+  locusCluster?: string;
   joinFlowVersion?: MetricEventJoinFlowVersion;
   meetingJoinPhase?: MetricEventMeetingJoinPhase;
   triggeredTime?: string;
@@ -262,10 +272,10 @@ export type ClientType = NonNullable<RawEvent['origin']['clientInfo']>['clientTy
 export type SubClientType = NonNullable<RawEvent['origin']['clientInfo']>['subClientType'];
 export type NetworkType = NonNullable<RawEvent['origin']>['networkType'];
 
-export type ClientSubServiceType = ClientEvent['payload']['webexSubServiceType'];
+export type ClientSubServiceType = NonNullable<ClientEvent['payload']>['webexSubServiceType'];
 export type ClientEventPayload = RecursivePartial<ClientEvent['payload']>;
-export type ClientEventLeaveReason = ClientEvent['payload']['leaveReason'];
-export type ClientEventPayloadError = ClientEvent['payload']['errors'];
+export type ClientEventLeaveReason = NonNullable<ClientEvent['payload']>['leaveReason'];
+export type ClientEventPayloadError = NonNullable<ClientEvent['payload']>['errors'];
 
 export type ClientFeatureEventPayload = RecursivePartial<FeatureEvent['payload']>;