@dxos/observability 0.3.11-main.e19f39d → 0.3.11-main.e28df4f

package/src/helpers/setup-telemetry-listeners.ts

@@ -0,0 +1,115 @@
+//
+// Copyright 2022 DXOS.org
+//
+
+import type { Client } from '@dxos/client';
+
+import { BASE_TELEMETRY_PROPERTIES, getTelemetryIdentifier } from './app-observability';
+import type { Observability } from '../observability';
+
+let lastFocusEvent = new Date();
+let totalTime = 0;
+
+export const setupTelemetryListeners = (namespace: string, client: Client, observability: Observability) => {
+  const clickCallback = (event: any) => {
+    if (BASE_TELEMETRY_PROPERTIES.group === 'dxos' && event.target && !event.target.id) {
+      // TODO(wittjosiah): Use @dxos/log so these can be filtered.
+      console.warn('Click event on element without id:', event.target);
+    }
+
+    setTimeout(() =>
+      observability.event({
+        identityId: getTelemetryIdentifier(client),
+        name: `${namespace}.window.click`,
+        properties: {
+          ...BASE_TELEMETRY_PROPERTIES,
+          href: window.location.href,
+          id: (event.target as HTMLElement)?.id,
+          path: (event.path as HTMLElement[])
+            ?.filter((el) => Boolean(el.tagName))
+            .map((el) => `${el.tagName.toLowerCase()}${el.id ? `#${el.id}` : ''}`)
+            .reverse()
+            .join('>'),
+        },
+      }),
+    );
+  };
+
+  const focusCallback = () => {
+    const now = new Date();
+    setTimeout(() =>
+      observability.event({
+        identityId: getTelemetryIdentifier(client),
+        name: `${namespace}.window.focus`,
+        properties: {
+          ...BASE_TELEMETRY_PROPERTIES,
+          href: window.location.href,
+          timeAway: now.getTime() - lastFocusEvent.getTime(),
+        },
+      }),
+    );
+    lastFocusEvent = now;
+  };
+
+  const blurCallback = () => {
+    const now = new Date();
+    const timeSpent = now.getTime() - lastFocusEvent.getTime();
+    setTimeout(() =>
+      observability.event({
+        identityId: getTelemetryIdentifier(client),
+        name: `${namespace}.window.blur`,
+        properties: {
+          ...BASE_TELEMETRY_PROPERTIES,
+          href: window.location.href,
+          timeSpent,
+        },
+      }),
+    );
+    lastFocusEvent = now;
+    totalTime = totalTime + timeSpent;
+  };
+
+  const unloadCallback = () => {
+    setTimeout(() =>
+      observability.event({
+        identityId: getTelemetryIdentifier(client),
+        name: `${namespace}.page.unload`,
+        properties: {
+          ...BASE_TELEMETRY_PROPERTIES,
+          href: window.location.href,
+          timeSpent: totalTime,
+        },
+      }),
+    );
+  };
+
+  const errorCallback = (event: ErrorEvent) => {
+    setTimeout(() =>
+      observability.event({
+        identityId: getTelemetryIdentifier(client),
+        name: `${namespace}.window.error`,
+        properties: {
+          ...BASE_TELEMETRY_PROPERTIES,
+          href: window.location.href,
+          message: event.message,
+          filename: event.filename,
+          stack: (event.error as Error).stack,
+        },
+      }),
+    );
+  };
+
+  window.addEventListener('click', clickCallback, true);
+  window.addEventListener('focus', focusCallback);
+  window.addEventListener('blur', blurCallback);
+  window.addEventListener('beforeunload', unloadCallback);
+  window.addEventListener('error', errorCallback);
+
+  return () => {
+    window.removeEventListener('click', clickCallback, true);
+    window.removeEventListener('focus', focusCallback);
+    window.removeEventListener('blur', blurCallback);
+    window.removeEventListener('beforeunload', unloadCallback);
+    window.removeEventListener('error', errorCallback);
+  };
+};

package/src/index.ts

@@ -2,4 +2,5 @@
 // Copyright 2023 DXOS.org
 //
 
+export * from './helpers';
 export * from './observability';

package/src/observability.ts

@@ -14,6 +14,7 @@ import { isNode } from '@dxos/util';
 
 import buildSecrets from './cli-observability-secrets.json';
 import { DatadogMetrics } from './datadog';
+import { BASE_TELEMETRY_PROPERTIES, getTelemetryIdentifier, mapSpaces } from './helpers';
 import { SegmentTelemetry, type EventOptions, type PageOptions } from './segment';
 import {
   captureException as sentryCaptureException,
@@ -23,7 +24,6 @@ import {
   type InitOptions,
   setTag as sentrySetTag,
 } from './sentry';
-import { mapSpaces } from './util';
 
 const SPACE_METRICS_MIN_INTERVAL = 1000 * 60;
 // const DATADOG_IDLE_INTERVAL = 1000 * 60 * 5;
@@ -62,8 +62,8 @@ export type ObservabilityOptions = {
 
   errorLog?: {
     sentryInitOptions?: InitOptions;
+    logProcessor?: boolean;
   };
-  logProcessor?: boolean;
 };
 
 /*
@@ -90,7 +90,7 @@ export class Observability {
   private _tags = new Map<string, string>();
 
   // TODO(nf): make platform a required extension?
-  constructor({ namespace, config, secrets, group, mode, telemetry, errorLog, logProcessor }: ObservabilityOptions) {
+  constructor({ namespace, config, secrets, group, mode, telemetry, errorLog }: ObservabilityOptions) {
     this._namespace = namespace;
     this._config = config;
     this._mode = mode ?? 'disabled';
@@ -98,7 +98,7 @@ export class Observability {
     this._secrets = this._loadSecrets(config, secrets);
     this._telemetryBatchSize = telemetry?.batchSize ?? 30;
     this._errorReportingOptions = errorLog?.sentryInitOptions;
-    this._errorLogProcessor = logProcessor ?? false;
+    this._errorLogProcessor = errorLog?.logProcessor ?? false;
 
     if (this._group) {
       this.setTag('group', this._group);
@@ -168,7 +168,7 @@ export class Observability {
     this._tags.set(key, value);
   }
 
-  // TODO(nf): Combine with setDeviceTags.
+  // TODO(wittjosiah): Improve privacy of telemetry identifiers. See `getTelemetryIdentifier`.
   async setIdentityTags(client: Client) {
     client.services.services.IdentityService!.queryIdentity().subscribe((idqr) => {
       if (!idqr?.identity?.identityKey) {
@@ -176,16 +176,9 @@ export class Observability {
         return;
       }
 
-      // TODO(nf): check mode
-      // TODO(nf): cardinality
-      this.setTag('identityKey', idqr?.identity?.identityKey.truncate());
-      if (idqr?.identity?.profile?.displayName) {
-        this.setTag('username', idqr?.identity?.profile?.displayName);
-      }
+      this.setTag('identityKey', idqr.identity.identityKey.truncate());
     });
-  }
 
-  async setDeviceTags(client: Client) {
     client.services.services.DevicesService!.queryDevices().subscribe((dqr) => {
       if (!dqr || !dqr.devices || dqr.devices.length === 0) {
         log('empty response from device service', { device: dqr });
@@ -283,19 +276,30 @@ export class Observability {
     // scheduleTaskInterval(ctx, async () => updateSignalMetrics.emit(), DATADOG_IDLE_INTERVAL);
   }
 
-  startSpacesMetrics(client: Client) {
-    let spaces = client.spaces.get();
+  startSpacesMetrics(client: Client, namespace: string) {
+    const spaces = client.spaces.get();
     const subscriptions = new Map<string, { unsubscribe: () => void }>();
     this._ctx.onDispose(() => subscriptions.forEach((subscription) => subscription.unsubscribe()));
 
     const updateSpaceMetrics = new Event<Space>().debounce(SPACE_METRICS_MIN_INTERVAL);
-    updateSpaceMetrics.on(this._ctx, async (space) => {
+    updateSpaceMetrics.on(this._ctx, async () => {
       log('send space update');
-      for (const sp of mapSpaces(spaces, { truncateKeys: true })) {
-        this.gauge('dxos.client.space.members', sp.members, { key: sp.key });
-        this.gauge('dxos.client.space.objects', sp.objects, { key: sp.key });
-        this.gauge('dxos.client.space.epoch', sp.epoch, { key: sp.key });
-        this.gauge('dxos.client.space.currentDataMutations', sp.currentDataMutations, { key: sp.key });
+      for (const data of mapSpaces(spaces, { truncateKeys: true })) {
+        // Metrics
+        this.gauge('dxos.client.space.members', data.members, { key: data.key });
+        this.gauge('dxos.client.space.objects', data.objects, { key: data.key });
+        this.gauge('dxos.client.space.epoch', data.epoch, { key: data.key });
+        this.gauge('dxos.client.space.currentDataMutations', data.currentDataMutations, { key: data.key });
+
+        // Telemetry
+        this.event({
+          identityId: getTelemetryIdentifier(client),
+          name: `${namespace}.space.update`,
+          properties: {
+            ...BASE_TELEMETRY_PROPERTIES,
+            ...data,
+          },
+        });
       }
     });
 
@@ -311,9 +315,7 @@ export class Observability {
     });
 
     client.spaces.subscribe({
-      next: async () => {
-        spaces = client.spaces.get();
-        // spaces = await this.getSpaces(this._agent.client);
+      next: async (spaces) => {
         spaces
           .filter((space) => !subscriptions.has(space.key.toHex()))
           .forEach((space) => {

package/dist/types/src/util.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../../../src/util.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAEnD,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC;AAEF,eAAO,MAAM,SAAS,WAAY,KAAK,EAAE,YAAW,gBAAgB;;;;;;;;;;;;GAqCnE,CAAC"}

package/dist/types/src/util.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"util.js","sourceRoot":"","sources":["../../../src/util.ts"],"names":[],"mappings":";AAAA,EAAE;AACF,0BAA0B;AAC1B,EAAE;;;AASK,MAAM,SAAS,GAAG,CAAC,MAAe,EAAE,UAA4B,EAAE,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,EAAE,EAAE;IAChH,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;;QAC1B,4BAA4B;QAC5B,oEAAoE;QACpE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAA,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,mCAAI,EAAE,CAAC;QAC1D,MAAM,OAAO,GAAG,IAAI,IAAI,KAAK,IAAI,KAAK,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;QAElE,kGAAkG;QAClG,uDAAuD;QACvD,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC;QAC9C,MAAM,kBAAkB,GAAG,MAAA,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,YAAY,0CAAE,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,aAAa,EAAE,mCAAI,CAAC,CAAC;QACpG,MAAM,KAAK,GAAG,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,YAAY,0CAAE,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC;QAC/D,yEAAyE;QACzE,MAAM,oBAAoB,GAAG,MAAA,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,oBAAoB,0CAAE,aAAa,EAAE,mCAAI,CAAC,CAAC;QAClF,MAAM,kBAAkB,GAAG,MAAA,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,mBAAmB,0CAAE,aAAa,EAAE,mCAAI,CAAC,CAAC;QAE/E,OAAO;YACL,kCAAkC;YAClC,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE;YACzB,IAAI,EAAE,KAAK,CAAC,MAAM;YAClB,IAAI,EAAE,KAAK,CAAC,UAAU,CAAC,IAAI;YAC3B,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,MAAM;YACnC,OAAO,EAAE,KAAK,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC,OAAO,CAAC,MAAM;YACxC,OAAO;YACP,KAAK;YACL,gBAAgB;YAChB,kBAAkB;YAClB,oBAAoB;YACpB,kBAAkB;YAElB,0BAA0B;YAC1B,QAAQ,EAAE,CACR,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,oBAAoB,GAAG,kBAAkB,CAAC,GAAG,CAAC,kBAAkB,GAAG,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC;gBAC9G,GAAG,CACJ,CAAC,OAAO,CAAC,CAAC,CAAC;SACb,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AArCW,QAAA,SAAS,aAqCpB"}