@dxos/observability 0.3.11-main.547da9d → 0.3.11-main.5cbcf4e

package/README.md

@@ -1,4 +1,4 @@
-#
+# Observability
 
 This package provides isomorphic observability capabilities for the DXOS platform.
 
@@ -7,7 +7,7 @@ This package provides isomorphic observability capabilities for the DXOS platfor
 * Telemetry logging for product usage statistics.
 
 The observability package provides the following facilities to support these capabilities:
-* Secrets loading
+* Secrets loading for API keys for SaaS services
 * Common tag handling
 * Common group, opt-in handling
 
@@ -17,9 +17,14 @@ This is currently implemented using the following providers:
 * Time-series data = Datadog
 * Telemetry logging - Segment
 
-# Datadog
+# Usage and Configuration
+Entry points are provided in [helpers/](src/helpers/), which contain functionality to persist the configuration.
 
-## Usage
+`Mode` can be `disabled`, `basic`, and `full`. `basic` and `full` currently have the same behavior, but will control the exposure of public identity keys in the future. See https://github.com/orgs/dxos/discussions/5438
+
+`Group` is intended to be used to distinguish different deployments and usages of the same application, such as internal and external deployments and testing of the observability infrastructure.
+
+`Namespace` is used by the provider backends to distinguish different applications and services.
 
 # TODO
 * Stabilize API and further decouple it from the underlying providers

package/dist/lib/browser/{chunk-2J5YS65Q.mjs → chunk-6ZTMPKEG.mjs}

@@ -54,7 +54,7 @@ var DatadogMetrics = class {
       ]
     });
     const mergedTags = Object.entries({
-      ...Object.fromEntries(this._getTags().entries()),
+      ...this._getTags(),
       ...tags
     }).map(([key, value2]) => `${key}:${value2}`);
     log2("datadog gauge", {
@@ -63,7 +63,7 @@ var DatadogMetrics = class {
       tags: mergedTags
     }, {
       F: __dxlog_file2,
-      L: 42,
+      L: 40,
       S: this,
       C: (f, a) => f(...a)
     });
@@ -78,4 +78,4 @@ export {
   defaultOptions,
   DatadogMetrics
 };
-//# sourceMappingURL=chunk-2J5YS65Q.mjs.map
+//# sourceMappingURL=chunk-6ZTMPKEG.mjs.map

package/dist/lib/browser/{chunk-2J5YS65Q.mjs.map → chunk-6ZTMPKEG.mjs.map}

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../src/datadog/browser.ts", "../../../src/datadog/metrics.ts"],
-  "sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport { invariant } from '@dxos/invariant';\nimport { log } from '@dxos/log';\n\nimport { type DatadogOptions } from './metrics';\n\nexport const defaultOptions = ({ apiKey, config, host }: DatadogOptions) => {\n  const corsProxy = config.get('runtime.app.env.DX_DATADOG_PROXY');\n  invariant(corsProxy, 'need DX_DATADOG_PROXY for CORS proxy');\n  return {\n    apiKey,\n    host,\n    site: corsProxy,\n    onError: (err: any) => {\n      log.info('Datadog error', { err });\n    },\n  };\n};\n", "//\n// Copyright 2023 DXOS.org\n//\n\nimport * as Datadog from 'datadog-metrics';\nimport debug from 'debug';\n\nimport { type Config } from '@dxos/client';\nimport { invariant } from '@dxos/invariant';\nimport { log } from '@dxos/log';\n\nimport { defaultOptions } from './node';\n// import { tags as globalTags } from '../tags';\n\nexport type DatadogOptions = {\n  apiKey: string;\n  host?: string;\n  site?: String;\n  getTags: () => Map<string, string>;\n  // needed to read CORS proxy\n  config: Config;\n};\n\ndebug.enable('metrics');\n\nexport class DatadogMetrics {\n  private _datadogmetrics?: any;\n  private _getTags: () => Map<string, string>;\n\n  constructor(options: DatadogOptions) {\n    this._getTags = options.getTags;\n    this._datadogmetrics = Datadog;\n\n    this._datadogmetrics.init(defaultOptions(options));\n  }\n\n  gauge(name: string, value: number, tags?: any) {\n    invariant(this._datadogmetrics, 'Datadog not initialized');\n    const mergedTags = Object.entries({ ...Object.fromEntries(this._getTags().entries()), ...tags }).map(\n      ([key, value]) => `${key}:${value}`,\n    );\n    log('datadog gauge', { name, value, tags: mergedTags });\n    this._datadogmetrics.gauge(name, value, mergedTags);\n  }\n\n  flush() {\n    this._datadogmetrics.flush();\n  }\n}\n"],
-  "mappings": ";AAIA,SAASA,iBAAiB;AAC1B,SAASC,WAAW;;AAIb,IAAMC,iBAAiB,CAAC,EAAEC,QAAQC,QAAQC,KAAI,MAAkB;AACrE,QAAMC,YAAYF,OAAOG,IAAI,kCAAA;AAC7BP,YAAUM,WAAW,wCAAA;;;;;;;;;AACrB,SAAO;IACLH;IACAE;IACAG,MAAMF;IACNG,SAAS,CAACC,QAAAA;AACRT,UAAIU,KAAK,iBAAiB;QAAED;MAAI,GAAA;;;;;;IAClC;EACF;AACF;;;AChBA,YAAYE,aAAa;AACzB,OAAOC,WAAW;AAGlB,SAASC,aAAAA,kBAAiB;AAC1B,SAASC,OAAAA,YAAW;;AAcpBC,MAAMC,OAAO,SAAA;AAEN,IAAMC,iBAAN,MAAMA;EAIXC,YAAYC,SAAyB;AACnC,SAAKC,WAAWD,QAAQE;AACxB,SAAKC,kBAAkBC;AAEvB,SAAKD,gBAAgBE,KAAKC,eAAeN,OAAAA,CAAAA;EAC3C;EAEAO,MAAMC,MAAcC,OAAeC,MAAY;AAC7CC,IAAAA,WAAU,KAAKR,iBAAiB,2BAAA;;;;;;;;;AAChC,UAAMS,aAAaC,OAAOC,QAAQ;MAAE,GAAGD,OAAOE,YAAY,KAAKd,SAAQ,EAAGa,QAAO,CAAA;MAAK,GAAGJ;IAAK,CAAA,EAAGM,IAC/F,CAAC,CAACC,KAAKR,MAAAA,MAAW,GAAGQ,GAAAA,IAAOR,MAAAA,EAAO;AAErCS,IAAAA,KAAI,iBAAiB;MAAEV;MAAMC;MAAOC,MAAME;IAAW,GAAA;;;;;;AACrD,SAAKT,gBAAgBI,MAAMC,MAAMC,OAAOG,UAAAA;EAC1C;EAEAO,QAAQ;AACN,SAAKhB,gBAAgBgB,MAAK;EAC5B;AACF;",
-  "names": ["invariant", "log", "defaultOptions", "apiKey", "config", "host", "corsProxy", "get", "site", "onError", "err", "info", "Datadog", "debug", "invariant", "log", "debug", "enable", "DatadogMetrics", "constructor", "options", "_getTags", "getTags", "_datadogmetrics", "Datadog", "init", "defaultOptions", "gauge", "name", "value", "tags", "invariant", "mergedTags", "Object", "entries", "fromEntries", "map", "key", "log", "flush"]
+  "sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport { invariant } from '@dxos/invariant';\nimport { log } from '@dxos/log';\n\nimport { type DatadogOptions } from './metrics';\n\nexport const defaultOptions = ({ apiKey, config, host }: DatadogOptions) => {\n  const corsProxy = config.get('runtime.app.env.DX_DATADOG_PROXY');\n  invariant(corsProxy, 'need DX_DATADOG_PROXY for CORS proxy');\n  return {\n    apiKey,\n    host,\n    site: corsProxy,\n    onError: (err: any) => {\n      log.info('Datadog error', { err });\n    },\n  };\n};\n", "//\n// Copyright 2023 DXOS.org\n//\n\nimport * as Datadog from 'datadog-metrics';\nimport debug from 'debug';\n\nimport { type Config } from '@dxos/client';\nimport { invariant } from '@dxos/invariant';\nimport { log } from '@dxos/log';\n\nimport { defaultOptions } from './node';\n// import { tags as globalTags } from '../tags';\n\nexport type DatadogOptions = {\n  apiKey: string;\n  host?: string;\n  site?: String;\n  getTags: () => { [key: string]: string };\n  // needed to read CORS proxy\n  config: Config;\n};\n\ndebug.enable('metrics');\n\nexport class DatadogMetrics {\n  private _datadogmetrics?: any;\n  private _getTags: () => { [key: string]: string };\n\n  constructor(options: DatadogOptions) {\n    this._getTags = options.getTags;\n    this._datadogmetrics = Datadog;\n\n    this._datadogmetrics.init(defaultOptions(options));\n  }\n\n  gauge(name: string, value: number, tags?: any) {\n    invariant(this._datadogmetrics, 'Datadog not initialized');\n    const mergedTags = Object.entries({ ...this._getTags(), ...tags }).map(([key, value]) => `${key}:${value}`);\n    log('datadog gauge', { name, value, tags: mergedTags });\n    this._datadogmetrics.gauge(name, value, mergedTags);\n  }\n\n  flush() {\n    this._datadogmetrics.flush();\n  }\n}\n"],
+  "mappings": ";AAIA,SAASA,iBAAiB;AAC1B,SAASC,WAAW;;AAIb,IAAMC,iBAAiB,CAAC,EAAEC,QAAQC,QAAQC,KAAI,MAAkB;AACrE,QAAMC,YAAYF,OAAOG,IAAI,kCAAA;AAC7BP,YAAUM,WAAW,wCAAA;;;;;;;;;AACrB,SAAO;IACLH;IACAE;IACAG,MAAMF;IACNG,SAAS,CAACC,QAAAA;AACRT,UAAIU,KAAK,iBAAiB;QAAED;MAAI,GAAA;;;;;;IAClC;EACF;AACF;;;AChBA,YAAYE,aAAa;AACzB,OAAOC,WAAW;AAGlB,SAASC,aAAAA,kBAAiB;AAC1B,SAASC,OAAAA,YAAW;;AAcpBC,MAAMC,OAAO,SAAA;AAEN,IAAMC,iBAAN,MAAMA;EAIXC,YAAYC,SAAyB;AACnC,SAAKC,WAAWD,QAAQE;AACxB,SAAKC,kBAAkBC;AAEvB,SAAKD,gBAAgBE,KAAKC,eAAeN,OAAAA,CAAAA;EAC3C;EAEAO,MAAMC,MAAcC,OAAeC,MAAY;AAC7CC,IAAAA,WAAU,KAAKR,iBAAiB,2BAAA;;;;;;;;;AAChC,UAAMS,aAAaC,OAAOC,QAAQ;MAAE,GAAG,KAAKb,SAAQ;MAAI,GAAGS;IAAK,CAAA,EAAGK,IAAI,CAAC,CAACC,KAAKP,MAAAA,MAAW,GAAGO,GAAAA,IAAOP,MAAAA,EAAO;AAC1GQ,IAAAA,KAAI,iBAAiB;MAAET;MAAMC;MAAOC,MAAME;IAAW,GAAA;;;;;;AACrD,SAAKT,gBAAgBI,MAAMC,MAAMC,OAAOG,UAAAA;EAC1C;EAEAM,QAAQ;AACN,SAAKf,gBAAgBe,MAAK;EAC5B;AACF;",
+  "names": ["invariant", "log", "defaultOptions", "apiKey", "config", "host", "corsProxy", "get", "site", "onError", "err", "info", "Datadog", "debug", "invariant", "log", "debug", "enable", "DatadogMetrics", "constructor", "options", "_getTags", "getTags", "_datadogmetrics", "Datadog", "init", "defaultOptions", "gauge", "name", "value", "tags", "invariant", "mergedTags", "Object", "entries", "map", "key", "log", "flush"]
 }

package/dist/lib/browser/{chunk-ROSK6U3K.mjs → chunk-HPGC4HC7.mjs}

@@ -29,7 +29,7 @@ var SegmentTelemetry = class {
   page({ identityId: userId, ...options } = {}) {
     try {
       window.analytics?.page({
-        context: Object.fromEntries(this._getTags().entries()),
+        context: this._getTags(),
         ...options,
         userId
       });
@@ -46,7 +46,7 @@ var SegmentTelemetry = class {
     try {
       options.properties = {
         ...options.properties,
-        ...Object.fromEntries(this._getTags().entries())
+        ...this._getTags()
       };
       window.analytics?.track({
         ...options,
@@ -80,4 +80,4 @@ var SegmentTelemetry = class {
 export {
   SegmentTelemetry
 };
-//# sourceMappingURL=chunk-ROSK6U3K.mjs.map
+//# sourceMappingURL=chunk-HPGC4HC7.mjs.map

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

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/segment/browser.ts"],
+  "sourcesContent": ["//\n// Copyright 2022 DXOS.org\n//\n\nimport snippet from '@segment/snippet';\n\nimport { log } from '@dxos/log';\n\nimport type { EventOptions, SegmentTelemetryOptions, PageOptions } from './types';\nimport { captureException } from '../sentry';\n\nexport class SegmentTelemetry {\n  private _getTags: () => { [key: string]: string };\n\n  constructor({ apiKey, batchSize, getTags }: SegmentTelemetryOptions) {\n    this._getTags = getTags;\n    try {\n      const contents = snippet.min({\n        apiKey,\n        page: false,\n      });\n\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  page({ identityId: userId, ...options }: PageOptions = {}) {\n    try {\n      (window as any).analytics?.page({\n        context: this._getTags(),\n        ...options,\n        userId,\n      });\n    } catch (err) {\n      log.catch('Failed to track page', err);\n    }\n  }\n\n  event({ identityId: userId, name: event, ...options }: EventOptions) {\n    try {\n      options.properties = {\n        ...options.properties,\n        ...this._getTags(),\n      };\n      (window as any).analytics?.track({\n        ...options,\n        event,\n      });\n    } catch (err) {\n      log.catch('Failed to track event', err);\n    }\n  }\n\n  async flush() {\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"],
+  "mappings": ";;;;;AAIA,OAAOA,aAAa;AAEpB,SAASC,WAAW;;AAKb,IAAMC,mBAAN,MAAMA;EAGXC,YAAY,EAAEC,QAAQC,WAAWC,QAAO,GAA6B;AACnE,SAAKC,WAAWD;AAChB,QAAI;AACF,YAAME,WAAWC,QAAQC,IAAI;QAC3BN;QACAO,MAAM;MACR,CAAA;AAEA,YAAMC,SAASC,SAASC,cAAc,QAAA;AACtCF,aAAOG,YAAYP;AACnBK,eAASG,KAAKC,OAAOL,MAAAA;IACvB,SAASM,KAAK;AACZC,UAAIC,MAAM,kCAAkCF,KAAAA;;;;;;IAC9C;EACF;EAEAP,KAAK,EAAEU,YAAYC,QAAQ,GAAGC,QAAAA,IAAyB,CAAC,GAAG;AACzD,QAAI;AACDC,aAAeC,WAAWd,KAAK;QAC9Be,SAAS,KAAKnB,SAAQ;QACtB,GAAGgB;QACHD;MACF,CAAA;IACF,SAASJ,KAAK;AACZC,UAAIC,MAAM,wBAAwBF,KAAAA;;;;;;IACpC;EACF;EAEAS,MAAM,EAAEN,YAAYC,QAAQM,MAAMD,OAAO,GAAGJ,QAAAA,GAAyB;AACnE,QAAI;AACFA,cAAQM,aAAa;QACnB,GAAGN,QAAQM;QACX,GAAG,KAAKtB,SAAQ;MAClB;AACCiB,aAAeC,WAAWK,MAAM;QAC/B,GAAGP;QACHI;MACF,CAAA;IACF,SAAST,KAAK;AACZC,UAAIC,MAAM,yBAAyBF,KAAAA;;;;;;IACrC;EACF;EAEA,MAAMa,QAAQ;AACZ,QAAI;AACF,YAAOP,OAAeC,WAAWM,MAAM,CAACb,QAAAA;AACtCc,yBAAiBd,GAAAA;MACnB,CAAA;IACF,SAASA,KAAK;AACZC,UAAIC,MAAM,6BAA6BF,KAAAA;;;;;;IACzC;EACF;AACF;",
+  "names": ["snippet", "log", "SegmentTelemetry", "constructor", "apiKey", "batchSize", "getTags", "_getTags", "contents", "snippet", "min", "page", "script", "document", "createElement", "innerHTML", "body", "append", "err", "log", "catch", "identityId", "userId", "options", "window", "analytics", "context", "event", "name", "properties", "track", "flush", "captureException"]
+}