@dxos/plugin-observability 0.7.5-main.9d26e3a → 0.7.5-main.9d2a38b

package/src/capabilities/state.ts

@@ -0,0 +1,21 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { contributes } from '@dxos/app-framework';
+import { LocalStorageStore } from '@dxos/local-storage';
+import { getObservabilityGroup } from '@dxos/observability';
+
+import { ObservabilityCapabilities } from './capabilities';
+import { OBSERVABILITY_PLUGIN } from '../meta';
+
+export default async ({ namespace }: { namespace: string }) => {
+  const state = new LocalStorageStore<ObservabilityCapabilities.State>(OBSERVABILITY_PLUGIN);
+
+  state.prop({ key: 'notified', type: LocalStorageStore.bool({ allowUndefined: true }) });
+
+  // NOTE: This is not stored in local storage such that it can be accessed by workers.
+  state.values.group = await getObservabilityGroup(namespace);
+
+  return contributes(ObservabilityCapabilities.State, state.values, () => state.close());
+};

package/src/components/ObservabilitySettings.tsx

@@ -5,19 +5,24 @@
 import React from 'react';
 
 import { createIntent, useIntentDispatcher } from '@dxos/app-framework';
+import { S } from '@dxos/echo-schema';
 import { Input, Message, useTranslation } from '@dxos/react-ui';
 import { DeprecatedFormInput } from '@dxos/react-ui-form';
 
 import { OBSERVABILITY_PLUGIN } from '../meta';
 import { ObservabilityAction } from '../types';
 
-export type ObservabilitySettingsProps = {
-  enabled?: boolean;
-  // TODO(wittjosiah): Separate settings for each observability feature.
-  // metrics?: boolean;
-  // telemetry?: boolean;
-  // errors?: boolean;
-};
+export const ObservabilitySettingsSchema = S.mutable(
+  S.Struct({
+    enabled: S.Boolean,
+    // TODO(wittjosiah): Separate settings for each observability feature.
+    // metrics?: boolean;
+    // telemetry?: boolean;
+    // errors?: boolean;
+  }),
+);
+
+export type ObservabilitySettingsProps = S.Schema.Type<typeof ObservabilitySettingsSchema>;
 
 export const ObservabilitySettings = ({ settings }: { settings: ObservabilitySettingsProps }) => {
   const { t } = useTranslation(OBSERVABILITY_PLUGIN);

package/src/events.ts

@@ -0,0 +1,14 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { defineEvent, Events } from '@dxos/app-framework';
+
+import { OBSERVABILITY_PLUGIN } from './meta';
+
+export namespace ObservabilityEvents {
+  export const StateReady = Events.createStateEvent(OBSERVABILITY_PLUGIN);
+}
+
+// NOTE: This is cloned from the client plugin to avoid circular dependencies.
+export const ClientReadyEvent = defineEvent('dxos.org/plugin/client/event/client-ready');

package/src/index.ts

@@ -2,8 +2,7 @@
 // Copyright 2023 DXOS.org
 //
 
-import { ObservabilityPlugin } from './ObservabilityPlugin';
-
-export default ObservabilityPlugin;
-
+export { ObservabilityCapabilities } from './capabilities';
+export { ObservabilityEvents } from './events';
+export * from './meta';
 export * from './ObservabilityPlugin';

package/src/meta.ts

@@ -6,7 +6,7 @@ import { type PluginMeta } from '@dxos/app-framework';
 
 export const OBSERVABILITY_PLUGIN = 'dxos.org/plugin/observability';
 
-export default {
+export const meta = {
   id: OBSERVABILITY_PLUGIN,
   name: 'Telemetry',
 } satisfies PluginMeta;

package/dist/lib/browser/meta.mjs

@@ -1,9 +0,0 @@
-import {
-  OBSERVABILITY_PLUGIN,
-  meta_default
-} from "./chunk-X6XUBXZQ.mjs";
-export {
-  OBSERVABILITY_PLUGIN,
-  meta_default as default
-};
-//# sourceMappingURL=meta.mjs.map

package/dist/lib/browser/meta.mjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": [],
-  "sourcesContent": [],
-  "mappings": "",
-  "names": []
-}

package/dist/lib/node/chunk-SIUGGDNL.cjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/meta.ts"],
-  "sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport { type PluginMeta } from '@dxos/app-framework';\n\nexport const OBSERVABILITY_PLUGIN = 'dxos.org/plugin/observability';\n\nexport default {\n  id: OBSERVABILITY_PLUGIN,\n  name: 'Telemetry',\n} satisfies PluginMeta;\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;AAMO,IAAMA,uBAAuB;AAEpC,IAAA,eAAe;EACbC,IAAID;EACJE,MAAM;AACR;",
-  "names": ["OBSERVABILITY_PLUGIN", "id", "name"]
-}

package/dist/lib/node/meta.cjs

@@ -1,30 +0,0 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var meta_exports = {};
-__export(meta_exports, {
-  OBSERVABILITY_PLUGIN: () => import_chunk_SIUGGDNL.OBSERVABILITY_PLUGIN,
-  default: () => import_chunk_SIUGGDNL.meta_default
-});
-module.exports = __toCommonJS(meta_exports);
-var import_chunk_SIUGGDNL = require("./chunk-SIUGGDNL.cjs");
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  OBSERVABILITY_PLUGIN
-});
-//# sourceMappingURL=meta.cjs.map

package/dist/lib/node/meta.cjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["meta.cjs"],
-  "sourcesContent": ["import {\n  OBSERVABILITY_PLUGIN,\n  meta_default\n} from \"./chunk-SIUGGDNL.cjs\";\nexport {\n  OBSERVABILITY_PLUGIN,\n  meta_default as default\n};\n//# sourceMappingURL=meta.cjs.map\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,4BAGO;",
-  "names": []
-}

package/dist/lib/node-esm/meta.mjs

@@ -1,10 +0,0 @@
-import { createRequire } from 'node:module';const require = createRequire(import.meta.url);
-import {
-  OBSERVABILITY_PLUGIN,
-  meta_default
-} from "./chunk-7GGPSKXN.mjs";
-export {
-  OBSERVABILITY_PLUGIN,
-  meta_default as default
-};
-//# sourceMappingURL=meta.mjs.map

package/dist/lib/node-esm/meta.mjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": [],
-  "sourcesContent": [],
-  "mappings": "",
-  "names": []
-}

package/src/ObservabilityPlugin.tsx

@@ -1,215 +0,0 @@
-//
-// Copyright 2023 DXOS.org
-//
-
-import React from 'react';
-
-import {
-  type Plugin,
-  type PluginDefinition,
-  type IntentResolverProvides,
-  type SettingsProvides,
-  type SurfaceProvides,
-  type TranslationsProvides,
-  resolvePlugin,
-  parseIntentPlugin,
-  LayoutAction,
-  SettingsAction,
-  createSurface,
-  findPlugin,
-  createIntent,
-  createResolver,
-} from '@dxos/app-framework';
-import { EventSubscriptions } from '@dxos/async';
-import { invariant } from '@dxos/invariant';
-import { create } from '@dxos/live-object';
-import { LocalStorageStore } from '@dxos/local-storage';
-import {
-  type Observability,
-  getTelemetryIdentifier,
-  setupTelemetryListeners,
-  isObservabilityDisabled,
-  storeObservabilityDisabled,
-  getObservabilityGroup,
-} from '@dxos/observability';
-import { type Client } from '@dxos/react-client';
-
-import { ObservabilitySettings, type ObservabilitySettingsProps } from './components';
-import meta, { OBSERVABILITY_PLUGIN } from './meta';
-import translations from './translations';
-import { ObservabilityAction } from './types';
-
-export type ObservabilityPluginState = {
-  group?: string;
-  notified?: boolean;
-};
-
-export type ObservabilityPluginProvides = IntentResolverProvides &
-  SurfaceProvides &
-  SettingsProvides<ObservabilitySettingsProps> &
-  TranslationsProvides & {
-    observability: ObservabilityPluginState;
-  };
-
-export const parseObservabilityPlugin = (plugin?: Plugin) =>
-  (plugin?.provides as any).observability ? (plugin as Plugin<ObservabilityPluginProvides>) : undefined;
-
-export const ObservabilityPlugin = (options: {
-  namespace: string;
-  observability: () => Promise<Observability>;
-}): PluginDefinition<ObservabilityPluginProvides> => {
-  const settings = create<ObservabilitySettingsProps>({});
-  const state = new LocalStorageStore<ObservabilityPluginState>(OBSERVABILITY_PLUGIN);
-  const subscriptions = new EventSubscriptions();
-  let observability: Observability | undefined;
-
-  return {
-    meta,
-    initialize: async () => {
-      settings.enabled = !(await isObservabilityDisabled(options.namespace));
-      state.values.group = await getObservabilityGroup(options.namespace);
-      state.prop({ key: 'notified', type: LocalStorageStore.bool({ allowUndefined: true }) });
-    },
-    ready: async ({ plugins }) => {
-      const client = findPlugin<{ client: Client }>(plugins, 'dxos.org/plugin/client')?.provides.client;
-      const intentPlugin = resolvePlugin(plugins, parseIntentPlugin);
-
-      const dispatch = intentPlugin?.provides?.intent?.dispatchPromise;
-      if (!dispatch) {
-        return;
-      }
-
-      const sendPrivacyNotice = async () => {
-        const environment = client?.config?.values.runtime?.app?.env?.DX_ENVIRONMENT;
-        const notify =
-          environment && environment !== 'ci' && !environment.endsWith('.local') && !environment.endsWith('.lan');
-        if (!state.values.notified && notify) {
-          await dispatch(
-            createIntent(LayoutAction.SetLayout, {
-              element: 'toast',
-              subject: {
-                id: `${OBSERVABILITY_PLUGIN}/notice`,
-                // TODO(wittjosiah): Non-react translation utils.
-                title: translations[0]['en-US'][OBSERVABILITY_PLUGIN]['observability toast label'],
-                description: translations[0]['en-US'][OBSERVABILITY_PLUGIN]['observability toast description'],
-                duration: Infinity,
-                icon: 'ph--info--regular',
-                actionLabel: translations[0]['en-US'][OBSERVABILITY_PLUGIN]['observability toast action label'],
-                actionAlt: translations[0]['en-US'][OBSERVABILITY_PLUGIN]['observability toast action alt'],
-                closeLabel: translations[0]['en-US'][OBSERVABILITY_PLUGIN]['observability toast close label'],
-                onAction: () => dispatch(createIntent(SettingsAction.Open, { plugin: OBSERVABILITY_PLUGIN })),
-              },
-            }),
-          );
-
-          state.values.notified = true;
-        }
-      };
-
-      // Initialize asynchronously in the background, not in plugin initialization.
-      // Should not block application startup.
-      void options.observability().then(async (obs) => {
-        observability = obs;
-
-        // Ensure errors are tagged with enabled plugins to help with reproductions.
-        plugins.map((plugin) => observability?.setTag(`pluginEnabled-${plugin.meta.id}`, 'true', 'errors'));
-
-        // Start client observability (i.e. not running as shared worker)
-        // TODO(nf): how to prevent multiple instances for single shared worker?
-        if (!client) {
-          return;
-        }
-
-        await dispatch(
-          createIntent(ObservabilityAction.SendEvent, {
-            name: 'page.load',
-            properties: {
-              href: window.location.href,
-              // TODO(wittjosiah): These apis are deprecated. Is there a better way to find this information?
-              loadDuration: window.performance.timing.loadEventEnd - window.performance.timing.loadEventStart,
-            },
-          }),
-        );
-
-        setupTelemetryListeners(options.namespace, client, observability);
-
-        await Promise.all([
-          observability.setIdentityTags(client.services.services),
-          observability.startRuntimeMetrics(client),
-          observability.startNetworkMetrics(client.services.services),
-          observability.startSpacesMetrics(client, options.namespace),
-        ]);
-
-        if (client.halo.identity.get()) {
-          await sendPrivacyNotice();
-        } else {
-          const subscription = client.halo.identity.subscribe(async (identity) => {
-            if (identity && observability) {
-              await sendPrivacyNotice();
-              await observability.setIdentityTags(client.services.services);
-              subscription.unsubscribe();
-            }
-          });
-        }
-      });
-    },
-    unload: async () => {
-      subscriptions.clear();
-      await observability?.close();
-    },
-    provides: {
-      intent: {
-        resolvers: ({ plugins }) => {
-          const client = findPlugin<{ client: Client }>(plugins, 'dxos.org/plugin/client')?.provides.client;
-          if (!client || !observability) {
-            return [];
-          }
-
-          return [
-            createResolver(ObservabilityAction.Toggle, async ({ state }) => {
-              invariant(observability, 'Observability instance not available');
-              settings.enabled = state ?? !settings.enabled;
-              observability.event({
-                identityId: getTelemetryIdentifier(client),
-                name: `${options.namespace}.observability.toggle`,
-                properties: {
-                  enabled: settings.enabled,
-                },
-              });
-              observability.setMode(settings.enabled ? 'basic' : 'disabled');
-              await storeObservabilityDisabled(options.namespace, !settings.enabled);
-              return { data: settings.enabled };
-            }),
-            createResolver(ObservabilityAction.SendEvent, async (data) => {
-              invariant(observability, 'Observability instance not available');
-              const event = {
-                identityId: getTelemetryIdentifier(client),
-                name: `${options.namespace}.${data.name}`,
-                properties: {
-                  ...data.properties,
-                },
-              };
-              observability.event(event);
-            }),
-            createResolver(ObservabilityAction.CaptureUserFeedback, async (data) => {
-              invariant(observability, 'Observability instance not available');
-              observability.captureUserFeedback(data.email, data.name, data.message);
-            }),
-          ];
-        },
-      },
-      observability: state.values,
-      settings,
-      surface: {
-        definitions: () =>
-          createSurface({
-            id: OBSERVABILITY_PLUGIN,
-            role: 'settings',
-            filter: (data): data is any => data.subject === OBSERVABILITY_PLUGIN,
-            component: () => <ObservabilitySettings settings={settings} />,
-          }),
-      },
-      translations,
-    },
-  };
-};