@dxos/observability 0.8.3 → 0.8.4-main.1068cf700f

package/dist/types/src/providers/client-observability.js

@@ -0,0 +1,200 @@
+//
+// Copyright 2025 DXOS.org
+//
+import * as Effect from 'effect/Effect';
+import { Event, scheduleTaskInterval } from '@dxos/async';
+import { DeviceKind } from '@dxos/client/halo';
+import { Context } from '@dxos/context';
+import { invariant } from '@dxos/invariant';
+import { log } from '@dxos/log';
+import { ConnectionState, Platform } from '@dxos/protocols/proto/dxos/client/services';
+const SPACE_METRICS_MIN_INTERVAL = 1000 * 60 * 10; // 10 minutes
+const NETWORK_METRICS_MIN_INTERVAL = 1000 * 60 * 10; // 10 minutes
+const RUNTIME_METRICS_MIN_INTERVAL = 1000 * 60 * 10; // 10 minutes
+// TODO(wittjosiah): Improve privacy of telemetry identifiers.
+//  - Identifier should be generated client-side with no attachment to identity.
+//  - Identifier can then be reset by user.
+//  - Identifier can be synced via HALO to allow for correlation of events bewteen devices.
+//  - Identifier should also be stored outside of HALO such that it is available immediately on startup.
+/** Subscribes to identity and device changes and sets observability tags accordingly. */
+export const identityProvider = (clientServices) => Effect.fn(function* (observability) {
+    // TODO(wittjosiah): RPC subscribe returns void; cleanup requires upstream API change.
+    clientServices.IdentityService.queryIdentity().subscribe((idqr) => {
+        if (!idqr?.identity?.did) {
+            return;
+        }
+        observability.identify(idqr.identity.did);
+        observability.setTags({ did: idqr.identity.did });
+    });
+    // TODO(wittjosiah): RPC subscribe returns void; cleanup requires upstream API change.
+    clientServices.DevicesService.queryDevices().subscribe((dqr) => {
+        if (!dqr?.devices || dqr.devices.length === 0) {
+            return;
+        }
+        const thisDevice = dqr.devices.find((device) => device.kind === DeviceKind.CURRENT);
+        if (!thisDevice) {
+            return;
+        }
+        observability.setTags({ deviceKey: thisDevice.deviceKey.truncate() });
+        if (thisDevice.profile?.label) {
+            observability.setTags({ deviceProfile: thisDevice.profile.label });
+        }
+    });
+});
+/** Periodically publishes network connection and buffer metrics. */
+export const networkMetricsProvider = (clientServices) => Effect.fn(function* (observability) {
+    const ctx = new Context();
+    let lastNetworkStatus;
+    // TODO(nf): support type in debounce()
+    const updateSignalMetrics = new Event().debounce(NETWORK_METRICS_MIN_INTERVAL);
+    updateSignalMetrics.on(ctx, async () => {
+        log('send signal metrics');
+        lastNetworkStatus?.signaling?.forEach(({ server, state }) => {
+            observability.metrics.gauge('dxos.client.network.signal.connectionState', state, { server });
+        });
+        let swarmCount = 0;
+        const connectionStates = new Map();
+        for (const state in ConnectionState) {
+            connectionStates.set(state, 0);
+        }
+        let totalReadBufferSize = 0;
+        let totalWriteBufferSize = 0;
+        let totalChannelBufferSize = 0;
+        lastNetworkStatus?.connectionInfo?.forEach((connectionInfo) => {
+            swarmCount++;
+            for (const conn of connectionInfo.connections ?? []) {
+                connectionStates.set(conn.state, (connectionStates.get(conn.state) ?? 0) + 1);
+                totalReadBufferSize += conn.readBufferSize ?? 0;
+                totalWriteBufferSize += conn.writeBufferSize ?? 0;
+                for (const stream of conn.streams ?? []) {
+                    totalChannelBufferSize += stream.writeBufferSize ?? 0;
+                }
+            }
+            observability.metrics.gauge('dxos.client.network.swarm.count', swarmCount);
+            for (const state in ConnectionState) {
+                observability.metrics.gauge('dxos.client.network.connection.count', connectionStates.get(state) ?? 0, {
+                    state,
+                });
+            }
+            observability.metrics.gauge('dxos.client.network.totalReadBufferSize', totalReadBufferSize);
+            observability.metrics.gauge('dxos.client.network.totalWriteBufferSize', totalWriteBufferSize);
+            observability.metrics.gauge('dxos.client.network.totalChannelBufferSize', totalChannelBufferSize);
+        });
+    });
+    clientServices.NetworkService.queryStatus().subscribe((networkStatus) => {
+        lastNetworkStatus = networkStatus;
+        updateSignalMetrics.emit();
+    });
+    scheduleTaskInterval(ctx, async () => updateSignalMetrics.emit(), NETWORK_METRICS_MIN_INTERVAL);
+    return async () => {
+        await ctx.dispose();
+    };
+});
+/** Periodically publishes platform and heap memory metrics. */
+export const runtimeMetricsProvider = (clientServices) => Effect.fn(function* (observability) {
+    const ctx = new Context();
+    const platform = yield* Effect.promise(() => clientServices.SystemService.getPlatform());
+    invariant(platform, 'platform is required');
+    observability.setTags({
+        platformType: Platform.PLATFORM_TYPE[platform.type].toLowerCase(),
+        platform: platform.platform,
+        arch: platform.arch,
+        runtime: platform.runtime,
+    });
+    scheduleTaskInterval(ctx, async () => {
+        if (clientServices.constructor.name === 'WorkerClientServices') {
+            const memory = window.performance.memory;
+            if (memory) {
+                observability.metrics.gauge('dxos.client.runtime.heapTotal', memory.totalJSHeapSize);
+                observability.metrics.gauge('dxos.client.runtime.heapUsed', memory.usedJSHeapSize);
+                observability.metrics.gauge('dxos.client.runtime.heapSizeLimit', memory.jsHeapSizeLimit);
+            }
+        }
+        clientServices.SystemService?.getPlatform()
+            .then((platform) => {
+            if (platform.memory) {
+                observability.metrics.gauge('dxos.client.services.runtime.rss', platform.memory.rss);
+                observability.metrics.gauge('dxos.client.services.runtime.heapTotal', platform.memory.heapTotal);
+                observability.metrics.gauge('dxos.client.services.runtime.heapUsed', platform.memory.heapUsed);
+            }
+        })
+            .catch((error) => log('platform error', { error }));
+    }, RUNTIME_METRICS_MIN_INTERVAL);
+    return async () => {
+        await ctx.dispose();
+    };
+});
+/** Periodically publishes space membership, object count, and pipeline progress metrics. */
+export const spacesMetricsProvider = (client) => Effect.fn(function* (observability) {
+    const ctx = new Context();
+    // TODO(nf): update subscription on new spaces
+    const spaces = client.spaces.get();
+    const subscriptions = new Map();
+    ctx.onDispose(() => subscriptions.forEach((subscription) => subscription.unsubscribe()));
+    const updateSpaceMetrics = new Event().debounce(SPACE_METRICS_MIN_INTERVAL);
+    updateSpaceMetrics.on(ctx, async () => {
+        log('send space metrics');
+        for (const data of mapSpaces(spaces, { truncateKeys: true })) {
+            observability.metrics.gauge('dxos.client.space.members', data.members, { key: data.key });
+            observability.metrics.gauge('dxos.client.space.objects', data.objects, { key: data.key });
+            observability.metrics.gauge('dxos.client.space.epoch', data.epoch, { key: data.key });
+            observability.metrics.gauge('dxos.client.space.currentDataMutations', data.currentDataMutations, {
+                key: data.key,
+            });
+        }
+    });
+    const subscribeToSpaceUpdate = (space) => space.pipeline.subscribe({
+        next: () => {
+            updateSpaceMetrics.emit();
+        },
+    });
+    spaces.forEach((space) => {
+        subscriptions.set(space.id, subscribeToSpaceUpdate(space));
+    });
+    client.spaces.subscribe({
+        next: async (spaces) => {
+            spaces
+                .filter((space) => !subscriptions.has(space.id))
+                .forEach((space) => {
+                subscriptions.set(space.id, subscribeToSpaceUpdate(space));
+            });
+        },
+    });
+    scheduleTaskInterval(ctx, async () => updateSpaceMetrics.emit(), SPACE_METRICS_MIN_INTERVAL);
+    return async () => {
+        await ctx.dispose();
+    };
+});
+const mapSpaces = (spaces, options = { verbose: false, truncateKeys: false }) => {
+    return spaces.map((space) => {
+        // TODO(burdon): Factor out.
+        // TODO(burdon): Agent needs to restart before `ready` is available.
+        const { open, ready } = space.internal.data.metrics ?? {};
+        const startup = open && ready && ready.getTime() - open.getTime();
+        // TODO(burdon): Get feeds from client-services if verbose (factor out from devtools/diagnostics).
+        // const host = client.services.services.DevtoolsHost!;
+        const pipeline = space.internal.data.pipeline;
+        const startDataMutations = pipeline?.currentEpoch?.subject.assertion.timeframe.totalMessages() ?? 0;
+        const epoch = pipeline?.currentEpoch?.subject.assertion.number;
+        // const appliedEpoch = pipeline?.appliedEpoch?.subject.assertion.number;
+        const currentDataMutations = pipeline?.currentDataTimeframe?.totalMessages() ?? 0;
+        const totalDataMutations = pipeline?.targetDataTimeframe?.totalMessages() ?? 0;
+        return {
+            // TODO(nf): truncate keys for DD?
+            key: space.key.truncate(),
+            open: space.isOpen,
+            members: space.members.get().length,
+            objects: space.internal.db.coreDatabase.getAllObjectIds().length,
+            startup,
+            epoch,
+            // appliedEpoch,
+            startDataMutations,
+            currentDataMutations,
+            totalDataMutations,
+            // TODO(burdon): Negative?
+            progress: (Math.min(Math.abs((currentDataMutations - startDataMutations) / (totalDataMutations - startDataMutations)), 1) *
+                100).toFixed(0),
+        };
+    });
+};
+//# sourceMappingURL=client-observability.js.map

package/dist/types/src/providers/client-observability.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client-observability.js","sourceRoot":"","sources":["../../../../src/providers/client-observability.ts"],"names":[],"mappings":"AAAA,EAAE;AACF,0BAA0B;AAC1B,EAAE;AAEF,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC,OAAO,EAAE,KAAK,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAG1D,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AACxC,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAChC,OAAO,EAAE,eAAe,EAAsB,QAAQ,EAAE,MAAM,4CAA4C,CAAC;AAI3G,MAAM,0BAA0B,GAAG,IAAI,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,aAAa;AAChE,MAAM,4BAA4B,GAAG,IAAI,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,aAAa;AAClE,MAAM,4BAA4B,GAAG,IAAI,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,aAAa;AAElE,8DAA8D;AAC9D,gFAAgF;AAChF,2CAA2C;AAC3C,2FAA2F;AAC3F,wGAAwG;AACxG,yFAAyF;AACzF,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,cAAuC,EAAgB,EAAE,CACxF,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,aAAa;IAChC,sFAAsF;IACtF,cAAc,CAAC,eAAgB,CAAC,aAAa,EAAE,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE;QACjE,IAAI,CAAC,IAAI,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAC;YACzB,OAAO;QACT,CAAC;QAED,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QAC1C,aAAa,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,sFAAsF;IACtF,cAAc,CAAC,cAAe,CAAC,YAAY,EAAE,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE;QAC9D,IAAI,CAAC,GAAG,EAAE,OAAO,IAAI,GAAG,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC9C,OAAO;QACT,CAAC;QAED,MAAM,UAAU,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,UAAU,CAAC,OAAO,CAAC,CAAC;QACpF,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,OAAO;QACT,CAAC;QAED,aAAa,CAAC,OAAO,CAAC,EAAE,SAAS,EAAE,UAAU,CAAC,SAAS,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QACtE,IAAI,UAAU,CAAC,OAAO,EAAE,KAAK,EAAE,CAAC;YAC9B,aAAa,CAAC,OAAO,CAAC,EAAE,aAAa,EAAE,UAAU,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;QACrE,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEL,oEAAoE;AACpE,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,cAAuC,EAAgB,EAAE,CAC9F,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,aAAa;IAChC,MAAM,GAAG,GAAG,IAAI,OAAO,EAAE,CAAC;IAC1B,IAAI,iBAA4C,CAAC;IAEjD,uCAAuC;IACvC,MAAM,mBAAmB,GAAG,IAAI,KAAK,EAAiB,CAAC,QAAQ,CAAC,4BAA4B,CAAC,CAAC;IAC9F,mBAAmB,CAAC,EAAE,CAAC,GAAG,EAAE,KAAK,IAAI,EAAE;QACrC,GAAG,CAAC,qBAAqB,CAAC,CAAC;QAC1B,iBAAiB,EAAE,SAAoC,EAAE,OAAO,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE;YACtF,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,4CAA4C,EAAE,KAAK,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;QAC/F,CAAC,CAAC,CAAC;QAEH,IAAI,UAAU,GAAG,CAAC,CAAC;QACnB,MAAM,gBAAgB,GAAG,IAAI,GAAG,EAAkB,CAAC;QACnD,KAAK,MAAM,KAAK,IAAI,eAAe,EAAE,CAAC;YACpC,gBAAgB,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QACjC,CAAC;QAED,IAAI,mBAAmB,GAAG,CAAC,CAAC;QAC5B,IAAI,oBAAoB,GAAG,CAAC,CAAC;QAC7B,IAAI,sBAAsB,GAAG,CAAC,CAAC;QAE/B,iBAAiB,EAAE,cAAc,EAAE,OAAO,CAAC,CAAC,cAAc,EAAE,EAAE;YAC5D,UAAU,EAAE,CAAC;YAEb,KAAK,MAAM,IAAI,IAAI,cAAc,CAAC,WAAW,IAAI,EAAE,EAAE,CAAC;gBACpD,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;gBAC9E,mBAAmB,IAAI,IAAI,CAAC,cAAc,IAAI,CAAC,CAAC;gBAChD,oBAAoB,IAAI,IAAI,CAAC,eAAe,IAAI,CAAC,CAAC;gBAClD,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,IAAI,EAAE,EAAE,CAAC;oBACxC,sBAAsB,IAAI,MAAM,CAAC,eAAe,IAAI,CAAC,CAAC;gBACxD,CAAC;YACH,CAAC;YAED,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,iCAAiC,EAAE,UAAU,CAAC,CAAC;YAC3E,KAAK,MAAM,KAAK,IAAI,eAAe,EAAE,CAAC;gBACpC,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,sCAAsC,EAAE,gBAAgB,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE;oBACpG,KAAK;iBACN,CAAC,CAAC;YACL,CAAC;YACD,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,yCAAyC,EAAE,mBAAmB,CAAC,CAAC;YAC5F,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,0CAA0C,EAAE,oBAAoB,CAAC,CAAC;YAC9F,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,4CAA4C,EAAE,sBAAsB,CAAC,CAAC;QACpG,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,cAAc,CAAC,cAAe,CAAC,WAAW,EAAE,CAAC,SAAS,CAAC,CAAC,aAAa,EAAE,EAAE;QACvE,iBAAiB,GAAG,aAAa,CAAC;QAClC,mBAAmB,CAAC,IAAI,EAAE,CAAC;IAC7B,CAAC,CAAC,CAAC;IAEH,oBAAoB,CAAC,GAAG,EAAE,KAAK,IAAI,EAAE,CAAC,mBAAmB,CAAC,IAAI,EAAE,EAAE,4BAA4B,CAAC,CAAC;IAEhG,OAAO,KAAK,IAAI,EAAE;QAChB,MAAM,GAAG,CAAC,OAAO,EAAE,CAAC;IACtB,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC;AAEL,+DAA+D;AAC/D,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,cAAuC,EAAgB,EAAE,CAC9F,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,aAAa;IAChC,MAAM,GAAG,GAAG,IAAI,OAAO,EAAE,CAAC;IAC1B,MAAM,QAAQ,GAAG,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,cAAc,CAAC,aAAc,CAAC,WAAW,EAAE,CAAC,CAAC;IAC1F,SAAS,CAAC,QAAQ,EAAE,sBAAsB,CAAC,CAAC;IAE5C,aAAa,CAAC,OAAO,CAAC;QACpB,YAAY,EAAE,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAc,CAAC,CAAC,WAAW,EAAE;QAC3E,QAAQ,EAAE,QAAQ,CAAC,QAAQ;QAC3B,IAAI,EAAE,QAAQ,CAAC,IAAI;QACnB,OAAO,EAAE,QAAQ,CAAC,OAAO;KAC1B,CAAC,CAAC;IAEH,oBAAoB,CAClB,GAAG,EACH,KAAK,IAAI,EAAE;QACT,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,KAAK,sBAAsB,EAAE,CAAC;YAC/D,MAAM,MAAM,GAAI,MAAM,CAAC,WAAmB,CAAC,MAAM,CAAC;YAClD,IAAI,MAAM,EAAE,CAAC;gBACX,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,+BAA+B,EAAE,MAAM,CAAC,eAAe,CAAC,CAAC;gBACrF,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,8BAA8B,EAAE,MAAM,CAAC,cAAc,CAAC,CAAC;gBACnF,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,mCAAmC,EAAE,MAAM,CAAC,eAAe,CAAC,CAAC;YAC3F,CAAC;QACH,CAAC;QAED,cAAc,CAAC,aAAa,EAAE,WAAW,EAAE;aACxC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;YACjB,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;gBACpB,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,kCAAkC,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;gBACrF,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,wCAAwC,EAAE,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;gBACjG,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,uCAAuC,EAAE,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YACjG,CAAC;QACH,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,CAAC,gBAAgB,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;IACxD,CAAC,EACD,4BAA4B,CAC7B,CAAC;IAEF,OAAO,KAAK,IAAI,EAAE;QAChB,MAAM,GAAG,CAAC,OAAO,EAAE,CAAC;IACtB,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC;AAEL,4FAA4F;AAC5F,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,MAAc,EAAgB,EAAE,CACpE,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,aAAa;IAChC,MAAM,GAAG,GAAG,IAAI,OAAO,EAAE,CAAC;IAC1B,8CAA8C;IAC9C,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC;IACnC,MAAM,aAAa,GAAG,IAAI,GAAG,EAAuC,CAAC;IACrE,GAAG,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,YAAY,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;IAEzF,MAAM,kBAAkB,GAAG,IAAI,KAAK,EAAS,CAAC,QAAQ,CAAC,0BAA0B,CAAC,CAAC;IACnF,kBAAkB,CAAC,EAAE,CAAC,GAAG,EAAE,KAAK,IAAI,EAAE;QACpC,GAAG,CAAC,oBAAoB,CAAC,CAAC;QAC1B,KAAK,MAAM,IAAI,IAAI,SAAS,CAAC,MAAM,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;YAC7D,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,2BAA2B,EAAE,IAAI,CAAC,OAAO,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;YAC1F,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,2BAA2B,EAAE,IAAI,CAAC,OAAO,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;YAC1F,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,yBAAyB,EAAE,IAAI,CAAC,KAAK,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;YACtF,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,wCAAwC,EAAE,IAAI,CAAC,oBAAoB,EAAE;gBAC/F,GAAG,EAAE,IAAI,CAAC,GAAG;aACd,CAAC,CAAC;QACL,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,MAAM,sBAAsB,GAAG,CAAC,KAAY,EAAE,EAAE,CAC9C,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC;QACvB,IAAI,EAAE,GAAG,EAAE;YACT,kBAAkB,CAAC,IAAI,EAAE,CAAC;QAC5B,CAAC;KACF,CAAC,CAAC;IAEL,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;QACvB,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,EAAE,sBAAsB,CAAC,KAAK,CAAC,CAAC,CAAC;IAC7D,CAAC,CAAC,CAAC;IAEH,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC;QACtB,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE;YACrB,MAAM;iBACH,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;iBAC/C,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;gBACjB,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,EAAE,sBAAsB,CAAC,KAAK,CAAC,CAAC,CAAC;YAC7D,CAAC,CAAC,CAAC;QACP,CAAC;KACF,CAAC,CAAC;IAEH,oBAAoB,CAAC,GAAG,EAAE,KAAK,IAAI,EAAE,CAAC,kBAAkB,CAAC,IAAI,EAAE,EAAE,0BAA0B,CAAC,CAAC;IAE7F,OAAO,KAAK,IAAI,EAAE;QAChB,MAAM,GAAG,CAAC,OAAO,EAAE,CAAC;IACtB,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC;AAOL,MAAM,SAAS,GAAG,CAAC,MAAe,EAAE,UAA4B,EAAE,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,EAAE,EAAE;IACzG,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;QAC1B,4BAA4B;QAC5B,oEAAoE;QACpE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,IAAI,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,QAAQ,EAAE,YAAY,EAAE,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;QACpG,MAAM,KAAK,GAAG,QAAQ,EAAE,YAAY,EAAE,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC;QAC/D,yEAAyE;QACzE,MAAM,oBAAoB,GAAG,QAAQ,EAAE,oBAAoB,EAAE,aAAa,EAAE,IAAI,CAAC,CAAC;QAClF,MAAM,kBAAkB,GAAG,QAAQ,EAAE,mBAAmB,EAAE,aAAa,EAAE,IAAI,CAAC,CAAC;QAE/E,OAAO;YACL,kCAAkC;YAClC,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE;YACzB,IAAI,EAAE,KAAK,CAAC,MAAM;YAClB,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,MAAM;YACnC,OAAO,EAAE,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,YAAY,CAAC,eAAe,EAAE,CAAC,MAAM;YAChE,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"}

package/dist/types/src/providers/index.d.ts

@@ -0,0 +1,4 @@
+export * as Client from './client-observability';
+export * as IPData from './ip-data';
+export * as Storage from './storage';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/src/providers/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/providers/index.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,MAAM,wBAAwB,CAAC;AACjD,OAAO,KAAK,MAAM,MAAM,WAAW,CAAC;AACpC,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC"}

package/dist/types/src/providers/index.js

@@ -0,0 +1,7 @@
+//
+// Copyright 2025 DXOS.org
+//
+export * as Client from './client-observability';
+export * as IPData from './ip-data';
+export * as Storage from './storage';
+//# sourceMappingURL=index.js.map

package/dist/types/src/providers/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/providers/index.ts"],"names":[],"mappings":"AAAA,EAAE;AACF,0BAA0B;AAC1B,EAAE;AAEF,OAAO,KAAK,MAAM,MAAM,wBAAwB,CAAC;AACjD,OAAO,KAAK,MAAM,MAAM,WAAW,CAAC;AACpC,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC"}

package/dist/types/src/providers/ip-data.d.ts

@@ -0,0 +1,5 @@
+import { type Config } from '@dxos/config';
+import { type DataProvider } from '../observability';
+/** Fetches IP geolocation data and sets city/region/country tags on the observability instance. */
+export declare const provider: (config: Config) => DataProvider;
+//# sourceMappingURL=ip-data.d.ts.map

package/dist/types/src/providers/ip-data.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ip-data.d.ts","sourceRoot":"","sources":["../../../../src/providers/ip-data.ts"],"names":[],"mappings":"AAYA,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,cAAc,CAAC;AAG3C,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAgDrD,mGAAmG;AACnG,eAAO,MAAM,QAAQ,GAClB,QAAQ,MAAM,KAAG,YAsBf,CAAC"}

package/dist/types/src/providers/ip-data.js

@@ -0,0 +1,55 @@
+//
+// Copyright 2025 DXOS.org
+//
+import * as FetchHttpClient from '@effect/platform/FetchHttpClient';
+import * as HttpClient from '@effect/platform/HttpClient';
+import * as HttpClientRequest from '@effect/platform/HttpClientRequest';
+import * as Effect from 'effect/Effect';
+import * as Schema from 'effect/Schema';
+// NOTE: localStorage is not available in web workers.
+import * as localForage from 'localforage';
+import { log } from '@dxos/log';
+const IP_DATA_CACHE_TIMEOUT = 6 * 60 * 60 * 1000; // 6 hours
+const IPData = Schema.Struct({
+    city: Schema.String,
+    region: Schema.String,
+    country: Schema.String,
+    latitude: Schema.optional(Schema.Number),
+    longitude: Schema.optional(Schema.Number),
+});
+const getIPData = Effect.fn(function* (config) {
+    const httpClient = yield* HttpClient.HttpClient;
+    // Check cache first.
+    const cachedData = yield* Effect.promise(() => localForage.getItem('dxos:observability:ipdata'));
+    if (cachedData && cachedData.timestamp > Date.now() - IP_DATA_CACHE_TIMEOUT) {
+        return cachedData.data;
+    }
+    // Fetch data if not cached.
+    const IPDATA_API_KEY = config.get('runtime.app.env.DX_IPDATA_API_KEY');
+    if (IPDATA_API_KEY) {
+        const data = yield* HttpClientRequest.get(`https://api.ipdata.co?api-key=${IPDATA_API_KEY}`).pipe(httpClient.execute, Effect.flatMap((res) => res.json), Effect.flatMap(Schema.decodeUnknown(IPData)));
+        // Cache data.
+        yield* Effect.promise(() => localForage.setItem('dxos:observability:ipdata', {
+            data,
+            timestamp: Date.now(),
+        }));
+        return data;
+    }
+});
+/** Fetches IP geolocation data and sets city/region/country tags on the observability instance. */
+export const provider = (config) => (observability) => Effect.gen(function* () {
+    const ipData = yield* getIPData(config);
+    if (!ipData) {
+        return;
+    }
+    observability.setTags({
+        city: ipData.city,
+        region: ipData.region,
+        country: ipData.country,
+        latitude: ipData.latitude,
+        longitude: ipData.longitude,
+    });
+}).pipe(Effect.provide(FetchHttpClient.layer), Effect.catchAll((err) => Effect.sync(() => {
+    log.catch(err);
+})));
+//# sourceMappingURL=ip-data.js.map

package/dist/types/src/providers/ip-data.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ip-data.js","sourceRoot":"","sources":["../../../../src/providers/ip-data.ts"],"names":[],"mappings":"AAAA,EAAE;AACF,0BAA0B;AAC1B,EAAE;AAEF,OAAO,KAAK,eAAe,MAAM,kCAAkC,CAAC;AACpE,OAAO,KAAK,UAAU,MAAM,6BAA6B,CAAC;AAC1D,OAAO,KAAK,iBAAiB,MAAM,oCAAoC,CAAC;AACxE,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,sDAAsD;AACtD,OAAO,KAAK,WAAW,MAAM,aAAa,CAAC;AAG3C,OAAO,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAIhC,MAAM,qBAAqB,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,UAAU;AAE5D,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;IAC3B,IAAI,EAAE,MAAM,CAAC,MAAM;IACnB,MAAM,EAAE,MAAM,CAAC,MAAM;IACrB,OAAO,EAAE,MAAM,CAAC,MAAM;IACtB,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;IACxC,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;CAC1C,CAAC,CAAC;AAQH,MAAM,SAAS,GAAG,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAc;IACnD,MAAM,UAAU,GAAG,KAAK,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC;IAEhD,qBAAqB;IACrB,MAAM,UAAU,GAAG,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,WAAW,CAAC,OAAO,CAAe,2BAA2B,CAAC,CAAC,CAAC;IAC/G,IAAI,UAAU,IAAI,UAAU,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,qBAAqB,EAAE,CAAC;QAC5E,OAAO,UAAU,CAAC,IAAI,CAAC;IACzB,CAAC;IAED,4BAA4B;IAC5B,MAAM,cAAc,GAAG,MAAM,CAAC,GAAG,CAAC,mCAAmC,CAAC,CAAC;IACvE,IAAI,cAAc,EAAE,CAAC;QACnB,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,iBAAiB,CAAC,GAAG,CAAC,iCAAiC,cAAc,EAAE,CAAC,CAAC,IAAI,CAC/F,UAAU,CAAC,OAAO,EAClB,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,EACjC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAC7C,CAAC;QAEF,cAAc;QACd,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,CACzB,WAAW,CAAC,OAAO,CAAC,2BAA2B,EAAE;YAC/C,IAAI;YACJ,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;SACtB,CAAC,CACH,CAAC;QAEF,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC,CAAC,CAAC;AAEH,mGAAmG;AACnG,MAAM,CAAC,MAAM,QAAQ,GACnB,CAAC,MAAc,EAAgB,EAAE,CACjC,CAAC,aAAa,EAAE,EAAE,CAChB,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;IAClB,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IACxC,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO;IACT,CAAC;IAED,aAAa,CAAC,OAAO,CAAC;QACpB,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,SAAS,EAAE,MAAM,CAAC,SAAS;KAC5B,CAAC,CAAC;AACL,CAAC,CAAC,CAAC,IAAI,CACL,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,KAAK,CAAC,EACrC,MAAM,CAAC,QAAQ,CAAC,CAAC,GAAG,EAAE,EAAE,CACtB,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE;IACf,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AACjB,CAAC,CAAC,CACH,CACF,CAAC"}

package/dist/types/src/providers/storage.d.ts

@@ -0,0 +1,3 @@
+import { type DataProvider } from '../observability';
+export declare const provider: DataProvider;
+//# sourceMappingURL=storage.d.ts.map

package/dist/types/src/providers/storage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"storage.d.ts","sourceRoot":"","sources":["../../../../src/providers/storage.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAErD,eAAO,MAAM,QAAQ,EAAE,YAWrB,CAAC"}

package/dist/types/src/providers/storage.js

@@ -0,0 +1,19 @@
+//
+// Copyright 2025 DXOS.org
+//
+import * as Duration from 'effect/Duration';
+import * as Effect from 'effect/Effect';
+import * as Fiber from 'effect/Fiber';
+import * as Schedule from 'effect/Schedule';
+export const provider = Effect.fn(function* (observability) {
+    if (typeof navigator !== 'undefined' && navigator.storage?.estimate) {
+        const action = Effect.gen(function* () {
+            const storageEstimate = yield* Effect.tryPromise(() => navigator.storage.estimate());
+            storageEstimate.usage && observability.metrics.gauge('storageUsage', storageEstimate.usage);
+            storageEstimate.quota && observability.metrics.gauge('storageQuota', storageEstimate.quota);
+        });
+        const fiber = action.pipe(Effect.repeat(Schedule.fixed(Duration.hours(1))), Effect.runFork);
+        return () => Effect.runSync(Fiber.interrupt(fiber));
+    }
+});
+//# sourceMappingURL=storage.js.map

package/dist/types/src/providers/storage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"storage.js","sourceRoot":"","sources":["../../../../src/providers/storage.ts"],"names":[],"mappings":"AAAA,EAAE;AACF,0BAA0B;AAC1B,EAAE;AAEF,OAAO,KAAK,QAAQ,MAAM,iBAAiB,CAAC;AAC5C,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,KAAK,MAAM,cAAc,CAAC;AACtC,OAAO,KAAK,QAAQ,MAAM,iBAAiB,CAAC;AAI5C,MAAM,CAAC,MAAM,QAAQ,GAAiB,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,aAAa;IACtE,IAAI,OAAO,SAAS,KAAK,WAAW,IAAI,SAAS,CAAC,OAAO,EAAE,QAAQ,EAAE,CAAC;QACpE,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;YACjC,MAAM,eAAe,GAAG,KAAK,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;YACrF,eAAe,CAAC,KAAK,IAAI,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,cAAc,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC;YAC5F,eAAe,CAAC,KAAK,IAAI,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,cAAc,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC;QAC9F,CAAC,CAAC,CAAC;QAEH,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;QAC5F,OAAO,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;IACtD,CAAC;AACH,CAAC,CAAC,CAAC"}

package/dist/types/src/storage/browser.d.ts

@@ -0,0 +1,19 @@
+/** No-op in browser contexts. */
+export declare const showObservabilityBanner: () => void;
+/**
+ * @param namespace - localForage key prefix used to scope the observability state in browser storage.
+ */
+export declare const isObservabilityDisabled: (namespace: string) => Promise<boolean>;
+/**
+ * @param namespace - localForage key prefix used to scope the observability state in browser storage.
+ */
+export declare const storeObservabilityDisabled: (namespace: string, value: boolean) => Promise<void>;
+/**
+ * @param namespace - localForage key prefix used to scope the observability state in browser storage.
+ */
+export declare const getObservabilityGroup: (namespace: string) => Promise<string | undefined>;
+/**
+ * @param namespace - localForage key prefix used to scope the observability state in browser storage.
+ */
+export declare const storeObservabilityGroup: (namespace: string, value: string) => Promise<void>;
+//# sourceMappingURL=browser.d.ts.map

package/dist/types/src/storage/browser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../../../src/storage/browser.ts"],"names":[],"mappings":"AAYA,iCAAiC;AACjC,eAAO,MAAM,uBAAuB,YAEnC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,uBAAuB,GAAU,WAAW,MAAM,KAAG,OAAO,CAAC,OAAO,CAOhF,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,0BAA0B,GAAU,WAAW,MAAM,EAAE,OAAO,OAAO,kBAMjF,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,qBAAqB,GAAU,WAAW,MAAM,KAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAMzF,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,uBAAuB,GAAU,WAAW,MAAM,EAAE,OAAO,MAAM,kBAM7E,CAAC"}

package/dist/types/src/storage/browser.js

@@ -0,0 +1,58 @@
+//
+// Copyright 2022 DXOS.org
+//
+// NOTE: localStorage is not available in web workers.
+import * as localForage from 'localforage';
+import { log } from '@dxos/log';
+const OBSERVABILITY_DISABLED_KEY = 'observability-disabled';
+const OBSERVABILITY_GROUP_KEY = 'observability-group';
+/** No-op in browser contexts. */
+export const showObservabilityBanner = () => {
+    log.warn('showObservabilityBanner is not supported in browser contexts.');
+};
+/**
+ * @param namespace - localForage key prefix used to scope the observability state in browser storage.
+ */
+export const isObservabilityDisabled = async (namespace) => {
+    try {
+        return (await localForage.getItem(`${namespace}:${OBSERVABILITY_DISABLED_KEY}`)) === 'true';
+    }
+    catch (err) {
+        log.catch('Failed to check if observability is disabled, assuming it is', err);
+        return true;
+    }
+};
+/**
+ * @param namespace - localForage key prefix used to scope the observability state in browser storage.
+ */
+export const storeObservabilityDisabled = async (namespace, value) => {
+    try {
+        await localForage.setItem(`${namespace}:${OBSERVABILITY_DISABLED_KEY}`, String(value));
+    }
+    catch (err) {
+        log.catch('Failed to store observability disabled', err);
+    }
+};
+/**
+ * @param namespace - localForage key prefix used to scope the observability state in browser storage.
+ */
+export const getObservabilityGroup = async (namespace) => {
+    try {
+        return (await localForage.getItem(`${namespace}:${OBSERVABILITY_GROUP_KEY}`)) ?? undefined;
+    }
+    catch (err) {
+        log.catch('Failed to get observability group', err);
+    }
+};
+/**
+ * @param namespace - localForage key prefix used to scope the observability state in browser storage.
+ */
+export const storeObservabilityGroup = async (namespace, value) => {
+    try {
+        await localForage.setItem(`${namespace}:${OBSERVABILITY_GROUP_KEY}`, value);
+    }
+    catch (err) {
+        log.catch('Failed to store observability group', err);
+    }
+};
+//# sourceMappingURL=browser.js.map

package/dist/types/src/storage/browser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser.js","sourceRoot":"","sources":["../../../../src/storage/browser.ts"],"names":[],"mappings":"AAAA,EAAE;AACF,0BAA0B;AAC1B,EAAE;AAEF,sDAAsD;AACtD,OAAO,KAAK,WAAW,MAAM,aAAa,CAAC;AAE3C,OAAO,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAEhC,MAAM,0BAA0B,GAAG,wBAAwB,CAAC;AAC5D,MAAM,uBAAuB,GAAG,qBAAqB,CAAC;AAEtD,iCAAiC;AACjC,MAAM,CAAC,MAAM,uBAAuB,GAAG,GAAG,EAAE;IAC1C,GAAG,CAAC,IAAI,CAAC,+DAA+D,CAAC,CAAC;AAC5E,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,KAAK,EAAE,SAAiB,EAAoB,EAAE;IACnF,IAAI,CAAC;QACH,OAAO,CAAC,MAAM,WAAW,CAAC,OAAO,CAAC,GAAG,SAAS,IAAI,0BAA0B,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC;IAC9F,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,GAAG,CAAC,KAAK,CAAC,8DAA8D,EAAE,GAAG,CAAC,CAAC;QAC/E,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,KAAK,EAAE,SAAiB,EAAE,KAAc,EAAE,EAAE;IACpF,IAAI,CAAC;QACH,MAAM,WAAW,CAAC,OAAO,CAAC,GAAG,SAAS,IAAI,0BAA0B,EAAE,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IACzF,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,GAAG,CAAC,KAAK,CAAC,wCAAwC,EAAE,GAAG,CAAC,CAAC;IAC3D,CAAC;AACH,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,KAAK,EAAE,SAAiB,EAA+B,EAAE;IAC5F,IAAI,CAAC;QACH,OAAO,CAAC,MAAM,WAAW,CAAC,OAAO,CAAC,GAAG,SAAS,IAAI,uBAAuB,EAAE,CAAC,CAAC,IAAI,SAAS,CAAC;IAC7F,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,GAAG,CAAC,KAAK,CAAC,mCAAmC,EAAE,GAAG,CAAC,CAAC;IACtD,CAAC;AACH,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,KAAK,EAAE,SAAiB,EAAE,KAAa,EAAE,EAAE;IAChF,IAAI,CAAC;QACH,MAAM,WAAW,CAAC,OAAO,CAAC,GAAG,SAAS,IAAI,uBAAuB,EAAE,EAAE,KAAK,CAAC,CAAC;IAC9E,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,GAAG,CAAC,KAAK,CAAC,qCAAqC,EAAE,GAAG,CAAC,CAAC;IACxD,CAAC;AACH,CAAC,CAAC"}

package/dist/types/src/storage/index.d.ts

@@ -0,0 +1,2 @@
+export * from './node';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/src/storage/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/storage/index.ts"],"names":[],"mappings":"AAIA,cAAc,QAAQ,CAAC"}

package/{src/segment/index.ts → dist/types/src/storage/index.js}

@@ -1,6 +1,5 @@
 //
 // Copyright 2022 DXOS.org
 //
-
 export * from './node';
-export * from './types';
+//# sourceMappingURL=index.js.map

package/dist/types/src/storage/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/storage/index.ts"],"names":[],"mappings":"AAAA,EAAE;AACF,0BAA0B;AAC1B,EAAE;AAEF,cAAc,QAAQ,CAAC"}

package/dist/types/src/storage/node.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Print observability banner once per installation.
+ */
+export declare const showObservabilityBanner: (configDir: string, bannercb: (input: string) => void) => Promise<void>;
+/**
+ * @param configDir - Filesystem path to the directory containing the `observability.yml` state file.
+ */
+export declare const isObservabilityDisabled: (configDir: string) => Promise<boolean>;
+/**
+ * @param configDir - Filesystem path to the directory containing the `observability.yml` state file.
+ */
+export declare const storeObservabilityDisabled: (configDir: string, value: boolean) => Promise<void>;
+/**
+ * @param configDir - Filesystem path to the directory containing the `observability.yml` state file.
+ */
+export declare const getObservabilityGroup: (configDir: string) => Promise<string | undefined>;
+/**
+ * @param configDir - Filesystem path to the directory containing the `observability.yml` state file.
+ */
+export declare const storeObservabilityGroup: (configDir: string, value: string) => Promise<void>;
+export type PersistentObservabilityState = {
+    installationId: string;
+    disabled: boolean;
+    group?: string;
+};
+//# sourceMappingURL=node.d.ts.map

package/dist/types/src/storage/node.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../../../../src/storage/node.ts"],"names":[],"mappings":"AAUA;;GAEG;AACH,eAAO,MAAM,uBAAuB,GAAU,WAAW,MAAM,EAAE,UAAU,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,kBAajG,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,uBAAuB,GAAU,WAAW,MAAM,KAAG,OAAO,CAAC,OAAO,CAGhF,CAAC;AAEF;;GAEG;AAGH,eAAO,MAAM,0BAA0B,GAAU,WAAW,MAAM,EAAE,OAAO,OAAO,kBAIjF,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,qBAAqB,GAAU,WAAW,MAAM,KAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAGzF,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,uBAAuB,GAAU,WAAW,MAAM,EAAE,OAAO,MAAM,kBAI7E,CAAC;AAsBF,MAAM,MAAM,4BAA4B,GAAG;IACzC,cAAc,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,OAAO,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC"}

package/dist/types/src/storage/node.js

@@ -0,0 +1,92 @@
+//
+// Copyright 2022 DXOS.org
+//
+import { existsSync, statSync } from 'node:fs';
+import { mkdir, readFile, writeFile } from 'node:fs/promises';
+import { join } from 'node:path';
+import yaml from 'js-yaml';
+import { v4 as uuid, validate as validateUuid } from 'uuid';
+/**
+ * Print observability banner once per installation.
+ */
+export const showObservabilityBanner = async (configDir, bannercb) => {
+    const path = join(configDir, '.observability-banner-printed');
+    if (existsSync(path)) {
+        return;
+    }
+    bannercb('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 \
+    observability data, set the environment variable DX_DISABLE_OBSERVABILITY=true.');
+    await writeFile(path, '', 'utf-8');
+};
+/**
+ * @param configDir - Filesystem path to the directory containing the `observability.yml` state file.
+ */
+export const isObservabilityDisabled = async (configDir) => {
+    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, value) => {
+    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) => {
+    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, value) => {
+    const observabilityState = await getObservabilityState(configDir);
+    observabilityState.group = value;
+    await writeFile(join(configDir, 'observability.yml'), yaml.dump(observabilityState), 'utf-8');
+};
+const getObservabilityState = async (configDir) => {
+    // check whether configDir exists and if it's a directory
+    if (existsSync(configDir)) {
+        if (!statSync(configDir).isDirectory()) {
+            throw new Error(`Config directory ${configDir} exists but is not a directory`);
+        }
+    }
+    else {
+        await mkdir(configDir, { recursive: true });
+    }
+    const idPath = join(configDir, 'observability.yml');
+    if (existsSync(idPath)) {
+        const context = await readFile(idPath, 'utf-8');
+        return validate(context) ?? initializeState(idPath);
+    }
+    return initializeState(idPath);
+};
+// create initial state and write to file, using environment variables to override defaults.
+const initializeState = async (idPath) => {
+    // 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,
+    };
+    await writeFile(idPath, '# This file is automatically generated by the @dxos/cli.\n' + yaml.dump(observabilityState), 'utf-8');
+    return observabilityState;
+};
+const validate = (contextString) => {
+    const context = yaml.load(contextString);
+    if (Boolean(context.installationId) && validateUuid(context.installationId)) {
+        return {
+            ...context,
+            disabled: process.env.DX_DISABLE_OBSERVABILITY ? true : (context.disabled ?? false),
+        };
+    }
+};
+//# sourceMappingURL=node.js.map

package/dist/types/src/storage/node.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"node.js","sourceRoot":"","sources":["../../../../src/storage/node.ts"],"names":[],"mappings":"AAAA,EAAE;AACF,0BAA0B;AAC1B,EAAE;AACF,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAC/C,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC9D,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEjC,OAAO,IAAI,MAAM,SAAS,CAAC;AAC3B,OAAO,EAAE,EAAE,IAAI,IAAI,EAAE,QAAQ,IAAI,YAAY,EAAE,MAAM,MAAM,CAAC;AAE5D;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,KAAK,EAAE,SAAiB,EAAE,QAAiC,EAAE,EAAE;IACpG,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,EAAE,+BAA+B,CAAC,CAAC;IAC9D,IAAI,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;QACrB,OAAO;IACT,CAAC;IACD,QAAQ,CACN;;;oFAGgF,CACjF,CAAC;IAEF,MAAM,SAAS,CAAC,IAAI,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;AACrC,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,KAAK,EAAE,SAAiB,EAAoB,EAAE;IACnF,MAAM,kBAAkB,GAAG,MAAM,qBAAqB,CAAC,SAAS,CAAC,CAAC;IAClE,OAAO,kBAAkB,CAAC,QAAQ,CAAC;AACrC,CAAC,CAAC;AAEF;;GAEG;AACH,wFAAwF;AACxF,uFAAuF;AACvF,MAAM,CAAC,MAAM,0BAA0B,GAAG,KAAK,EAAE,SAAiB,EAAE,KAAc,EAAE,EAAE;IACpF,MAAM,kBAAkB,GAAG,MAAM,qBAAqB,CAAC,SAAS,CAAC,CAAC;IAClE,kBAAkB,CAAC,QAAQ,GAAG,KAAK,CAAC;IACpC,MAAM,SAAS,CAAC,IAAI,CAAC,SAAS,EAAE,mBAAmB,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,EAAE,OAAO,CAAC,CAAC;AAChG,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,KAAK,EAAE,SAAiB,EAA+B,EAAE;IAC5F,MAAM,kBAAkB,GAAG,MAAM,qBAAqB,CAAC,SAAS,CAAC,CAAC;IAClE,OAAO,kBAAkB,CAAC,KAAK,CAAC;AAClC,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,KAAK,EAAE,SAAiB,EAAE,KAAa,EAAE,EAAE;IAChF,MAAM,kBAAkB,GAAG,MAAM,qBAAqB,CAAC,SAAS,CAAC,CAAC;IAClE,kBAAkB,CAAC,KAAK,GAAG,KAAK,CAAC;IACjC,MAAM,SAAS,CAAC,IAAI,CAAC,SAAS,EAAE,mBAAmB,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,EAAE,OAAO,CAAC,CAAC;AAChG,CAAC,CAAC;AAEF,MAAM,qBAAqB,GAAG,KAAK,EAAE,SAAiB,EAAyC,EAAE;IAC/F,yDAAyD;IAEzD,IAAI,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;QAC1B,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC;YACvC,MAAM,IAAI,KAAK,CAAC,oBAAoB,SAAS,gCAAgC,CAAC,CAAC;QACjF,CAAC;IACH,CAAC;SAAM,CAAC;QACN,MAAM,KAAK,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC9C,CAAC;IAED,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,mBAAmB,CAAC,CAAC;IACpD,IAAI,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;QACvB,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAChD,OAAO,QAAQ,CAAC,OAAO,CAAC,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC;IACtD,CAAC;IAED,OAAO,eAAe,CAAC,MAAM,CAAC,CAAC;AACjC,CAAC,CAAC;AAQF,4FAA4F;AAC5F,MAAM,eAAe,GAAG,KAAK,EAAE,MAAc,EAAyC,EAAE;IACtF,yDAAyD;IACzD,MAAM,kBAAkB,GAAG;QACzB,cAAc,EAAE,IAAI,EAAE;QACtB,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK;QAC7D,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,sBAAsB,IAAI,SAAS;KACvD,CAAC;IAEF,MAAM,SAAS,CACb,MAAM,EACN,4DAA4D,GAAG,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,EAC5F,OAAO,CACR,CAAC;IAEF,OAAO,kBAAkB,CAAC;AAC5B,CAAC,CAAC;AAEF,MAAM,QAAQ,GAAG,CAAC,aAAqB,EAAE,EAAE;IACzC,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,CAAiC,CAAC;IACzE,IAAI,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,YAAY,CAAC,OAAO,CAAC,cAAe,CAAC,EAAE,CAAC;QAC7E,OAAO;YACL,GAAG,OAAO;YACV,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,IAAI,KAAK,CAAC;SACpF,CAAC;IACJ,CAAC;AACH,CAAC,CAAC"}

package/dist/types/src/storage/node.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=node.test.d.ts.map

package/dist/types/src/storage/node.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"node.test.d.ts","sourceRoot":"","sources":["../../../../src/storage/node.test.ts"],"names":[],"mappings":""}