@dxos/plugin-observability 0.8.4-main.9be5663bfe → 0.8.4-main.abd8ff62ef

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (136) hide show
  1. package/dist/lib/browser/{ObservabilitySettings-EM7ABGCA.mjs → ObservabilitySettings-H6UKYDDT.mjs} +9 -13
  2. package/dist/lib/browser/ObservabilitySettings-H6UKYDDT.mjs.map +7 -0
  3. package/dist/lib/browser/{capture-user-feedback-4HGXJGJL.mjs → capture-user-feedback-3BXDUCZM.mjs} +4 -5
  4. package/dist/lib/browser/capture-user-feedback-3BXDUCZM.mjs.map +7 -0
  5. package/dist/lib/browser/{chunk-VZR3FNBD.mjs → chunk-DLBA63VM.mjs} +3 -5
  6. package/dist/lib/browser/chunk-DLBA63VM.mjs.map +7 -0
  7. package/dist/lib/browser/{chunk-K33HLC3Z.mjs → chunk-LHGNFXDI.mjs} +2 -3
  8. package/dist/lib/browser/chunk-LHGNFXDI.mjs.map +7 -0
  9. package/dist/lib/browser/{chunk-J6DPYEFZ.mjs → chunk-VQC6DG6V.mjs} +6 -2
  10. package/dist/lib/browser/chunk-VQC6DG6V.mjs.map +7 -0
  11. package/dist/lib/browser/components/index.mjs +45 -0
  12. package/dist/lib/browser/components/index.mjs.map +7 -0
  13. package/dist/lib/browser/index.mjs +10 -86
  14. package/dist/lib/browser/index.mjs.map +4 -4
  15. package/dist/lib/browser/meta.json +1 -1
  16. package/dist/lib/browser/operations/index.mjs +3 -4
  17. package/dist/lib/browser/operations/index.mjs.map +3 -3
  18. package/dist/lib/browser/{send-event-VV2I6QYY.mjs → send-event-F3D32CJX.mjs} +4 -5
  19. package/dist/lib/browser/send-event-F3D32CJX.mjs.map +7 -0
  20. package/dist/lib/browser/{toggle-H2GX3A6G.mjs → toggle-PPNDFGWJ.mjs} +4 -5
  21. package/dist/lib/browser/toggle-PPNDFGWJ.mjs.map +7 -0
  22. package/dist/lib/browser/translations.mjs +8 -0
  23. package/dist/lib/browser/translations.mjs.map +7 -0
  24. package/dist/lib/browser/types/index.mjs +1 -1
  25. package/dist/lib/node-esm/{ObservabilitySettings-VP4A362Z.mjs → ObservabilitySettings-HXTWPHHR.mjs} +9 -13
  26. package/dist/lib/node-esm/ObservabilitySettings-HXTWPHHR.mjs.map +7 -0
  27. package/dist/lib/node-esm/{capture-user-feedback-SDQA2VYI.mjs → capture-user-feedback-LUPWJWGK.mjs} +4 -5
  28. package/dist/lib/{browser/capture-user-feedback-4HGXJGJL.mjs.map → node-esm/capture-user-feedback-LUPWJWGK.mjs.map} +1 -1
  29. package/dist/lib/node-esm/{chunk-FZRJBWSE.mjs → chunk-3B7HMSKM.mjs} +3 -5
  30. package/dist/lib/node-esm/chunk-3B7HMSKM.mjs.map +7 -0
  31. package/dist/lib/node-esm/{chunk-JGHMP7UL.mjs → chunk-J4EHZPH2.mjs} +2 -3
  32. package/dist/lib/node-esm/chunk-J4EHZPH2.mjs.map +7 -0
  33. package/dist/lib/node-esm/{chunk-K7WZOJZF.mjs → chunk-NCIKZY6L.mjs} +6 -2
  34. package/dist/lib/node-esm/chunk-NCIKZY6L.mjs.map +7 -0
  35. package/dist/lib/node-esm/components/index.mjs +46 -0
  36. package/dist/lib/node-esm/components/index.mjs.map +7 -0
  37. package/dist/lib/node-esm/index.mjs +10 -86
  38. package/dist/lib/node-esm/index.mjs.map +4 -4
  39. package/dist/lib/node-esm/meta.json +1 -1
  40. package/dist/lib/node-esm/operations/index.mjs +3 -4
  41. package/dist/lib/node-esm/operations/index.mjs.map +3 -3
  42. package/dist/lib/node-esm/{send-event-EMV3VHAA.mjs → send-event-OKTEXC7M.mjs} +4 -5
  43. package/dist/lib/{browser/send-event-VV2I6QYY.mjs.map → node-esm/send-event-OKTEXC7M.mjs.map} +1 -1
  44. package/dist/lib/node-esm/{toggle-XRNGEYNP.mjs → toggle-YS2KFMXS.mjs} +4 -5
  45. package/dist/lib/node-esm/toggle-YS2KFMXS.mjs.map +7 -0
  46. package/dist/lib/node-esm/translations.mjs +9 -0
  47. package/dist/lib/node-esm/translations.mjs.map +7 -0
  48. package/dist/lib/node-esm/types/index.mjs +1 -1
  49. package/dist/types/src/ObservabilityPlugin.d.ts +6 -0
  50. package/dist/types/src/ObservabilityPlugin.d.ts.map +1 -1
  51. package/dist/types/src/{cli/plugin.d.ts → ObservabilityPlugin.node.d.ts} +2 -1
  52. package/dist/types/src/ObservabilityPlugin.node.d.ts.map +1 -0
  53. package/dist/types/src/ObservabilityPlugin.test.d.ts +2 -0
  54. package/dist/types/src/ObservabilityPlugin.test.d.ts.map +1 -0
  55. package/dist/types/src/capabilities/app-graph-builder.d.ts.map +1 -1
  56. package/dist/types/src/capabilities/client-ready.d.ts.map +1 -1
  57. package/dist/types/src/capabilities/index.d.ts +2 -6
  58. package/dist/types/src/capabilities/index.d.ts.map +1 -1
  59. package/dist/types/src/capabilities/operation-handler.d.ts +1 -1
  60. package/dist/types/src/capabilities/operation-handler.d.ts.map +1 -1
  61. package/dist/types/src/capabilities/react-surface.d.ts.map +1 -1
  62. package/dist/types/src/capabilities/settings.d.ts +2 -5
  63. package/dist/types/src/capabilities/settings.d.ts.map +1 -1
  64. package/dist/types/src/capabilities/state.d.ts.map +1 -1
  65. package/dist/types/src/components/FeedbackForm/FeedbackForm.d.ts +5 -2
  66. package/dist/types/src/components/FeedbackForm/FeedbackForm.d.ts.map +1 -1
  67. package/dist/types/src/components/FeedbackForm/FeedbackForm.stories.d.ts +19 -19
  68. package/dist/types/src/components/FeedbackForm/FeedbackForm.stories.d.ts.map +1 -1
  69. package/dist/types/src/components/ObservabilitySettings/ObservabilitySettings.d.ts +1 -1
  70. package/dist/types/src/components/ObservabilitySettings/ObservabilitySettings.d.ts.map +1 -1
  71. package/dist/types/src/components/ObservabilitySettings/ObservabilitySettings.stories.d.ts +17 -18
  72. package/dist/types/src/components/ObservabilitySettings/ObservabilitySettings.stories.d.ts.map +1 -1
  73. package/dist/types/src/containers/HelpContainer/HelpContainer.d.ts.map +1 -1
  74. package/dist/types/src/index.d.ts +2 -2
  75. package/dist/types/src/index.d.ts.map +1 -1
  76. package/dist/types/src/operations/capture-user-feedback.d.ts +1 -1
  77. package/dist/types/src/operations/capture-user-feedback.d.ts.map +1 -1
  78. package/dist/types/src/operations/definitions.d.ts +1 -1
  79. package/dist/types/src/operations/definitions.d.ts.map +1 -1
  80. package/dist/types/src/operations/index.d.ts +1 -1
  81. package/dist/types/src/operations/index.d.ts.map +1 -1
  82. package/dist/types/src/operations/send-event.d.ts +1 -1
  83. package/dist/types/src/operations/send-event.d.ts.map +1 -1
  84. package/dist/types/src/operations/toggle.d.ts +1 -1
  85. package/dist/types/src/operations/toggle.d.ts.map +1 -1
  86. package/dist/types/src/translations.d.ts +17 -19
  87. package/dist/types/src/translations.d.ts.map +1 -1
  88. package/dist/types/src/types/Settings.d.ts +3 -2
  89. package/dist/types/src/types/Settings.d.ts.map +1 -1
  90. package/dist/types/src/types/capabilities.d.ts +8 -5
  91. package/dist/types/src/types/capabilities.d.ts.map +1 -1
  92. package/dist/types/src/types/events.d.ts.map +1 -1
  93. package/dist/types/tsconfig.tsbuildinfo +1 -1
  94. package/package.json +43 -40
  95. package/src/{cli/plugin.ts → ObservabilityPlugin.node.ts} +4 -2
  96. package/src/ObservabilityPlugin.test.ts +25 -0
  97. package/src/ObservabilityPlugin.ts +18 -4
  98. package/src/capabilities/app-graph-builder.ts +1 -0
  99. package/src/capabilities/client-ready.ts +23 -1
  100. package/src/capabilities/index.ts +1 -1
  101. package/src/capabilities/operation-handler.ts +1 -1
  102. package/src/capabilities/react-surface.tsx +1 -2
  103. package/src/components/FeedbackForm/FeedbackForm.stories.tsx +13 -1
  104. package/src/components/FeedbackForm/FeedbackForm.tsx +19 -3
  105. package/src/components/ObservabilitySettings/ObservabilitySettings.stories.tsx +2 -1
  106. package/src/components/ObservabilitySettings/ObservabilitySettings.tsx +8 -12
  107. package/src/containers/HelpContainer/HelpContainer.tsx +3 -2
  108. package/src/index.ts +6 -2
  109. package/src/operations/capture-user-feedback.ts +1 -1
  110. package/src/operations/definitions.ts +2 -3
  111. package/src/operations/index.ts +1 -1
  112. package/src/operations/send-event.ts +1 -1
  113. package/src/operations/toggle.ts +1 -1
  114. package/src/translations.ts +1 -2
  115. package/src/types/Settings.ts +5 -2
  116. package/src/types/capabilities.ts +7 -0
  117. package/dist/lib/browser/ObservabilitySettings-EM7ABGCA.mjs.map +0 -7
  118. package/dist/lib/browser/chunk-J6DPYEFZ.mjs.map +0 -7
  119. package/dist/lib/browser/chunk-K33HLC3Z.mjs.map +0 -7
  120. package/dist/lib/browser/chunk-VZR3FNBD.mjs.map +0 -7
  121. package/dist/lib/browser/cli/index.mjs +0 -20
  122. package/dist/lib/browser/cli/index.mjs.map +0 -7
  123. package/dist/lib/browser/toggle-H2GX3A6G.mjs.map +0 -7
  124. package/dist/lib/node-esm/ObservabilitySettings-VP4A362Z.mjs.map +0 -7
  125. package/dist/lib/node-esm/capture-user-feedback-SDQA2VYI.mjs.map +0 -7
  126. package/dist/lib/node-esm/chunk-FZRJBWSE.mjs.map +0 -7
  127. package/dist/lib/node-esm/chunk-JGHMP7UL.mjs.map +0 -7
  128. package/dist/lib/node-esm/chunk-K7WZOJZF.mjs.map +0 -7
  129. package/dist/lib/node-esm/cli/index.mjs +0 -21
  130. package/dist/lib/node-esm/cli/index.mjs.map +0 -7
  131. package/dist/lib/node-esm/send-event-EMV3VHAA.mjs.map +0 -7
  132. package/dist/lib/node-esm/toggle-XRNGEYNP.mjs.map +0 -7
  133. package/dist/types/src/cli/index.d.ts +0 -2
  134. package/dist/types/src/cli/index.d.ts.map +0 -1
  135. package/dist/types/src/cli/plugin.d.ts.map +0 -1
  136. package/src/cli/index.ts +0 -5
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@dxos/plugin-observability",
3
- "version": "0.8.4-main.9be5663bfe",
3
+ "version": "0.8.4-main.abd8ff62ef",
4
4
  "description": "DXOS app framework plugin for hooking up app observability",
5
5
  "homepage": "https://dxos.org",
6
6
  "bugs": "https://github.com/dxos/dxos/issues",
@@ -18,6 +18,12 @@
18
18
  "#containers": "./src/containers/index.ts",
19
19
  "#meta": "./src/meta.ts",
20
20
  "#operations": "./src/operations/index.ts",
21
+ "#translations": "./src/translations.ts",
22
+ "#plugin": {
23
+ "browser": "./src/ObservabilityPlugin.ts",
24
+ "node": "./src/ObservabilityPlugin.node.ts",
25
+ "default": "./src/ObservabilityPlugin.ts"
26
+ },
21
27
  "#types": "./src/types/index.ts"
22
28
  },
23
29
  "exports": {
@@ -27,11 +33,11 @@
27
33
  "browser": "./dist/lib/browser/index.mjs",
28
34
  "node": "./dist/lib/node-esm/index.mjs"
29
35
  },
30
- "./cli": {
31
- "source": "./src/cli/index.ts",
32
- "types": "./dist/types/src/cli/index.d.ts",
33
- "browser": "./dist/lib/browser/cli/index.mjs",
34
- "node": "./dist/lib/node-esm/cli/index.mjs"
36
+ "./components": {
37
+ "source": "./src/components/index.ts",
38
+ "types": "./dist/types/src/components/index.d.ts",
39
+ "browser": "./dist/lib/browser/components/index.mjs",
40
+ "node": "./dist/lib/node-esm/components/index.mjs"
35
41
  },
36
42
  "./operations": {
37
43
  "source": "./src/operations/index.ts",
@@ -39,6 +45,12 @@
39
45
  "browser": "./dist/lib/browser/operations/index.mjs",
40
46
  "node": "./dist/lib/node-esm/operations/index.mjs"
41
47
  },
48
+ "./translations": {
49
+ "source": "./src/translations.ts",
50
+ "types": "./dist/types/src/translations.d.ts",
51
+ "browser": "./dist/lib/browser/translations.mjs",
52
+ "node": "./dist/lib/node-esm/translations.mjs"
53
+ },
42
54
  "./types": {
43
55
  "source": "./src/types/index.ts",
44
56
  "types": "./dist/types/src/types/index.d.ts",
@@ -47,16 +59,6 @@
47
59
  }
48
60
  },
49
61
  "types": "dist/types/src/index.d.ts",
50
- "typesVersions": {
51
- "*": {
52
- "types": [
53
- "dist/types/src/types/index.d.ts"
54
- ],
55
- "operations": [
56
- "dist/types/src/operations/index.d.ts"
57
- ]
58
- }
59
- },
60
62
  "files": [
61
63
  "dist",
62
64
  "src"
@@ -66,34 +68,35 @@
66
68
  "@effect-atom/atom-react": "^0.5.0",
67
69
  "effect": "3.20.0",
68
70
  "localforage": "^1.10.0",
69
- "@dxos/app-framework": "0.8.4-main.9be5663bfe",
70
- "@dxos/app-toolkit": "0.8.4-main.9be5663bfe",
71
- "@dxos/context": "0.8.4-main.9be5663bfe",
72
- "@dxos/async": "0.8.4-main.9be5663bfe",
73
- "@dxos/echo": "0.8.4-main.9be5663bfe",
74
- "@dxos/effect": "0.8.4-main.9be5663bfe",
75
- "@dxos/observability": "0.8.4-main.9be5663bfe",
76
- "@dxos/operation": "0.8.4-main.9be5663bfe",
77
- "@dxos/plugin-graph": "0.8.4-main.9be5663bfe",
78
- "@dxos/invariant": "0.8.4-main.9be5663bfe",
79
- "@dxos/react-client": "0.8.4-main.9be5663bfe",
80
- "@dxos/protocols": "0.8.4-main.9be5663bfe",
81
- "@dxos/react-hooks": "0.8.4-main.9be5663bfe",
82
- "@dxos/react-ui-attention": "0.8.4-main.9be5663bfe",
83
- "@dxos/react-ui-stack": "0.8.4-main.9be5663bfe",
84
- "@dxos/react-ui-form": "0.8.4-main.9be5663bfe",
85
- "@dxos/util": "0.8.4-main.9be5663bfe",
86
- "@dxos/log": "0.8.4-main.9be5663bfe"
71
+ "@dxos/app-toolkit": "0.8.4-main.abd8ff62ef",
72
+ "@dxos/app-framework": "0.8.4-main.abd8ff62ef",
73
+ "@dxos/compute": "0.8.4-main.abd8ff62ef",
74
+ "@dxos/async": "0.8.4-main.abd8ff62ef",
75
+ "@dxos/context": "0.8.4-main.abd8ff62ef",
76
+ "@dxos/echo": "0.8.4-main.abd8ff62ef",
77
+ "@dxos/effect": "0.8.4-main.abd8ff62ef",
78
+ "@dxos/log": "0.8.4-main.abd8ff62ef",
79
+ "@dxos/plugin-graph": "0.8.4-main.abd8ff62ef",
80
+ "@dxos/invariant": "0.8.4-main.abd8ff62ef",
81
+ "@dxos/protocols": "0.8.4-main.abd8ff62ef",
82
+ "@dxos/react-client": "0.8.4-main.abd8ff62ef",
83
+ "@dxos/react-hooks": "0.8.4-main.abd8ff62ef",
84
+ "@dxos/observability": "0.8.4-main.abd8ff62ef",
85
+ "@dxos/react-ui-form": "0.8.4-main.abd8ff62ef",
86
+ "@dxos/react-ui-stack": "0.8.4-main.abd8ff62ef",
87
+ "@dxos/react-ui-attention": "0.8.4-main.abd8ff62ef",
88
+ "@dxos/util": "0.8.4-main.abd8ff62ef"
87
89
  },
88
90
  "devDependencies": {
89
91
  "@effect-atom/atom-react": "^0.5.0",
90
92
  "@effect/platform": "0.94.4",
91
93
  "@types/react": "~19.2.7",
92
94
  "react": "~19.2.3",
93
- "vite": "^7.1.11",
94
- "@dxos/react-ui": "0.8.4-main.9be5663bfe",
95
- "@dxos/storybook-utils": "0.8.4-main.9be5663bfe",
96
- "@dxos/ui-theme": "0.8.4-main.9be5663bfe"
95
+ "vite": "^8.0.10",
96
+ "@dxos/plugin-testing": "0.8.4-main.abd8ff62ef",
97
+ "@dxos/react-ui": "0.8.4-main.abd8ff62ef",
98
+ "@dxos/ui-theme": "0.8.4-main.abd8ff62ef",
99
+ "@dxos/storybook-utils": "0.8.4-main.abd8ff62ef"
97
100
  },
98
101
  "peerDependencies": {
99
102
  "@effect-atom/atom-react": "^0.5.0",
@@ -101,8 +104,8 @@
101
104
  "effect": "3.20.0",
102
105
  "react": "~19.2.3",
103
106
  "react-dom": "~19.2.3",
104
- "@dxos/ui-theme": "0.8.4-main.9be5663bfe",
105
- "@dxos/react-ui": "0.8.4-main.9be5663bfe"
107
+ "@dxos/react-ui": "0.8.4-main.abd8ff62ef",
108
+ "@dxos/ui-theme": "0.8.4-main.abd8ff62ef"
106
109
  },
107
110
  "publishConfig": {
108
111
  "access": "public"
@@ -1,12 +1,12 @@
1
1
  //
2
- // Copyright 2025 DXOS.org
2
+ // Copyright 2026 DXOS.org
3
3
  //
4
4
 
5
5
  import * as Effect from 'effect/Effect';
6
6
 
7
7
  import { Capabilities, Capability, Plugin } from '@dxos/app-framework';
8
8
  import { AppPlugin } from '@dxos/app-toolkit';
9
- import { Operation, OperationHandlerSet } from '@dxos/operation';
9
+ import { Operation, OperationHandlerSet } from '@dxos/compute';
10
10
 
11
11
  import { meta } from '#meta';
12
12
  import { ObservabilityOperation } from '#operations';
@@ -29,3 +29,5 @@ export const ObservabilityPlugin = Plugin.define(meta).pipe(
29
29
  }),
30
30
  Plugin.make,
31
31
  );
32
+
33
+ export default ObservabilityPlugin;
@@ -0,0 +1,25 @@
1
+ //
2
+ // Copyright 2026 DXOS.org
3
+ //
4
+
5
+ import { describe, test } from 'vitest';
6
+
7
+ import { createComposerTestApp } from '@dxos/plugin-testing/harness';
8
+
9
+ import { ObservabilityPlugin } from '#plugin';
10
+
11
+ import { meta } from './meta';
12
+
13
+ const moduleId = (name: string) => `${meta.id}.module.${name}`;
14
+
15
+ describe('ObservabilityPlugin', () => {
16
+ test('modules activate on the expected events', async ({ expect }) => {
17
+ await using harness = await createComposerTestApp({
18
+ // TODO(wittjosiah): Align browser and node variant option types.
19
+ plugins: [ObservabilityPlugin({} as any)],
20
+ });
21
+
22
+ // OperationHandler fires automatically (OperationPlugin fires SetupOperationHandler during Startup).
23
+ expect(harness.manager.getActive()).toContain(moduleId('OperationHandler'));
24
+ });
25
+ });
@@ -17,21 +17,25 @@ import {
17
17
  ReactSurface,
18
18
  } from '#capabilities';
19
19
  import { meta } from '#meta';
20
+ import { translations } from '#translations';
20
21
  import { ClientReadyEvent, ObservabilityEvents } from '#types';
21
22
  import { ObservabilityCapabilities } from '#types';
22
23
 
23
- import { translations } from './translations';
24
-
25
24
  export type ObservabilityPluginOptions = {
26
25
  namespace: string;
27
26
  observability: () => Promise<Observability.Observability>;
27
+ /**
28
+ * Optional callback invoked by the help/feedback UI to download captured logs.
29
+ * When omitted the "Download logs" action is hidden.
30
+ */
31
+ downloadLogs?: () => void | Promise<void>;
28
32
  };
29
33
 
30
34
  export const ObservabilityPlugin = Plugin.define<ObservabilityPluginOptions>(meta).pipe(
31
35
  AppPlugin.addAppGraphModule({ activate: AppGraphBuilder }),
32
36
  AppPlugin.addSurfaceModule({ activate: ReactSurface }),
33
37
  AppPlugin.addTranslationsModule({ translations }),
34
- Plugin.addModule(({ namespace, observability }) => ({
38
+ Plugin.addModule(({ observability }) => ({
35
39
  id: 'observability',
36
40
  activatesOn: ActivationEvents.Startup,
37
41
  activate: () =>
@@ -47,7 +51,7 @@ export const ObservabilityPlugin = Plugin.define<ObservabilityPluginOptions>(met
47
51
  Plugin.addModule(({ namespace }) => ({
48
52
  id: Capability.getModuleTag(ObservabilityState),
49
53
  activatesOn: ActivationEvents.Startup,
50
- activatesAfter: [ObservabilityEvents.StateReady],
54
+ firesAfterActivation: [ObservabilityEvents.StateReady],
51
55
  activate: () => ObservabilityState({ namespace }),
52
56
  })),
53
57
  Plugin.addModule(({ namespace }) => ({
@@ -55,6 +59,14 @@ export const ObservabilityPlugin = Plugin.define<ObservabilityPluginOptions>(met
55
59
  activatesOn: ActivationEvents.Startup,
56
60
  activate: () => Effect.succeed(Capability.contributes(ObservabilityCapabilities.Namespace, namespace)),
57
61
  })),
62
+ Plugin.addModule(({ downloadLogs }) => ({
63
+ id: 'log-downloader',
64
+ activatesOn: ActivationEvents.Startup,
65
+ activate: () =>
66
+ Effect.succeed(
67
+ downloadLogs !== undefined ? Capability.contributes(ObservabilityCapabilities.LogDownloader, downloadLogs) : [],
68
+ ),
69
+ })),
58
70
  AppPlugin.addOperationHandlerModule({ activate: OperationHandler }),
59
71
  Plugin.addModule(({ namespace, observability }) => ({
60
72
  id: Capability.getModuleTag(ClientReady),
@@ -71,3 +83,5 @@ export const ObservabilityPlugin = Plugin.define<ObservabilityPluginOptions>(met
71
83
  })),
72
84
  Plugin.make,
73
85
  );
86
+
87
+ export default ObservabilityPlugin;
@@ -25,6 +25,7 @@ export default Capability.makeModule(
25
25
  icon: 'ph--question--regular',
26
26
  data: null,
27
27
  position: 'hoist',
28
+ joyride: 'welcome/feedback',
28
29
  }),
29
30
  ]),
30
31
  }),
@@ -6,6 +6,7 @@ import * as Effect from 'effect/Effect';
6
6
 
7
7
  import { Capabilities, Capability } from '@dxos/app-framework';
8
8
  import { LayoutOperation, SettingsOperation } from '@dxos/app-toolkit';
9
+ import { log } from '@dxos/log';
9
10
  import { type Observability, ObservabilityProvider } from '@dxos/observability';
10
11
 
11
12
  import { meta } from '#meta';
@@ -49,10 +50,12 @@ export default Capability.makeModule(
49
50
 
50
51
  // Ensure errors are tagged with enabled plugins to help with reproductions.
51
52
  const enabledPlugins = manager.getEnabled();
53
+ log('client-ready: tagging enabled plugins', { count: enabledPlugins.length });
52
54
  for (const plugin of enabledPlugins) {
53
55
  observability.setTags({ [`pluginEnabled-${plugin}`]: 'true' }, 'errors');
54
56
  }
55
57
 
58
+ log('client-ready: sending page.load event');
56
59
  yield* Effect.tryPromise(() =>
57
60
  invokePromise(ObservabilityOperation.SendEvent, {
58
61
  name: 'page.load',
@@ -62,16 +65,34 @@ export default Capability.makeModule(
62
65
  },
63
66
  }),
64
67
  );
68
+ log('client-ready: page.load event sent');
65
69
 
66
- // Add client data providers.
70
+ // Each provider is logged individually because some provider setups perform
71
+ // RPC calls (e.g. runtimeMetricsProvider awaits SystemService.getPlatform());
72
+ // a hung worker pipe surfaces as a missing "added" log, so the last
73
+ // "adding ..." line points to the stall.
74
+ log('client-ready: adding identity data provider');
67
75
  yield* observability.addDataProvider(ObservabilityProvider.Client.identityProvider(client.services.services));
76
+ log('client-ready: identity data provider added');
77
+
78
+ log('client-ready: adding network metrics data provider');
68
79
  yield* observability.addDataProvider(ObservabilityProvider.Client.networkMetricsProvider(client.services.services));
80
+ log('client-ready: network metrics data provider added');
81
+
82
+ log('client-ready: adding runtime metrics data provider');
69
83
  yield* observability.addDataProvider(ObservabilityProvider.Client.runtimeMetricsProvider(client.services.services));
84
+ log('client-ready: runtime metrics data provider added');
85
+
86
+ log('client-ready: adding space metrics data provider');
70
87
  yield* observability.addDataProvider(ObservabilityProvider.Client.spacesMetricsProvider(client));
88
+ log('client-ready: space metrics data provider added');
71
89
 
72
90
  if (client.halo.identity.get()) {
91
+ log('client-ready: identity present, sending privacy notice');
73
92
  yield* Effect.tryPromise(() => sendPrivacyNotice());
93
+ log('client-ready: privacy notice sent');
74
94
  } else {
95
+ log('client-ready: no identity, deferring privacy notice');
75
96
  const subscription = client.halo.identity.subscribe(async (identity) => {
76
97
  if (identity && observability) {
77
98
  await sendPrivacyNotice();
@@ -80,6 +101,7 @@ export default Capability.makeModule(
80
101
  });
81
102
  }
82
103
 
104
+ log('client-ready: contributing observability capability');
83
105
  return Capability.contributes(ObservabilityCapabilities.Observability, observability, () => observability.close());
84
106
  }),
85
107
  );
@@ -3,7 +3,7 @@
3
3
  //
4
4
 
5
5
  import { Capability } from '@dxos/app-framework';
6
- import { OperationHandlerSet } from '@dxos/operation';
6
+ import { OperationHandlerSet } from '@dxos/compute';
7
7
 
8
8
  import type { ClientReadyOptions } from './client-ready';
9
9
 
@@ -5,7 +5,7 @@
5
5
  import * as Effect from 'effect/Effect';
6
6
 
7
7
  import { Capabilities, Capability } from '@dxos/app-framework';
8
- import type { OperationHandlerSet } from '@dxos/operation';
8
+ import type { OperationHandlerSet } from '@dxos/compute';
9
9
 
10
10
  import { ObservabilityOperationHandlerSet } from '#operations';
11
11
 
@@ -20,8 +20,7 @@ export default Capability.makeModule(() =>
20
20
  Capability.contributes(Capabilities.ReactSurface, [
21
21
  Surface.create({
22
22
  id: 'root',
23
- role: 'article',
24
- filter: AppSurface.settingsArticle(meta.id),
23
+ filter: AppSurface.settings(AppSurface.Article, meta.id),
25
24
  component: ({ data: { subject } }) => {
26
25
  const { settings } = useSettingsState<Settings.Settings>(subject.atom);
27
26
  const { invokePromise } = useOperationInvoker();
@@ -6,7 +6,8 @@ import { type Meta, type StoryObj } from '@storybook/react-vite';
6
6
 
7
7
  import { withLayout, withTheme } from '@dxos/react-ui/testing';
8
8
 
9
- import { translations } from '../../translations';
9
+ import { translations } from '#translations';
10
+
10
11
  import { FeedbackForm } from './FeedbackForm';
11
12
 
12
13
  const meta = {
@@ -30,3 +31,14 @@ export const Default: Story = {
30
31
  },
31
32
  },
32
33
  };
34
+
35
+ export const WithDownloadLogs: Story = {
36
+ args: {
37
+ onSave: (values) => {
38
+ console.log(values);
39
+ },
40
+ onDownloadLogs: () => {
41
+ console.log('download logs clicked');
42
+ },
43
+ },
44
+ };
@@ -4,20 +4,24 @@
4
4
 
5
5
  import React from 'react';
6
6
 
7
- import { useTranslation } from '@dxos/react-ui';
7
+ import { IconButton, useTranslation } from '@dxos/react-ui';
8
8
  import { Form, type FormRootProps, type FormSubmitProps } from '@dxos/react-ui-form';
9
9
 
10
10
  import { meta } from '#meta';
11
11
  import { UserFeedback } from '#operations';
12
12
 
13
- export type FeedbackFormProps = Pick<FormRootProps<UserFeedback>, 'onSave'> & Pick<FormSubmitProps, 'disabled'>;
13
+ export type FeedbackFormProps = Pick<FormRootProps<UserFeedback>, 'onSave'> &
14
+ Pick<FormSubmitProps, 'disabled'> & {
15
+ /** Optional handler — when supplied a "Download logs" button is rendered below the submit action. */
16
+ onDownloadLogs?: () => void | Promise<void>;
17
+ };
14
18
 
15
19
  const defaultValues: UserFeedback = {
16
20
  message: '',
17
21
  includeLogs: true,
18
22
  };
19
23
 
20
- export const FeedbackForm = ({ onSave, disabled }: FeedbackFormProps) => {
24
+ export const FeedbackForm = ({ onSave, disabled, onDownloadLogs }: FeedbackFormProps) => {
21
25
  const { t } = useTranslation(meta.id);
22
26
 
23
27
  return (
@@ -26,6 +30,18 @@ export const FeedbackForm = ({ onSave, disabled }: FeedbackFormProps) => {
26
30
  <Form.Content>
27
31
  <Form.FieldSet />
28
32
  <Form.Submit icon='ph--paper-plane-tilt--regular' label={t('send-feedback.label')} disabled={disabled} />
33
+ {onDownloadLogs && (
34
+ <div role='none' className='flex w-full pt-form-padding'>
35
+ <IconButton
36
+ classNames='w-full'
37
+ type='button'
38
+ icon='ph--download-simple--regular'
39
+ label={t('download-logs.label')}
40
+ onClick={() => void onDownloadLogs()}
41
+ data-testid='download-logs-button'
42
+ />
43
+ </div>
44
+ )}
29
45
  </Form.Content>
30
46
  </Form.Viewport>
31
47
  </Form.Root>
@@ -6,7 +6,8 @@ import { type Meta, type StoryObj } from '@storybook/react-vite';
6
6
 
7
7
  import { withLayout, withTheme } from '@dxos/react-ui/testing';
8
8
 
9
- import { translations } from '../../translations';
9
+ import { translations } from '#translations';
10
+
10
11
  import { ObservabilitySettings } from './ObservabilitySettings';
11
12
 
12
13
  const meta = {
@@ -5,11 +5,11 @@
5
5
  import React from 'react';
6
6
 
7
7
  import { type AppSurface } from '@dxos/app-toolkit/ui';
8
- import { Input, Message, useTranslation } from '@dxos/react-ui';
8
+ import { Message, useTranslation } from '@dxos/react-ui';
9
9
  import { Settings as SettingsForm } from '@dxos/react-ui-form';
10
10
 
11
11
  import { meta } from '#meta';
12
- import { type Settings } from '#types';
12
+ import { Settings } from '#types';
13
13
 
14
14
  export type ObservabilitySettingsProps = AppSurface.SettingsArticleProps<Settings.Settings>;
15
15
 
@@ -22,16 +22,12 @@ export const ObservabilitySettings = ({ settings, onSettingsChange }: Observabil
22
22
  <Message.Root valence='info'>
23
23
  <Message.Content>{t('observability.description')}</Message.Content>
24
24
  </Message.Root>
25
- <SettingsForm.Item
26
- title={t('observability-enabled.label')}
27
- description={t('observability-enabled.description')}
28
- >
29
- <Input.Switch
30
- disabled={!onSettingsChange}
31
- checked={settings.enabled}
32
- onCheckedChange={(checked) => onSettingsChange?.((s) => ({ ...s, enabled: !!checked }))}
33
- />
34
- </SettingsForm.Item>
25
+ <SettingsForm.FieldSet
26
+ readonly={!onSettingsChange}
27
+ schema={Settings.Settings}
28
+ values={settings}
29
+ onValuesChanged={(values) => onSettingsChange?.(() => values)}
30
+ />
35
31
  </SettingsForm.Section>
36
32
  </SettingsForm.Viewport>
37
33
  );
@@ -5,7 +5,7 @@
5
5
  import * as Effect from 'effect/Effect';
6
6
  import React, { useCallback, useState } from 'react';
7
7
 
8
- import { useCapability, useOperationInvoker } from '@dxos/app-framework/ui';
8
+ import { useCapabilities, useCapability, useOperationInvoker } from '@dxos/app-framework/ui';
9
9
  import { LayoutOperation } from '@dxos/app-toolkit';
10
10
  import { runAndForwardErrors } from '@dxos/effect';
11
11
  import { useAsyncEffect } from '@dxos/react-hooks';
@@ -20,6 +20,7 @@ import { ObservabilityCapabilities } from '#types';
20
20
  export const HelpContainer = () => {
21
21
  const { invokePromise } = useOperationInvoker();
22
22
  const observability = useCapability(ObservabilityCapabilities.Observability);
23
+ const [downloadLogs] = useCapabilities(ObservabilityCapabilities.LogDownloader);
23
24
  const [feedbackAvailable, setFeedbackAvailable] = useState(false);
24
25
 
25
26
  useAsyncEffect(
@@ -52,5 +53,5 @@ export const HelpContainer = () => {
52
53
  [invokePromise],
53
54
  );
54
55
 
55
- return <FeedbackForm onSave={handleSave} disabled={!feedbackAvailable} />;
56
+ return <FeedbackForm onSave={handleSave} disabled={!feedbackAvailable} onDownloadLogs={downloadLogs} />;
56
57
  };
package/src/index.ts CHANGED
@@ -2,8 +2,12 @@
2
2
  // Copyright 2023 DXOS.org
3
3
  //
4
4
 
5
+ import { Plugin } from '@dxos/app-framework';
6
+
7
+ import { meta } from './meta';
8
+
5
9
  export { ObservabilityCapabilities, ObservabilityEvents } from './types';
6
- export * from './components';
10
+ // TODO(wittjosiah): FeedbackForm should be factored out of plugin-observability into a shared UI package.
7
11
  export * from './meta';
8
- export * from './ObservabilityPlugin';
12
+ export const ObservabilityPlugin = Plugin.lazy(meta, () => import('#plugin'));
9
13
  export { translations as observabilityTranslations } from './translations';
@@ -5,7 +5,7 @@
5
5
  import * as Effect from 'effect/Effect';
6
6
 
7
7
  import { Capability } from '@dxos/app-framework';
8
- import { Operation } from '@dxos/operation';
8
+ import { Operation } from '@dxos/compute';
9
9
 
10
10
  import { ObservabilityCapabilities } from '../types';
11
11
  import { CaptureUserFeedback } from './definitions';
@@ -5,12 +5,11 @@
5
5
  import * as Schema from 'effect/Schema';
6
6
 
7
7
  import { Capability } from '@dxos/app-framework';
8
+ import { Operation } from '@dxos/compute';
8
9
  import { Format } from '@dxos/echo';
9
- import { Operation } from '@dxos/operation';
10
10
 
11
11
  import { meta } from '#meta';
12
-
13
- import { translations } from '../translations';
12
+ import { translations } from '#translations';
14
13
 
15
14
  const t = translations[0]['en-US'][meta.id];
16
15
 
@@ -2,7 +2,7 @@
2
2
  // Copyright 2025 DXOS.org
3
3
  //
4
4
 
5
- import { OperationHandlerSet } from '@dxos/operation';
5
+ import { OperationHandlerSet } from '@dxos/compute';
6
6
 
7
7
  export * as ObservabilityOperation from './definitions';
8
8
  export { UserFeedback } from './definitions';
@@ -5,7 +5,7 @@
5
5
  import * as Effect from 'effect/Effect';
6
6
 
7
7
  import { Capability } from '@dxos/app-framework';
8
- import { Operation } from '@dxos/operation';
8
+ import { Operation } from '@dxos/compute';
9
9
 
10
10
  import { ObservabilityCapabilities } from '../types';
11
11
  import { SendEvent } from './definitions';
@@ -6,8 +6,8 @@ import * as Effect from 'effect/Effect';
6
6
 
7
7
  import { Capabilities, Capability } from '@dxos/app-framework';
8
8
  import { AppCapabilities } from '@dxos/app-toolkit';
9
+ import { Operation } from '@dxos/compute';
9
10
  import { Observability } from '@dxos/observability';
10
- import { Operation } from '@dxos/operation';
11
11
 
12
12
  import { meta } from '#meta';
13
13
 
@@ -18,8 +18,6 @@ export const translations = [
18
18
  'observability-toast-action.label': 'Settings',
19
19
  'observability-toast-action.alt': 'Open settings to learn more or to disable.',
20
20
  'observability-toast-close.label': 'Okay',
21
- 'observability-enabled.label': 'Enable telemetry',
22
- 'observability-enabled.description': 'Send anonymous usage and performance data to help improve the product.',
23
21
  // TODO: Add link about telemetry privacy. Make it clearer that user data is not collected.
24
22
  'observability.description':
25
23
  'When enabled, basic usage data will used to improve the product. This may include 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.',
@@ -28,6 +26,7 @@ export const translations = [
28
26
  'feedback-textarea.placeholder': 'Please enter your feedback, technical issue, or feature request.',
29
27
  'include-debug-logs.label': 'Include debug logs',
30
28
  'send-feedback.label': 'Send Feedback',
29
+ 'download-logs.label': 'Download logs',
31
30
  'feedback-toast.label': 'Thank you for your feedback!',
32
31
  'feedback-toast.description': 'We will review your feedback and get back to you as soon as possible.',
33
32
  },
@@ -8,7 +8,10 @@ import * as Schema from 'effect/Schema';
8
8
 
9
9
  export const Settings = Schema.mutable(
10
10
  Schema.Struct({
11
- enabled: Schema.Boolean,
11
+ enabled: Schema.Boolean.annotations({
12
+ title: 'Enable telemetry',
13
+ description: 'Send anonymous usage and performance data to help improve the product.',
14
+ }),
12
15
  // TODO(wittjosiah): Separate settings for each observability feature.
13
16
  // metrics?: boolean;
14
17
  // telemetry?: boolean;
@@ -16,4 +19,4 @@ export const Settings = Schema.mutable(
16
19
  }),
17
20
  );
18
21
 
19
- export type Settings = Schema.Schema.Type<typeof Settings>;
22
+ export interface Settings extends Schema.Schema.Type<typeof Settings> {}
@@ -30,6 +30,13 @@ export namespace ObservabilityCapabilities {
30
30
  export const State = Capability.make<Atom.Writable<State>>(`${meta.id}.capability.state`);
31
31
 
32
32
  export const Observability = Capability.make<Observability.Observability>(`${meta.id}.capability.observability`);
33
+
34
+ /**
35
+ * Optional capability — when contributed, the help/feedback UI exposes a "Download logs" action.
36
+ * The callback is responsible for the entire download (read store, encode, save file).
37
+ */
38
+ export type LogDownloader = () => void | Promise<void>;
39
+ export const LogDownloader = Capability.make<LogDownloader>(`${meta.id}.capability.log-downloader`);
33
40
  }
34
41
 
35
42
  // NOTE: This is cloned from the client plugin to avoid circular dependencies.
@@ -1,7 +0,0 @@
1
- {
2
- "version": 3,
3
- "sources": ["../../../src/components/ObservabilitySettings/ObservabilitySettings.tsx"],
4
- "sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport React from 'react';\n\nimport { type AppSurface } from '@dxos/app-toolkit/ui';\nimport { Input, Message, useTranslation } from '@dxos/react-ui';\nimport { Settings as SettingsForm } from '@dxos/react-ui-form';\n\nimport { meta } from '#meta';\nimport { type Settings } from '#types';\n\nexport type ObservabilitySettingsProps = AppSurface.SettingsArticleProps<Settings.Settings>;\n\nexport const ObservabilitySettings = ({ settings, onSettingsChange }: ObservabilitySettingsProps) => {\n const { t } = useTranslation(meta.id);\n\n return (\n <SettingsForm.Viewport>\n <SettingsForm.Section title={t('settings.title', { ns: meta.id })}>\n <Message.Root valence='info'>\n <Message.Content>{t('observability.description')}</Message.Content>\n </Message.Root>\n <SettingsForm.Item\n title={t('observability-enabled.label')}\n description={t('observability-enabled.description')}\n >\n <Input.Switch\n disabled={!onSettingsChange}\n checked={settings.enabled}\n onCheckedChange={(checked) => onSettingsChange?.((s) => ({ ...s, enabled: !!checked }))}\n />\n </SettingsForm.Item>\n </SettingsForm.Section>\n </SettingsForm.Viewport>\n );\n};\n"],
5
- "mappings": ";;;AAIA,OAAOA,WAAW;AAGlB,SAASC,OAAOC,SAASC,sBAAsB;AAC/C,SAASC,YAAYC,oBAAoB;AAEzC,SAASC,YAAY;AAKd,IAAMC,wBAAwB,CAAC,EAAEC,UAAUC,iBAAgB,MAA8B;AAC9F,QAAM,EAAEC,EAAC,IAAKC,eAAeC,KAAKC,EAAE;AAEpC,SACE,sBAAA,cAACC,aAAaC,UAAQ,MACpB,sBAAA,cAACD,aAAaE,SAAO;IAACC,OAAOP,EAAE,kBAAkB;MAAEQ,IAAIN,KAAKC;IAAG,CAAA;KAC7D,sBAAA,cAACM,QAAQC,MAAI;IAACC,SAAQ;KACpB,sBAAA,cAACF,QAAQG,SAAO,MAAEZ,EAAE,2BAAA,CAAA,CAAA,GAEtB,sBAAA,cAACI,aAAaS,MAAI;IAChBN,OAAOP,EAAE,6BAAA;IACTc,aAAad,EAAE,mCAAA;KAEf,sBAAA,cAACe,MAAMC,QAAM;IACXC,UAAU,CAAClB;IACXmB,SAASpB,SAASqB;IAClBC,iBAAiB,CAACF,YAAYnB,mBAAmB,CAACsB,OAAO;MAAE,GAAGA;MAAGF,SAAS,CAAC,CAACD;IAAQ,EAAA;;AAMhG;",
6
- "names": ["React", "Input", "Message", "useTranslation", "Settings", "SettingsForm", "meta", "ObservabilitySettings", "settings", "onSettingsChange", "t", "useTranslation", "meta", "id", "SettingsForm", "Viewport", "Section", "title", "ns", "Message", "Root", "valence", "Content", "Item", "description", "Input", "Switch", "disabled", "checked", "enabled", "onCheckedChange", "s"]
7
- }