@dxos/observability 0.8.4-main.b97322e → 0.8.4-main.bcb3aa67d6

package/src/{helpers/node-observability.ts → storage/node.ts}

@@ -1,16 +1,12 @@
 //
 // Copyright 2022 DXOS.org
 //
-import yaml from 'js-yaml';
 import { existsSync, statSync } from 'node:fs';
 import { mkdir, readFile, writeFile } from 'node:fs/promises';
 import { join } from 'node:path';
-import { v4 as uuid, validate as validateUuid } from 'uuid';
 
-import type { Config } from '@dxos/client';
-import { log } from '@dxos/log';
-
-import { Observability, type Mode } from '../observability';
+import yaml from 'js-yaml';
+import { v4 as uuid, validate as validateUuid } from 'uuid';
 
 /**
  * Print observability banner once per installation.
@@ -21,7 +17,6 @@ export const showObservabilityBanner = async (configDir: string, bannercb: (inpu
     return;
   }
   bannercb(
-    // eslint-disable-next-line no-multi-str
     'Basic observability data will be sent to the DXOS team in order to improve the product. This includes \
     performance metrics, error logs, and usage data. No personally identifiable information, other than your \
     public key, is included with this data and no private data ever leaves your devices. To disable sending \
@@ -31,7 +26,43 @@ export const showObservabilityBanner = async (configDir: string, bannercb: (inpu
   await writeFile(path, '', 'utf-8');
 };
 
-export const getObservabilityState = async (configDir: string): Promise<PersistentObservabilityState> => {
+/**
+ * @param configDir - Filesystem path to the directory containing the `observability.yml` state file.
+ */
+export const isObservabilityDisabled = async (configDir: string): Promise<boolean> => {
+  const observabilityState = await getObservabilityState(configDir);
+  return observabilityState.disabled;
+};
+
+/**
+ * @param configDir - Filesystem path to the directory containing the `observability.yml` state file.
+ */
+// NOTE: read-modify-write is not atomic; concurrent callers could overwrite each other.
+// Acceptable here because writes are infrequent and triggered by explicit user action.
+export const storeObservabilityDisabled = async (configDir: string, value: boolean) => {
+  const observabilityState = await getObservabilityState(configDir);
+  observabilityState.disabled = value;
+  await writeFile(join(configDir, 'observability.yml'), yaml.dump(observabilityState), 'utf-8');
+};
+
+/**
+ * @param configDir - Filesystem path to the directory containing the `observability.yml` state file.
+ */
+export const getObservabilityGroup = async (configDir: string): Promise<string | undefined> => {
+  const observabilityState = await getObservabilityState(configDir);
+  return observabilityState.group;
+};
+
+/**
+ * @param configDir - Filesystem path to the directory containing the `observability.yml` state file.
+ */
+export const storeObservabilityGroup = async (configDir: string, value: string) => {
+  const observabilityState = await getObservabilityState(configDir);
+  observabilityState.group = value;
+  await writeFile(join(configDir, 'observability.yml'), yaml.dump(observabilityState), 'utf-8');
+};
+
+const getObservabilityState = async (configDir: string): Promise<PersistentObservabilityState> => {
   // check whether configDir exists and if it's a directory
 
   if (existsSync(configDir)) {
@@ -53,8 +84,8 @@ export const getObservabilityState = async (configDir: string): Promise<Persiste
 
 export type PersistentObservabilityState = {
   installationId: string;
+  disabled: boolean;
   group?: string;
-  mode: Mode;
 };
 
 // create initial state and write to file, using environment variables to override defaults.
@@ -62,8 +93,8 @@ const initializeState = async (idPath: string): Promise<PersistentObservabilityS
   // TODO(nf): read initial values from config or seed file
   const observabilityState = {
     installationId: uuid(),
+    disabled: process.env.DX_DISABLE_OBSERVABILITY ? true : false,
     group: process.env.DX_OBSERVABILITY_GROUP ?? undefined,
-    mode: (process.env.DX_DISABLE_OBSERVABILITY ? 'disabled' : (process.env.DX_OBSERVABILITY_MODE ?? 'basic')) as Mode,
   };
 
   await writeFile(
@@ -80,66 +111,7 @@ const validate = (contextString: string) => {
   if (Boolean(context.installationId) && validateUuid(context.installationId!)) {
     return {
       ...context,
-      mode: process.env.DX_DISABLE_OBSERVABILITY ? 'disabled' : (context.mode ?? 'basic'),
+      disabled: process.env.DX_DISABLE_OBSERVABILITY ? true : (context.disabled ?? false),
     };
   }
 };
-
-export type NodeObservabilityOptions = {
-  installationId: string;
-  group?: string;
-  namespace: string;
-  version: string;
-  config: Config;
-  mode?: Mode;
-  tracingEnable?: boolean;
-  replayEnable?: boolean;
-  // TODO(nf): options for providers?
-};
-
-export const initializeNodeObservability = async ({
-  namespace,
-  version,
-  config,
-  installationId,
-  group,
-  mode = 'basic',
-  tracingEnable = true,
-  replayEnable = true,
-}: NodeObservabilityOptions): Promise<Observability> => {
-  log('initializeCliObservability', { config });
-
-  // TODO(nf): make CLI build populate runtime.app.build config?
-  const release = `${namespace}@${version}`;
-  const environment = process.env.DX_ENVIRONMENT ?? 'unknown';
-
-  const observability = new Observability({
-    mode,
-    namespace,
-    release,
-    environment,
-    group,
-    errorLog: {
-      sentryInitOptions: {
-        environment,
-        release,
-        // TODO(wittjosiah): Configure this.
-        sampleRate: 1.0,
-      },
-    },
-  });
-
-  observability.setTag('installationId', installationId);
-
-  // TODO(nf): cache ipdata to avoid repeated requests
-  const IPDATA_API_KEY = config.get('runtime.app.env.DX_IPDATA_API_KEY');
-  try {
-    const res = await fetch(`https://api.ipdata.co/?api-key=${IPDATA_API_KEY}`);
-    const ipData = await res.json();
-    ipData && observability.setIPDataTelemetryTags(ipData);
-  } catch (err) {
-    observability?.captureException(err);
-  }
-
-  return observability;
-};

package/dist/lib/browser/chunk-5ICT2XF2.mjs

@@ -1 +0,0 @@
-//# sourceMappingURL=chunk-5ICT2XF2.mjs.map

package/dist/lib/browser/chunk-MWTIKIBZ.mjs

@@ -1,147 +0,0 @@
-import {
-  captureException
-} from "./chunk-YEPQFAES.mjs";
-
-// src/segment/browser.ts
-import snippet from "@segment/snippet";
-import { log as log2 } from "@dxos/log";
-
-// src/segment/base.ts
-import { log } from "@dxos/log";
-
-// src/segment/types.ts
-var TelemetryEvent = /* @__PURE__ */ function(TelemetryEvent2) {
-  TelemetryEvent2["ACTION"] = "action";
-  TelemetryEvent2["METRICS"] = "metrics";
-  return TelemetryEvent2;
-}({});
-
-// src/segment/base.ts
-var __dxlog_file = "/__w/dxos/dxos/packages/sdk/observability/src/segment/base.ts";
-var getIdentityOptions = ({ did, installationId }) => {
-  if (!did && !installationId) {
-    log.warn("No telemetry identifier provided.", void 0, {
-      F: __dxlog_file,
-      L: 23,
-      S: void 0,
-      C: (f, a) => f(...a)
-    });
-  }
-  return {
-    userId: did,
-    anonymousId: installationId
-  };
-};
-var AbstractSegmentTelemetry = class {
-  constructor(_getTags) {
-    this._getTags = _getTags;
-  }
-  createPageProps(options) {
-    const { properties, ...rest } = options;
-    return {
-      ...getIdentityOptions(options),
-      ...rest,
-      properties: {
-        common: this._getTags(),
-        custom: properties
-      }
-    };
-  }
-  createTrackProps(options) {
-    const { event, action, properties, ...rest } = options;
-    return {
-      ...getIdentityOptions(options),
-      ...rest,
-      event: event ?? TelemetryEvent.ACTION,
-      properties: {
-        action,
-        common: this._getTags(),
-        custom: properties
-      }
-    };
-  }
-};
-
-// src/segment/browser.ts
-var __dxlog_file2 = "/__w/dxos/dxos/packages/sdk/observability/src/segment/browser.ts";
-var SegmentTelemetry = class extends AbstractSegmentTelemetry {
-  constructor({ apiKey, batchSize, getTags }) {
-    super(getTags);
-    try {
-      const contents = snippet.min({
-        apiKey,
-        page: false
-      });
-      const script = document.createElement("script");
-      script.innerHTML = contents;
-      document.body.append(script);
-    } catch (err) {
-      log2.catch("failed to initialize telemetry", err, {
-        F: __dxlog_file2,
-        L: 27,
-        S: this,
-        C: (f, a) => f(...a)
-      });
-    }
-  }
-  identify(options) {
-    try {
-      window.analytics?.identify(options.userId, options.traits);
-    } catch (err) {
-      log2.catch("failed to identify", err, {
-        F: __dxlog_file2,
-        L: 35,
-        S: this,
-        C: (f, a) => f(...a)
-      });
-    }
-  }
-  page(options) {
-    try {
-      const props = this.createPageProps(options);
-      window.analytics?.page(props.category, props.name, props.properties);
-    } catch (err) {
-      log2.catch("failed to track page", err, {
-        F: __dxlog_file2,
-        L: 44,
-        S: this,
-        C: (f, a) => f(...a)
-      });
-    }
-  }
-  track(options) {
-    try {
-      const props = this.createTrackProps(options);
-      window.analytics?.track(props.event, props.properties);
-    } catch (err) {
-      log2.catch("failed to track event", err, {
-        F: __dxlog_file2,
-        L: 53,
-        S: this,
-        C: (f, a) => f(...a)
-      });
-    }
-  }
-  async flush() {
-    try {
-      await window.analytics?.flush((err) => {
-        captureException(err);
-      });
-    } catch (err) {
-      log2.catch("failed to flush telemetry", err, {
-        F: __dxlog_file2,
-        L: 63,
-        S: this,
-        C: (f, a) => f(...a)
-      });
-    }
-  }
-  async close() {
-  }
-};
-
-export {
-  TelemetryEvent,
-  SegmentTelemetry
-};
-//# sourceMappingURL=chunk-MWTIKIBZ.mjs.map

package/dist/lib/browser/chunk-MWTIKIBZ.mjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/segment/browser.ts", "../../../src/segment/base.ts", "../../../src/segment/types.ts"],
-  "sourcesContent": ["//\n// Copyright 2022 DXOS.org\n//\n\nimport { type IdentifyParams } from '@segment/analytics-node';\nimport snippet from '@segment/snippet';\n\nimport { log } from '@dxos/log';\n\nimport { AbstractSegmentTelemetry } from './base';\nimport type { TrackOptions, SegmentTelemetryOptions, PageOptions } from './types';\nimport { captureException } from '../sentry';\n\n/**\n * Browser telemetry.\n */\n// https://segment.com/docs/connections/sources/catalog/libraries/website/javascript/#basic-tracking-methods\nexport class SegmentTelemetry extends AbstractSegmentTelemetry {\n  constructor({ apiKey, batchSize, getTags }: SegmentTelemetryOptions) {\n    super(getTags);\n    try {\n      const contents = snippet.min({ apiKey, page: false });\n      const script = document.createElement('script');\n      script.innerHTML = contents;\n      document.body.append(script);\n    } catch (err) {\n      log.catch('failed to initialize telemetry', err);\n    }\n  }\n\n  identify(options: IdentifyParams): void {\n    try {\n      (window as any).analytics?.identify(options.userId, options.traits);\n    } catch (err) {\n      log.catch('failed to identify', err);\n    }\n  }\n\n  page(options: PageOptions): void {\n    try {\n      const props = this.createPageProps(options);\n      (window as any).analytics?.page(props.category, props.name, props.properties);\n    } catch (err) {\n      log.catch('failed to track page', err);\n    }\n  }\n\n  track(options: TrackOptions): void {\n    try {\n      const props = this.createTrackProps(options);\n      (window as any).analytics?.track(props.event, props.properties);\n    } catch (err) {\n      log.catch('failed to track event', err);\n    }\n  }\n\n  async flush(): Promise<void> {\n    try {\n      await (window as any).analytics?.flush((err: any) => {\n        captureException(err);\n      });\n    } catch (err) {\n      log.catch('failed to flush telemetry', err);\n    }\n  }\n\n  async close(): Promise<void> {}\n}\n", "//\n// Copyright 2025 DXOS.org\n//\n\nimport { type TrackParams, type PageParams, type IdentifyParams } from '@segment/analytics-node';\n\nimport { log } from '@dxos/log';\n\nimport {\n  type IdentityOptions,\n  type PageOptions,\n  type SegmentIdentityOptions,\n  type Tags,\n  TelemetryEvent,\n  type TrackOptions,\n} from './types';\n\n/**\n * NOTE: Segment provides a default ID if we don't provide one.\n */\nconst getIdentityOptions = ({ did, installationId }: IdentityOptions): SegmentIdentityOptions => {\n  if (!did && !installationId) {\n    log.warn('No telemetry identifier provided.');\n  }\n\n  return {\n    userId: did,\n    anonymousId: installationId,\n  } as SegmentIdentityOptions;\n};\n\n/**\n * Base class for Node and BrowserSegment telemetry.\n */\nexport abstract class AbstractSegmentTelemetry {\n  constructor(private readonly _getTags: () => Tags) {}\n\n  abstract identify(options: IdentifyParams): void;\n\n  abstract page(options: PageOptions): void;\n\n  abstract track(options: TrackOptions): void;\n\n  protected createPageProps(options: PageOptions): PageParams {\n    const { properties, ...rest } = options;\n    return {\n      ...getIdentityOptions(options),\n      ...rest,\n      properties: {\n        common: this._getTags(),\n        custom: properties,\n      },\n    };\n  }\n\n  protected createTrackProps(options: TrackOptions): TrackParams {\n    const { event, action, properties, ...rest } = options;\n    return {\n      ...getIdentityOptions(options),\n      ...rest,\n      event: event ?? TelemetryEvent.ACTION,\n      properties: {\n        action,\n        common: this._getTags(),\n        custom: properties,\n      },\n    };\n  }\n}\n", "//\n// Copyright 2022 DXOS.org\n//\n\nexport type Tags = Record<string, string>;\n\nexport type SegmentTelemetryOptions = {\n  apiKey?: string;\n  batchSize?: number;\n  enable?: boolean;\n  getTags: () => Tags;\n};\n\n// Copied from @segment/analytics-node.\nexport type SegmentIdentityOptions =\n  | { userId: string; anonymousId?: string }\n  | { userId?: string; anonymousId: string };\n\n// TODO(burdon): Should require one or the other.\nexport type IdentityOptions = { did?: string; installationId?: string };\n\nexport type CommonOptions = IdentityOptions & {\n  timestamp?: Date;\n  properties?: Record<string, unknown>;\n};\n\n/**\n * Page views.\n * https://segment.com/docs/connections/sources/catalog/libraries/server/node/#page\n */\nexport type PageOptions = CommonOptions & {\n  category?: string;\n  name?: string;\n};\n\n/**\n * Track actions.\n * https://segment.com/docs/connections/sources/catalog/libraries/server/node/#track\n */\nexport type TrackOptions = CommonOptions & {\n  event?: TelemetryEvent;\n  action: string;\n};\n\n/**\n * Each event will be mapped to a different Postgres table via segment.\n */\nexport enum TelemetryEvent {\n  /**\n   * Use actions.\n   */\n  ACTION = 'action',\n  /**\n   * High-volume technical metrics.\n   */\n  METRICS = 'metrics',\n}\n"],
-  "mappings": ";;;;;AAKA,OAAOA,aAAa;AAEpB,SAASC,OAAAA,YAAW;;;ACDpB,SAASC,WAAW;;;ACyCb,IAAKC,iBAAAA,yBAAAA,iBAAAA;AAGT,EAAAA,gBAAA,QAAA,IAAA;AAIA,EAAAA,gBAAA,SAAA,IAAA;SAPSA;;;;;AD3BZ,IAAMC,qBAAqB,CAAC,EAAEC,KAAKC,eAAc,MAAmB;AAClE,MAAI,CAACD,OAAO,CAACC,gBAAgB;AAC3BC,QAAIC,KAAK,qCAAA,QAAA;;;;;;EACX;AAEA,SAAO;IACLC,QAAQJ;IACRK,aAAaJ;EACf;AACF;AAKO,IAAeK,2BAAf,MAAeA;EACpB,YAA6BC,UAAsB;SAAtBA,WAAAA;EAAuB;EAQ1CC,gBAAgBC,SAAkC;AAC1D,UAAM,EAAEC,YAAY,GAAGC,KAAAA,IAASF;AAChC,WAAO;MACL,GAAGV,mBAAmBU,OAAAA;MACtB,GAAGE;MACHD,YAAY;QACVE,QAAQ,KAAKL,SAAQ;QACrBM,QAAQH;MACV;IACF;EACF;EAEUI,iBAAiBL,SAAoC;AAC7D,UAAM,EAAEM,OAAOC,QAAQN,YAAY,GAAGC,KAAAA,IAASF;AAC/C,WAAO;MACL,GAAGV,mBAAmBU,OAAAA;MACtB,GAAGE;MACHI,OAAOA,SAASE,eAAeC;MAC/BR,YAAY;QACVM;QACAJ,QAAQ,KAAKL,SAAQ;QACrBM,QAAQH;MACV;IACF;EACF;AACF;;;;ADnDO,IAAMS,mBAAN,cAA+BC,yBAAAA;EACpC,YAAY,EAAEC,QAAQC,WAAWC,QAAO,GAA6B;AACnE,UAAMA,OAAAA;AACN,QAAI;AACF,YAAMC,WAAWC,QAAQC,IAAI;QAAEL;QAAQM,MAAM;MAAM,CAAA;AACnD,YAAMC,SAASC,SAASC,cAAc,QAAA;AACtCF,aAAOG,YAAYP;AACnBK,eAASG,KAAKC,OAAOL,MAAAA;IACvB,SAASM,KAAK;AACZC,MAAAA,KAAIC,MAAM,kCAAkCF,KAAAA;;;;;;IAC9C;EACF;EAEAG,SAASC,SAA+B;AACtC,QAAI;AACDC,aAAeC,WAAWH,SAASC,QAAQG,QAAQH,QAAQI,MAAM;IACpE,SAASR,KAAK;AACZC,MAAAA,KAAIC,MAAM,sBAAsBF,KAAAA;;;;;;IAClC;EACF;EAEAP,KAAKW,SAA4B;AAC/B,QAAI;AACF,YAAMK,QAAQ,KAAKC,gBAAgBN,OAAAA;AAClCC,aAAeC,WAAWb,KAAKgB,MAAME,UAAUF,MAAMG,MAAMH,MAAMI,UAAU;IAC9E,SAASb,KAAK;AACZC,MAAAA,KAAIC,MAAM,wBAAwBF,KAAAA;;;;;;IACpC;EACF;EAEAc,MAAMV,SAA6B;AACjC,QAAI;AACF,YAAMK,QAAQ,KAAKM,iBAAiBX,OAAAA;AACnCC,aAAeC,WAAWQ,MAAML,MAAMO,OAAOP,MAAMI,UAAU;IAChE,SAASb,KAAK;AACZC,MAAAA,KAAIC,MAAM,yBAAyBF,KAAAA;;;;;;IACrC;EACF;EAEA,MAAMiB,QAAuB;AAC3B,QAAI;AACF,YAAOZ,OAAeC,WAAWW,MAAM,CAACjB,QAAAA;AACtCkB,yBAAiBlB,GAAAA;MACnB,CAAA;IACF,SAASA,KAAK;AACZC,MAAAA,KAAIC,MAAM,6BAA6BF,KAAAA;;;;;;IACzC;EACF;EAEA,MAAMmB,QAAuB;EAAC;AAChC;",
-  "names": ["snippet", "log", "log", "TelemetryEvent", "getIdentityOptions", "did", "installationId", "log", "warn", "userId", "anonymousId", "AbstractSegmentTelemetry", "_getTags", "createPageProps", "options", "properties", "rest", "common", "custom", "createTrackProps", "event", "action", "TelemetryEvent", "ACTION", "SegmentTelemetry", "AbstractSegmentTelemetry", "apiKey", "batchSize", "getTags", "contents", "snippet", "min", "page", "script", "document", "createElement", "innerHTML", "body", "append", "err", "log", "catch", "identify", "options", "window", "analytics", "userId", "traits", "props", "createPageProps", "category", "name", "properties", "track", "createTrackProps", "event", "flush", "captureException", "close"]
-}