@dxos/observability 0.8.1-main.ba2dec9 → 0.8.1-staging.31c3ee1

package/dist/lib/node-esm/{chunk-S7JHPCWW.mjs → chunk-HMGFYMJF.mjs}

@@ -1,4 +1,7 @@
 import { createRequire } from 'node:module';const require = createRequire(import.meta.url);
+import {
+  TelemetryEvent
+} from "./chunk-IKCDMDT3.mjs";
 
 // packages/sdk/observability/src/observability.ts
 import { Event, scheduleTaskInterval } from "@dxos/async";
@@ -74,20 +77,26 @@ var storeObservabilityGroup = async (namespace, value) => {
     });
   }
 };
-var initializeAppObservability = async ({ namespace, config, mode = "basic", tracingEnable = false, replayEnable = false }) => {
+var initializeAppObservability = async ({
+  namespace,
+  config,
+  // TODO(nf): Configure mode.
+  mode = "basic",
+  tracingEnable = false,
+  replayEnable = false
+}) => {
   log("initializeAppObservability", {
     config
   }, {
     F: __dxlog_file,
-    L: 72,
+    L: 73,
     S: void 0,
     C: (f, a) => f(...a)
   });
   const group = await getObservabilityGroup(namespace) ?? void 0;
   const release = `${namespace}@${config.get("runtime.app.build.version")}`;
   const environment = config.get("runtime.app.env.DX_ENVIRONMENT");
-  const observabilityDisabled = await isObservabilityDisabled(namespace);
-  const { Observability: Observability2 } = await import("./observability-OLS7SWZT.mjs");
+  const { Observability: Observability2 } = await import("./observability-KDS7YGCQ.mjs");
   const observability = new Observability2({
     namespace,
     release,
@@ -102,18 +111,20 @@ var initializeAppObservability = async ({ namespace, config, mode = "basic", tra
         tracing: tracingEnable,
         replay: replayEnable,
         // TODO(wittjosiah): Configure these.
+        //   Consider using a sampling function to dynamically configure these values.
+        //   https://docs.sentry.io/platforms/javascript/configuration/sampling/#setting-a-sampling-function
         sampleRate: 1,
-        // TODO(mykola): Lower this to 0.1.
         replaySampleRate: 1,
         replaySampleRateOnError: 1
       }
     }
   });
+  const observabilityDisabled = await isObservabilityDisabled(namespace);
   if (observabilityDisabled) {
     observability.setMode("disabled");
     log.info("observability disabled", void 0, {
       F: __dxlog_file,
-      L: 116,
+      L: 113,
       S: void 0,
       C: (f, a) => f(...a)
     });
@@ -140,7 +151,7 @@ var initializeAppObservability = async ({ namespace, config, mode = "basic", tra
     await observability.initialize();
     observability.startErrorLogs();
     const ipData = await getIPData(config);
-    ipData && observability.addIPDataTelemetryTags(ipData);
+    ipData && observability.setIPDataTelemetryTags(ipData);
     if (typeof navigator !== "undefined" && navigator.storage?.estimate) {
       setInterval(async () => {
         try {
@@ -150,7 +161,7 @@ var initializeAppObservability = async ({ namespace, config, mode = "basic", tra
         } catch (error) {
           log.warn("Failed to run estimate()", error, {
             F: __dxlog_file,
-            L: 172,
+            L: 168,
             S: void 0,
             C: (f, a) => f(...a)
           });
@@ -160,7 +171,7 @@ var initializeAppObservability = async ({ namespace, config, mode = "basic", tra
   } catch (err) {
     log.error("Failed to initialize app observability", err, {
       F: __dxlog_file,
-      L: 177,
+      L: 173,
       S: void 0,
       C: (f, a) => f(...a)
     });
@@ -179,6 +190,12 @@ var getTelemetryIdentifier = (client) => {
   }
   return void 0;
 };
+var getTelemetryIdentity = (client) => {
+  const did = getTelemetryIdentifier(client);
+  return {
+    did
+  };
+};
 
 // packages/sdk/observability/src/helpers/node-observability.ts
 import yaml from "js-yaml";
@@ -246,11 +263,11 @@ var initializeNodeObservability = async ({ namespace, version, config, installat
   const release = `${namespace}@${version}`;
   const environment = process.env.DX_ENVIRONMENT ?? "unknown";
   const observability = new Observability({
+    mode,
     namespace,
     release,
     environment,
     group,
-    mode,
     errorLog: {
       sentryInitOptions: {
         environment,
@@ -265,7 +282,7 @@ var initializeNodeObservability = async ({ namespace, version, config, installat
   try {
     const res = await fetch(`https://api.ipdata.co/?api-key=${IPDATA_API_KEY}`);
     const ipData = await res.json();
-    ipData && observability.addIPDataTelemetryTags(ipData);
+    ipData && observability.setIPDataTelemetryTags(ipData);
   } catch (err) {
     observability?.captureException(err);
   }
@@ -312,63 +329,69 @@ var setupTelemetryListeners = (namespace, client, observability) => {
     if (!id) {
       return;
     }
-    setTimeout(() => observability.event({
-      did: getTelemetryIdentifier(client),
-      name: `${namespace}.window.click`,
-      properties: {
-        href: window.location.href,
-        id: event.target?.id,
-        path: event.composedPath().filter((el) => Boolean(el.tagName)).map((el) => `${el.tagName.toLowerCase()}${el.id ? `#${el.id}` : ""}`).reverse().join(">")
-      }
-    }));
+    setTimeout(() => {
+      observability.track({
+        ...getTelemetryIdentity(client),
+        action: "window.click",
+        properties: {
+          id: event.target?.id,
+          path: event.composedPath().filter((el) => Boolean(el.tagName)).map((el) => `${el.tagName.toLowerCase()}${el.id ? `#${el.id}` : ""}`).reverse().join(">")
+        }
+      });
+    });
   };
   const focusCallback = () => {
     const now = /* @__PURE__ */ new Date();
-    setTimeout(() => observability.event({
-      did: getTelemetryIdentifier(client),
-      name: `${namespace}.window.focus`,
-      properties: {
-        href: window.location.href,
-        timeAway: now.getTime() - lastFocusEvent.getTime()
-      }
-    }));
+    setTimeout(() => {
+      observability.track({
+        ...getTelemetryIdentity(client),
+        action: "window.focus",
+        properties: {
+          timeAway: now.getTime() - lastFocusEvent.getTime()
+        }
+      });
+    });
     lastFocusEvent = now;
   };
   const blurCallback = () => {
     const now = /* @__PURE__ */ new Date();
-    const timeSpent = now.getTime() - lastFocusEvent.getTime();
-    setTimeout(() => observability.event({
-      did: getTelemetryIdentifier(client),
-      name: `${namespace}.window.blur`,
-      properties: {
-        href: window.location.href,
-        timeSpent
-      }
-    }));
+    const duration = now.getTime() - lastFocusEvent.getTime();
+    setTimeout(() => {
+      observability.track({
+        ...getTelemetryIdentity(client),
+        action: "window.blur",
+        properties: {
+          duration
+        }
+      });
+    });
     lastFocusEvent = now;
-    totalTime = totalTime + timeSpent;
+    totalTime = totalTime + duration;
   };
   const unloadCallback = () => {
-    setTimeout(() => observability.event({
-      did: getTelemetryIdentifier(client),
-      name: `${namespace}.page.unload`,
-      properties: {
-        href: window.location.href,
-        timeSpent: totalTime
-      }
-    }));
+    setTimeout(() => {
+      observability.track({
+        ...getTelemetryIdentity(client),
+        action: "page.unload",
+        properties: {
+          duration: totalTime
+        }
+      });
+    });
   };
   const errorCallback = (event) => {
-    setTimeout(() => observability.event({
-      did: getTelemetryIdentifier(client),
-      name: `${namespace}.window.error`,
-      properties: {
-        href: window.location.href,
-        message: event.message,
-        filename: event.filename,
-        stack: event.error?.stack
-      }
-    }));
+    setTimeout(() => {
+      observability.track({
+        ...getTelemetryIdentity(client),
+        action: "window.error",
+        properties: {
+          message: event.message,
+          filename: event.filename,
+          stack: event.error?.stack,
+          cause: event.error?.cause
+        }
+      });
+    });
   };
   window.addEventListener("click", clickCallback, true);
   window.addEventListener("focus", focusCallback);
@@ -391,35 +414,32 @@ var SPACE_TELEMETRY_MIN_INTERVAL = 1e3 * 60 * 60;
 var NETWORK_METRICS_MIN_INTERVAL = 1e3 * 60 * 5;
 var Observability = class {
   // TODO(nf): make platform a required extension?
-  constructor({ namespace, environment, release, config, secrets, group, mode, telemetry, errorLog }) {
-    // TODO(nf): accept upstream context?
+  constructor({ mode, namespace, environment, release, config, group, secrets, telemetry, errorLog }) {
+    this._tags = /* @__PURE__ */ new Map();
     this._ctx = new Context(void 0, {
       F: __dxlog_file3,
-      L: 87
+      L: 115
     });
-    this._tags = /* @__PURE__ */ new Map();
-    this.addIPDataTelemetryTags = (ipData) => {
+    this.setIPDataTelemetryTags = (ipData) => {
       this.setTag("city", ipData.city, "telemetry");
       this.setTag("region", ipData.region, "telemetry");
       this.setTag("country", ipData.country, "telemetry");
       ipData.latitude && this.setTag("latitude", ipData.latitude.toString(), "telemetry");
       ipData.longitude && this.setTag("longitude", ipData.longitude.toString(), "telemetry");
     };
-    this._namespace = namespace;
     this._mode = mode;
+    this._namespace = namespace;
     this._config = config;
     this._group = group;
     this._secrets = this._loadSecrets(config, secrets);
     this._telemetryBatchSize = telemetry?.batchSize ?? 30;
     this._errorReportingOptions = errorLog?.sentryInitOptions;
-    if (this._group) {
-      this.setTag("group", this._group);
-    }
-    this.setTag("namespace", this._namespace);
-    environment && this.setTag("environment", environment);
-    release && this.setTag("release", release);
     this.setTag("mode", this._mode);
+    this.setTag("namespace", this._namespace);
+    this.setTag("environment", environment);
+    this.setTag("release", release);
     this.setTag("session", PublicKey.random().toHex());
+    this.setTag("group", this._group);
   }
   get mode() {
     return this._mode;
@@ -450,7 +470,7 @@ var Observability = class {
         config
       }, {
         F: __dxlog_file3,
-        L: 151,
+        L: 176,
         S: this,
         C: (f, a) => f(...a)
       });
@@ -467,6 +487,12 @@ var Observability = class {
     }
   }
   async initialize() {
+    log3("initializing...", void 0, {
+      F: __dxlog_file3,
+      L: 191,
+      S: this,
+      C: (f, a) => f(...a)
+    });
     await this._initLogs();
     await this._initMetrics();
     await this._initTelemetry();
@@ -474,6 +500,12 @@ var Observability = class {
     await this._initTraces();
   }
   async close() {
+    log3("closing...", void 0, {
+      F: __dxlog_file3,
+      L: 200,
+      S: this,
+      C: (f, a) => f(...a)
+    });
     const closes = [];
     this._telemetry && closes.push(this._telemetry.close());
     this._otelMetrics && closes.push(this._otelMetrics.close());
@@ -484,10 +516,13 @@ var Observability = class {
   setMode(mode) {
     this._mode = mode;
   }
-  //
-  // Tags
-  //
+  /**
+  * camelCase keys are converted to snake_case in Segment.
+  */
   setTag(key, value, scope) {
+    if (value === void 0) {
+      return;
+    }
     if (this.enabled && (scope === void 0 || scope === "all" || scope === "errors")) {
       this._setTag?.(key, value);
     }
@@ -511,13 +546,16 @@ var Observability = class {
             idqr
           }, {
             F: __dxlog_file3,
-            L: 220,
+            L: 247,
             S: this,
             C: (f, a) => f(...a)
           });
           return;
         }
         this.setTag("did", idqr.identity.did);
+        this._telemetry?.identify({
+          userId: idqr.identity.did
+        });
       });
     }
     if (clientServices.DevicesService) {
@@ -527,7 +565,7 @@ var Observability = class {
             device: dqr
           }, {
             F: __dxlog_file3,
-            L: 230,
+            L: 259,
             S: this,
             C: (f, a) => f(...a)
           });
@@ -535,7 +573,7 @@ var Observability = class {
         }
         invariant(dqr, "empty response from device service", {
           F: __dxlog_file3,
-          L: 233,
+          L: 263,
           S: this,
           A: [
             "dqr",
@@ -548,7 +586,7 @@ var Observability = class {
             device: dqr
           }, {
             F: __dxlog_file3,
-            L: 237,
+            L: 266,
             S: this,
             C: (f, a) => f(...a)
           });
@@ -586,14 +624,14 @@ var Observability = class {
         namespace: this._namespace
       }, {
         F: __dxlog_file3,
-        L: 272,
+        L: 310,
         S: this,
         C: (f, a) => f(...a)
       });
     } else {
       log3("otel logs disabled", void 0, {
         F: __dxlog_file3,
-        L: 274,
+        L: 312,
         S: this,
         C: (f, a) => f(...a)
       });
@@ -619,14 +657,14 @@ var Observability = class {
       });
       log3("otel metrics enabled", void 0, {
         F: __dxlog_file3,
-        L: 299,
+        L: 337,
         S: this,
         C: (f, a) => f(...a)
       });
     } else {
       log3("otel metrics disabled", void 0, {
         F: __dxlog_file3,
-        L: 301,
+        L: 339,
         S: this,
         C: (f, a) => f(...a)
       });
@@ -649,7 +687,7 @@ var Observability = class {
     updateSignalMetrics.on(this._ctx, async () => {
       log3("send signal metrics", void 0, {
         F: __dxlog_file3,
-        L: 323,
+        L: 361,
         S: this,
         C: (f, a) => f(...a)
       });
@@ -701,7 +739,7 @@ var Observability = class {
     updateSpaceMetrics.on(this._ctx, async () => {
       log3("send space metrics", void 0, {
         F: __dxlog_file3,
-        L: 377,
+        L: 414,
         S: this,
         C: (f, a) => f(...a)
       });
@@ -726,16 +764,17 @@ var Observability = class {
     updateSpaceTelemetry.on(this._ctx, async () => {
       log3("send space telemetry", void 0, {
         F: __dxlog_file3,
-        L: 388,
+        L: 425,
         S: this,
         C: (f, a) => f(...a)
       });
       for (const data of mapSpaces(spaces, {
         truncateKeys: true
       })) {
-        this.event({
-          did: getTelemetryIdentifier(client),
-          name: `${namespace}.space.update`,
+        this.track({
+          ...getTelemetryIdentity(client),
+          event: TelemetryEvent.METRICS,
+          action: "space.update",
           properties: data
         });
       }
@@ -762,14 +801,14 @@ var Observability = class {
     const platform = await client.services.services.SystemService?.getPlatform();
     invariant(platform, "platform is required", {
       F: __dxlog_file3,
-      L: 425,
+      L: 463,
       S: this,
       A: [
         "platform",
         "'platform is required'"
       ]
     });
-    this.setTag("platform_type", Platform.PLATFORM_TYPE[platform.type].toLowerCase());
+    this.setTag("platformType", Platform.PLATFORM_TYPE[platform.type].toLowerCase());
     if (this._mode === "full") {
       if (platform.platform) {
         this.setTag("platform", platform.platform);
@@ -800,7 +839,7 @@ var Observability = class {
         error
       }, {
         F: __dxlog_file3,
-        L: 460,
+        L: 497,
         S: this,
         C: (f, a) => f(...a)
       }));
@@ -825,27 +864,25 @@ var Observability = class {
     } else {
       log3("segment disabled", void 0, {
         F: __dxlog_file3,
-        L: 486,
+        L: 523,
         S: this,
         C: (f, a) => f(...a)
       });
     }
   }
   /**
-  * A telemetry event.
-  *
+  * Submit telemetry page view.
   * The default implementation uses Segment.
   */
-  event(options) {
-    this._telemetry?.event(options);
+  page(options) {
+    this._telemetry?.page(options);
   }
   /**
-  * A telemetry page view.
-  *
+  * Submit telemetry user action.
   * The default implementation uses Segment.
   */
-  page(options) {
-    this._telemetry?.page(options);
+  track(options) {
+    this._telemetry?.track(options);
   }
   //
   // Error Logs
@@ -853,7 +890,7 @@ var Observability = class {
   async _initErrorLogs() {
     if (this._secrets.SENTRY_DESTINATION && this._mode !== "disabled") {
       const { captureException, captureUserFeedback, init, setTag } = await import("./sentry/index.mjs");
-      const { SentryLogProcessor } = await import("./sentry-log-processor-BVINGAOV.mjs");
+      const { SentryLogProcessor } = await import("./sentry-log-processor-FO6MIWBC.mjs");
       this._captureException = captureException;
       this._captureUserFeedback = captureUserFeedback;
       this._setTag = setTag;
@@ -862,7 +899,7 @@ var Observability = class {
         options: this._errorReportingOptions
       }, {
         F: __dxlog_file3,
-        L: 522,
+        L: 556,
         S: this,
         C: (f, a) => f(...a)
       });
@@ -881,7 +918,7 @@ var Observability = class {
     } else {
       log3("sentry disabled", void 0, {
         F: __dxlog_file3,
-        L: 542,
+        L: 576,
         S: this,
         C: (f, a) => f(...a)
       });
@@ -893,7 +930,7 @@ var Observability = class {
   startTraces() {
     this._otelTraces && this._otelTraces.start();
   }
-  // TODO(nf): refactor init based on providers and their capabilities
+  // TODO(nf): Refactor init based on providers and their capabilities.
   async _initTraces() {
     if (this._secrets.OTEL_ENDPOINT && this._secrets.OTEL_AUTHORIZATION && this._mode !== "disabled") {
       const { OtelTraces } = await import("./otel-CYD4GJC2.mjs");
@@ -913,7 +950,6 @@ var Observability = class {
   }
   /**
   * Manually capture an exception.
-  *
   * The default implementation uses Sentry.
   */
   captureException(err) {
@@ -923,11 +959,21 @@ var Observability = class {
   }
   /**
   * Manually capture user feedback.
-  *
   * The default implementation uses Sentry.
   */
-  captureUserFeedback(name, email, message) {
-    void this._captureUserFeedback?.(name, email, message);
+  captureUserFeedback(message) {
+    if (!this._secrets.SENTRY_DESTINATION) {
+      log3.info("Feedback submitted without Sentry destination", {
+        message
+      }, {
+        F: __dxlog_file3,
+        L: 625,
+        S: this,
+        C: (f, a) => f(...a)
+      });
+      return;
+    }
+    void this._captureUserFeedback?.(message);
   }
 };
 
@@ -941,10 +987,11 @@ export {
   storeObservabilityGroup,
   initializeAppObservability,
   getTelemetryIdentifier,
+  getTelemetryIdentity,
   showObservabilityBanner,
   getObservabilityState,
   initializeNodeObservability,
   mapSpaces,
   setupTelemetryListeners
 };
-//# sourceMappingURL=chunk-S7JHPCWW.mjs.map
+//# sourceMappingURL=chunk-HMGFYMJF.mjs.map