@dxos/plugin-observability 0.7.4-staging.f7e8224 → 0.7.5-feature-compute.4d9d99a

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 (119) hide show
  1. package/dist/lib/browser/chunk-BAU7OKYM.mjs +58 -0
  2. package/dist/lib/browser/chunk-BAU7OKYM.mjs.map +7 -0
  3. package/dist/lib/browser/chunk-BWEAT3RG.mjs +12 -0
  4. package/dist/lib/browser/chunk-BWEAT3RG.mjs.map +7 -0
  5. package/dist/lib/browser/chunk-H2SQZM4P.mjs +18 -0
  6. package/dist/lib/browser/chunk-H2SQZM4P.mjs.map +7 -0
  7. package/dist/lib/browser/chunk-K2Y64RO7.mjs +37 -0
  8. package/dist/lib/browser/chunk-K2Y64RO7.mjs.map +7 -0
  9. package/dist/lib/browser/client-ready-3J4QVJE6.mjs +104 -0
  10. package/dist/lib/browser/client-ready-3J4QVJE6.mjs.map +7 -0
  11. package/dist/lib/browser/index.mjs +74 -200
  12. package/dist/lib/browser/index.mjs.map +4 -4
  13. package/dist/lib/browser/intents-resolver-P36HTRAG.mjs +55 -0
  14. package/dist/lib/browser/intents-resolver-P36HTRAG.mjs.map +7 -0
  15. package/dist/lib/browser/meta.json +1 -1
  16. package/dist/lib/browser/react-surface-MPOMS7ZD.mjs +26 -0
  17. package/dist/lib/browser/react-surface-MPOMS7ZD.mjs.map +7 -0
  18. package/dist/lib/browser/settings-T23OKKWF.mjs +25 -0
  19. package/dist/lib/browser/settings-T23OKKWF.mjs.map +7 -0
  20. package/dist/lib/browser/state-FQ6WMLXG.mjs +26 -0
  21. package/dist/lib/browser/state-FQ6WMLXG.mjs.map +7 -0
  22. package/dist/lib/browser/types.mjs +10 -0
  23. package/dist/lib/node/chunk-44EFFE6E.cjs +38 -0
  24. package/dist/lib/node/chunk-44EFFE6E.cjs.map +7 -0
  25. package/dist/lib/node/chunk-GSKCHQV5.cjs +78 -0
  26. package/dist/lib/node/chunk-GSKCHQV5.cjs.map +7 -0
  27. package/dist/lib/node/{meta.cjs → chunk-HLDDHG6J.cjs} +12 -9
  28. package/dist/lib/node/chunk-HLDDHG6J.cjs.map +7 -0
  29. package/dist/lib/node/chunk-UYLJVCUK.cjs +65 -0
  30. package/dist/lib/node/chunk-UYLJVCUK.cjs.map +7 -0
  31. package/dist/lib/node/client-ready-UQHLLUQI.cjs +115 -0
  32. package/dist/lib/node/client-ready-UQHLLUQI.cjs.map +7 -0
  33. package/dist/lib/node/index.cjs +69 -193
  34. package/dist/lib/node/index.cjs.map +4 -4
  35. package/dist/lib/node/intents-resolver-E7LSFPS6.cjs +66 -0
  36. package/dist/lib/node/intents-resolver-E7LSFPS6.cjs.map +7 -0
  37. package/dist/lib/node/meta.json +1 -1
  38. package/dist/lib/node/react-surface-F77LLZIF.cjs +50 -0
  39. package/dist/lib/node/react-surface-F77LLZIF.cjs.map +7 -0
  40. package/dist/lib/node/settings-BUWSSDPF.cjs +39 -0
  41. package/dist/lib/node/settings-BUWSSDPF.cjs.map +7 -0
  42. package/dist/lib/node/state-NL2ZZN3S.cjs +40 -0
  43. package/dist/lib/node/state-NL2ZZN3S.cjs.map +7 -0
  44. package/dist/lib/node/types.cjs +32 -0
  45. package/dist/lib/node/types.cjs.map +7 -0
  46. package/dist/lib/node-esm/chunk-DF2CPSQB.mjs +59 -0
  47. package/dist/lib/node-esm/chunk-DF2CPSQB.mjs.map +7 -0
  48. package/dist/lib/node-esm/chunk-PZRWMBEG.mjs +38 -0
  49. package/dist/lib/node-esm/chunk-PZRWMBEG.mjs.map +7 -0
  50. package/dist/lib/node-esm/chunk-SCQR7W6A.mjs +19 -0
  51. package/dist/lib/node-esm/chunk-SCQR7W6A.mjs.map +7 -0
  52. package/dist/lib/node-esm/chunk-YK5MJX7W.mjs +14 -0
  53. package/dist/lib/node-esm/chunk-YK5MJX7W.mjs.map +7 -0
  54. package/dist/lib/node-esm/client-ready-LPGIUDS2.mjs +105 -0
  55. package/dist/lib/node-esm/client-ready-LPGIUDS2.mjs.map +7 -0
  56. package/dist/lib/node-esm/index.mjs +74 -200
  57. package/dist/lib/node-esm/index.mjs.map +4 -4
  58. package/dist/lib/node-esm/intents-resolver-QDAK6TMP.mjs +56 -0
  59. package/dist/lib/node-esm/intents-resolver-QDAK6TMP.mjs.map +7 -0
  60. package/dist/lib/node-esm/meta.json +1 -1
  61. package/dist/lib/node-esm/react-surface-MMGCSPXQ.mjs +27 -0
  62. package/dist/lib/node-esm/react-surface-MMGCSPXQ.mjs.map +7 -0
  63. package/dist/lib/node-esm/settings-WWUULM4T.mjs +26 -0
  64. package/dist/lib/node-esm/settings-WWUULM4T.mjs.map +7 -0
  65. package/dist/lib/node-esm/state-AM2ICAXU.mjs +27 -0
  66. package/dist/lib/node-esm/state-AM2ICAXU.mjs.map +7 -0
  67. package/dist/lib/node-esm/{meta.mjs → types.mjs} +5 -6
  68. package/dist/types/src/ObservabilityPlugin.d.ts +1 -11
  69. package/dist/types/src/ObservabilityPlugin.d.ts.map +1 -1
  70. package/dist/types/src/capabilities/capabilities.d.ts +12 -0
  71. package/dist/types/src/capabilities/capabilities.d.ts.map +1 -0
  72. package/dist/types/src/capabilities/client-ready.d.ts +10 -0
  73. package/dist/types/src/capabilities/client-ready.d.ts.map +1 -0
  74. package/dist/types/src/capabilities/index.d.ts +16 -0
  75. package/dist/types/src/capabilities/index.d.ts.map +1 -0
  76. package/dist/types/src/capabilities/intents-resolver.d.ts +7 -0
  77. package/dist/types/src/capabilities/intents-resolver.d.ts.map +1 -0
  78. package/dist/types/src/capabilities/react-surface.d.ts +4 -0
  79. package/dist/types/src/capabilities/react-surface.d.ts.map +1 -0
  80. package/dist/types/src/capabilities/settings.d.ts +4 -0
  81. package/dist/types/src/capabilities/settings.d.ts.map +1 -0
  82. package/dist/types/src/capabilities/state.d.ts +6 -0
  83. package/dist/types/src/capabilities/state.d.ts.map +1 -0
  84. package/dist/types/src/components/ObservabilitySettings.d.ts +5 -3
  85. package/dist/types/src/components/ObservabilitySettings.d.ts.map +1 -1
  86. package/dist/types/src/events.d.ts +5 -0
  87. package/dist/types/src/events.d.ts.map +1 -0
  88. package/dist/types/src/index.d.ts +3 -2
  89. package/dist/types/src/index.d.ts.map +1 -1
  90. package/dist/types/src/meta.d.ts +1 -12
  91. package/dist/types/src/meta.d.ts.map +1 -1
  92. package/dist/types/src/types.d.ts +47 -0
  93. package/dist/types/src/types.d.ts.map +1 -0
  94. package/dist/types/tsconfig.tsbuildinfo +1 -0
  95. package/package.json +25 -25
  96. package/src/ObservabilityPlugin.ts +60 -0
  97. package/src/capabilities/capabilities.ts +22 -0
  98. package/src/capabilities/client-ready.ts +99 -0
  99. package/src/capabilities/index.ts +13 -0
  100. package/src/capabilities/intents-resolver.ts +53 -0
  101. package/src/capabilities/react-surface.tsx +26 -0
  102. package/src/capabilities/settings.ts +19 -0
  103. package/src/capabilities/state.ts +21 -0
  104. package/src/components/ObservabilitySettings.tsx +29 -31
  105. package/src/events.ts +14 -0
  106. package/src/index.ts +3 -4
  107. package/src/meta.ts +1 -14
  108. package/src/types.ts +54 -0
  109. package/dist/lib/browser/chunk-FO5EMZZO.mjs +0 -20
  110. package/dist/lib/browser/chunk-FO5EMZZO.mjs.map +0 -7
  111. package/dist/lib/browser/meta.mjs +0 -11
  112. package/dist/lib/node/chunk-RAB7T73W.cjs +0 -44
  113. package/dist/lib/node/chunk-RAB7T73W.cjs.map +0 -7
  114. package/dist/lib/node/meta.cjs.map +0 -7
  115. package/dist/lib/node-esm/chunk-UVEE3XZO.mjs +0 -22
  116. package/dist/lib/node-esm/chunk-UVEE3XZO.mjs.map +0 -7
  117. package/src/ObservabilityPlugin.tsx +0 -221
  118. /package/dist/lib/browser/{meta.mjs.map → types.mjs.map} +0 -0
  119. /package/dist/lib/node-esm/{meta.mjs.map → types.mjs.map} +0 -0
@@ -0,0 +1,53 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ import { Capabilities, contributes, createResolver, type PluginsContext } from '@dxos/app-framework';
6
+ import { getTelemetryIdentifier, storeObservabilityDisabled } from '@dxos/observability';
7
+
8
+ import { ClientCapability, ObservabilityCapabilities } from './capabilities';
9
+ import { type ObservabilitySettingsProps } from '../components';
10
+ import { OBSERVABILITY_PLUGIN } from '../meta';
11
+ import { ObservabilityAction } from '../types';
12
+
13
+ export default ({ context, namespace }: { context: PluginsContext; namespace: string }) =>
14
+ contributes(Capabilities.IntentResolver, [
15
+ createResolver(ObservabilityAction.Toggle, async ({ state }) => {
16
+ const client = context.requestCapability(ClientCapability);
17
+ const observability = context.requestCapability(ObservabilityCapabilities.Observability);
18
+ const settings = context
19
+ .requestCapability(Capabilities.SettingsStore)
20
+ .getStore<ObservabilitySettingsProps>(OBSERVABILITY_PLUGIN)!.value;
21
+ settings.enabled = state ?? !settings.enabled;
22
+ observability.event({
23
+ identityId: getTelemetryIdentifier(client),
24
+ name: `${namespace}.observability.toggle`,
25
+ properties: {
26
+ enabled: settings.enabled,
27
+ },
28
+ });
29
+ observability.setMode(settings.enabled ? 'basic' : 'disabled');
30
+ await storeObservabilityDisabled(namespace, !settings.enabled);
31
+ return { data: settings.enabled };
32
+ }),
33
+ createResolver(ObservabilityAction.SendEvent, (data) => {
34
+ const client = context.requestCapability(ClientCapability);
35
+ // NOTE: This is to ensure that events fired before observability is ready are still sent.
36
+ // TODO(wittjosiah): If the intent dispatcher supports concurrent actions in the future,
37
+ // then this could awaited still rather than voiding.
38
+ void context.waitForCapability(ObservabilityCapabilities.Observability).then((observability) => {
39
+ const event = {
40
+ identityId: getTelemetryIdentifier(client),
41
+ name: `${namespace}.${data.name}`,
42
+ properties: {
43
+ ...data.properties,
44
+ },
45
+ };
46
+ observability.event(event);
47
+ });
48
+ }),
49
+ createResolver(ObservabilityAction.CaptureUserFeedback, async (data) => {
50
+ const observability = context.requestCapability(ObservabilityCapabilities.Observability);
51
+ observability.captureUserFeedback(data.email, data.name, data.message);
52
+ }),
53
+ ]);
@@ -0,0 +1,26 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ import React from 'react';
6
+
7
+ import { contributes, useCapability, Capabilities, createSurface } from '@dxos/app-framework';
8
+
9
+ import { ObservabilitySettings, type ObservabilitySettingsProps } from '../components';
10
+ import { OBSERVABILITY_PLUGIN } from '../meta';
11
+
12
+ export default () =>
13
+ contributes(
14
+ Capabilities.ReactSurface,
15
+ createSurface({
16
+ id: OBSERVABILITY_PLUGIN,
17
+ role: 'settings',
18
+ filter: (data): data is any => data.subject === OBSERVABILITY_PLUGIN,
19
+ component: () => {
20
+ const settings = useCapability(Capabilities.SettingsStore).getStore<ObservabilitySettingsProps>(
21
+ OBSERVABILITY_PLUGIN,
22
+ )!.value;
23
+ return <ObservabilitySettings settings={settings} />;
24
+ },
25
+ }),
26
+ );
@@ -0,0 +1,19 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ import { Capabilities, contributes } from '@dxos/app-framework';
6
+ import { create } from '@dxos/live-object';
7
+
8
+ import { type ObservabilitySettingsProps, ObservabilitySettingsSchema } from '../components';
9
+ import { OBSERVABILITY_PLUGIN } from '../meta';
10
+
11
+ export default () => {
12
+ const settings = create<ObservabilitySettingsProps>({ enabled: true });
13
+
14
+ return contributes(Capabilities.Settings, {
15
+ schema: ObservabilitySettingsSchema,
16
+ prefix: OBSERVABILITY_PLUGIN,
17
+ value: settings,
18
+ });
19
+ };
@@ -0,0 +1,21 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ import { contributes } from '@dxos/app-framework';
6
+ import { LocalStorageStore } from '@dxos/local-storage';
7
+ import { getObservabilityGroup } from '@dxos/observability';
8
+
9
+ import { ObservabilityCapabilities } from './capabilities';
10
+ import { OBSERVABILITY_PLUGIN } from '../meta';
11
+
12
+ export default async ({ namespace }: { namespace: string }) => {
13
+ const state = new LocalStorageStore<ObservabilityCapabilities.State>(OBSERVABILITY_PLUGIN);
14
+
15
+ state.prop({ key: 'notified', type: LocalStorageStore.bool({ allowUndefined: true }) });
16
+
17
+ // NOTE: This is not stored in local storage such that it can be accessed by workers.
18
+ state.values.group = await getObservabilityGroup(namespace);
19
+
20
+ return contributes(ObservabilityCapabilities.State, state.values, () => state.close());
21
+ };
@@ -4,47 +4,45 @@
4
4
 
5
5
  import React from 'react';
6
6
 
7
- import { parseIntentPlugin, useResolvePlugin } from '@dxos/app-framework';
7
+ import { createIntent, useIntentDispatcher } from '@dxos/app-framework';
8
+ import { S } from '@dxos/echo-schema';
8
9
  import { Input, Message, useTranslation } from '@dxos/react-ui';
9
10
  import { DeprecatedFormInput } from '@dxos/react-ui-form';
10
11
 
11
- import { OBSERVABILITY_PLUGIN, ObservabilityAction } from '../meta';
12
+ import { OBSERVABILITY_PLUGIN } from '../meta';
13
+ import { ObservabilityAction } from '../types';
12
14
 
13
- export type ObservabilitySettingsProps = {
14
- enabled?: boolean;
15
- // TODO(wittjosiah): Separate settings for each observability feature.
16
- // metrics?: boolean;
17
- // telemetry?: boolean;
18
- // errors?: boolean;
19
- };
15
+ export const ObservabilitySettingsSchema = S.mutable(
16
+ S.Struct({
17
+ enabled: S.Boolean,
18
+ // TODO(wittjosiah): Separate settings for each observability feature.
19
+ // metrics?: boolean;
20
+ // telemetry?: boolean;
21
+ // errors?: boolean;
22
+ }),
23
+ );
24
+
25
+ export type ObservabilitySettingsProps = S.Schema.Type<typeof ObservabilitySettingsSchema>;
20
26
 
21
27
  export const ObservabilitySettings = ({ settings }: { settings: ObservabilitySettingsProps }) => {
22
28
  const { t } = useTranslation(OBSERVABILITY_PLUGIN);
23
- const intentPlugin = useResolvePlugin(parseIntentPlugin);
29
+ const { dispatchPromise: dispatch } = useIntentDispatcher();
24
30
 
25
31
  return (
26
32
  <>
27
- {intentPlugin && (
28
- <DeprecatedFormInput
29
- label={t('observability enabled label')}
30
- secondary={
31
- <Message.Root valence='info'>
32
- <Message.Body>{t('observability description')}</Message.Body>
33
- </Message.Root>
34
- }
35
- >
36
- <Input.Switch
37
- checked={settings.enabled}
38
- onCheckedChange={(checked) =>
39
- intentPlugin.provides.intent.dispatch({
40
- plugin: OBSERVABILITY_PLUGIN,
41
- action: ObservabilityAction.TOGGLE,
42
- data: { state: !!checked },
43
- })
44
- }
45
- />
46
- </DeprecatedFormInput>
47
- )}
33
+ <DeprecatedFormInput
34
+ label={t('observability enabled label')}
35
+ secondary={
36
+ <Message.Root valence='info'>
37
+ <Message.Body>{t('observability description')}</Message.Body>
38
+ </Message.Root>
39
+ }
40
+ >
41
+ <Input.Switch
42
+ checked={settings.enabled}
43
+ onCheckedChange={(checked) => dispatch(createIntent(ObservabilityAction.Toggle, { state: !!checked }))}
44
+ />
45
+ </DeprecatedFormInput>
48
46
  </>
49
47
  );
50
48
  };
package/src/events.ts ADDED
@@ -0,0 +1,14 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ import { defineEvent, Events } from '@dxos/app-framework';
6
+
7
+ import { OBSERVABILITY_PLUGIN } from './meta';
8
+
9
+ export namespace ObservabilityEvents {
10
+ export const StateReady = Events.createStateEvent(OBSERVABILITY_PLUGIN);
11
+ }
12
+
13
+ // NOTE: This is cloned from the client plugin to avoid circular dependencies.
14
+ export const ClientReadyEvent = defineEvent('dxos.org/plugin/client/event/client-ready');
package/src/index.ts CHANGED
@@ -2,8 +2,7 @@
2
2
  // Copyright 2023 DXOS.org
3
3
  //
4
4
 
5
- import { ObservabilityPlugin } from './ObservabilityPlugin';
6
-
7
- export default ObservabilityPlugin;
8
-
5
+ export { ObservabilityCapabilities } from './capabilities';
6
+ export { ObservabilityEvents } from './events';
7
+ export * from './meta';
9
8
  export * from './ObservabilityPlugin';
package/src/meta.ts CHANGED
@@ -6,20 +6,7 @@ import { type PluginMeta } from '@dxos/app-framework';
6
6
 
7
7
  export const OBSERVABILITY_PLUGIN = 'dxos.org/plugin/observability';
8
8
 
9
- export default {
9
+ export const meta = {
10
10
  id: OBSERVABILITY_PLUGIN,
11
11
  name: 'Telemetry',
12
12
  } satisfies PluginMeta;
13
-
14
- const OBSERVABILITY_ACTION = 'dxos.org/plugin/observability';
15
- export enum ObservabilityAction {
16
- TOGGLE = `${OBSERVABILITY_ACTION}/toggle`,
17
- SEND_EVENT = `${OBSERVABILITY_ACTION}/send-event`,
18
- CAPTURE_USER_FEEDBACK = `${OBSERVABILITY_ACTION}/capture-feedback`,
19
- }
20
-
21
- export type UserFeedback = {
22
- name: string;
23
- email: string;
24
- message: string;
25
- };
package/src/types.ts ADDED
@@ -0,0 +1,54 @@
1
+ //
2
+ // Copyright 2024 DXOS.org
3
+ //
4
+
5
+ import { S } from '@dxos/echo-schema';
6
+
7
+ import { OBSERVABILITY_PLUGIN } from './meta';
8
+
9
+ const Email = S.String.pipe(
10
+ S.nonEmptyString({ message: () => 'Email is required.' }),
11
+ S.pattern(/^(?!\.)(?!.*\.\.)([A-Z0-9_+-.]*)[A-Z0-9_+-]@([A-Z0-9][A-Z0-9-]*\.)+[A-Z]{2,}$/i, {
12
+ message: () => 'Invalid email address.',
13
+ }),
14
+ );
15
+
16
+ const nonEmpty = (field: string) => S.nonEmptyString({ message: () => `${field} is required.` });
17
+ const maxLength = (field: string, length: number) => S.maxLength(length, { message: () => `${field} is too long.` });
18
+
19
+ export const UserFeedback = S.Struct({
20
+ name: S.String.pipe(nonEmpty('Name'), maxLength('Name', 256)),
21
+ email: Email.pipe(maxLength('Email', 256)),
22
+ message: S.String.pipe(nonEmpty('Feedback'), maxLength('Feedback', 32_768)),
23
+ });
24
+
25
+ export type UserFeedback = S.Schema.Type<typeof UserFeedback>;
26
+
27
+ const OBSERVABILITY_ACTION = `${OBSERVABILITY_PLUGIN}/action`;
28
+ export namespace ObservabilityAction {
29
+ export class Toggle extends S.TaggedClass<Toggle>()(`${OBSERVABILITY_ACTION}/toggle`, {
30
+ input: S.Struct({
31
+ state: S.optional(S.Boolean),
32
+ }),
33
+ output: S.Boolean,
34
+ }) {}
35
+
36
+ export class SendEvent extends S.TaggedClass<SendEvent>()(`${OBSERVABILITY_ACTION}/send-event`, {
37
+ input: S.Struct({
38
+ name: S.String,
39
+ properties: S.optional(S.Object),
40
+ installationId: S.optional(S.String),
41
+ identityId: S.optional(S.String),
42
+ timestamp: S.optional(S.Date),
43
+ }),
44
+ output: S.Void,
45
+ }) {}
46
+
47
+ export class CaptureUserFeedback extends S.TaggedClass<CaptureUserFeedback>()(
48
+ `${OBSERVABILITY_ACTION}/capture-feedback`,
49
+ {
50
+ input: UserFeedback,
51
+ output: S.Void,
52
+ },
53
+ ) {}
54
+ }
@@ -1,20 +0,0 @@
1
- // packages/plugins/plugin-observability/src/meta.ts
2
- var OBSERVABILITY_PLUGIN = "dxos.org/plugin/observability";
3
- var meta_default = {
4
- id: OBSERVABILITY_PLUGIN,
5
- name: "Telemetry"
6
- };
7
- var OBSERVABILITY_ACTION = "dxos.org/plugin/observability";
8
- var ObservabilityAction;
9
- (function(ObservabilityAction2) {
10
- ObservabilityAction2[ObservabilityAction2["TOGGLE"] = `${OBSERVABILITY_ACTION}/toggle`] = "TOGGLE";
11
- ObservabilityAction2[ObservabilityAction2["SEND_EVENT"] = `${OBSERVABILITY_ACTION}/send-event`] = "SEND_EVENT";
12
- ObservabilityAction2[ObservabilityAction2["CAPTURE_USER_FEEDBACK"] = `${OBSERVABILITY_ACTION}/capture-feedback`] = "CAPTURE_USER_FEEDBACK";
13
- })(ObservabilityAction || (ObservabilityAction = {}));
14
-
15
- export {
16
- OBSERVABILITY_PLUGIN,
17
- meta_default,
18
- ObservabilityAction
19
- };
20
- //# sourceMappingURL=chunk-FO5EMZZO.mjs.map
@@ -1,7 +0,0 @@
1
- {
2
- "version": 3,
3
- "sources": ["../../../src/meta.ts"],
4
- "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\nconst OBSERVABILITY_ACTION = 'dxos.org/plugin/observability';\nexport enum ObservabilityAction {\n TOGGLE = `${OBSERVABILITY_ACTION}/toggle`,\n SEND_EVENT = `${OBSERVABILITY_ACTION}/send-event`,\n CAPTURE_USER_FEEDBACK = `${OBSERVABILITY_ACTION}/capture-feedback`,\n}\n\nexport type UserFeedback = {\n name: string;\n email: string;\n message: string;\n};\n"],
5
- "mappings": ";AAMO,IAAMA,uBAAuB;AAEpC,IAAA,eAAe;EACbC,IAAID;EACJE,MAAM;AACR;AAEA,IAAMC,uBAAuB;;UACjBC,sBAAAA;wDACD,GAAGD,oBAAAA,SAA6B,IAAA;4DAC5B,GAAGA,oBAAAA,aAAiC,IAAA;uEACzB,GAAGA,oBAAAA,mBAAuC,IAAA;GAHxDC,wBAAAA,sBAAAA,CAAAA,EAAAA;",
6
- "names": ["OBSERVABILITY_PLUGIN", "id", "name", "OBSERVABILITY_ACTION", "ObservabilityAction"]
7
- }
@@ -1,11 +0,0 @@
1
- import {
2
- OBSERVABILITY_PLUGIN,
3
- ObservabilityAction,
4
- meta_default
5
- } from "./chunk-FO5EMZZO.mjs";
6
- export {
7
- OBSERVABILITY_PLUGIN,
8
- ObservabilityAction,
9
- meta_default as default
10
- };
11
- //# sourceMappingURL=meta.mjs.map
@@ -1,44 +0,0 @@
1
- "use strict";
2
- var __defProp = Object.defineProperty;
3
- var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
4
- var __getOwnPropNames = Object.getOwnPropertyNames;
5
- var __hasOwnProp = Object.prototype.hasOwnProperty;
6
- var __export = (target, all) => {
7
- for (var name in all)
8
- __defProp(target, name, { get: all[name], enumerable: true });
9
- };
10
- var __copyProps = (to, from, except, desc) => {
11
- if (from && typeof from === "object" || typeof from === "function") {
12
- for (let key of __getOwnPropNames(from))
13
- if (!__hasOwnProp.call(to, key) && key !== except)
14
- __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
15
- }
16
- return to;
17
- };
18
- var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
19
- var chunk_RAB7T73W_exports = {};
20
- __export(chunk_RAB7T73W_exports, {
21
- OBSERVABILITY_PLUGIN: () => OBSERVABILITY_PLUGIN,
22
- ObservabilityAction: () => ObservabilityAction,
23
- meta_default: () => meta_default
24
- });
25
- module.exports = __toCommonJS(chunk_RAB7T73W_exports);
26
- var OBSERVABILITY_PLUGIN = "dxos.org/plugin/observability";
27
- var meta_default = {
28
- id: OBSERVABILITY_PLUGIN,
29
- name: "Telemetry"
30
- };
31
- var OBSERVABILITY_ACTION = "dxos.org/plugin/observability";
32
- var ObservabilityAction;
33
- (function(ObservabilityAction2) {
34
- ObservabilityAction2[ObservabilityAction2["TOGGLE"] = `${OBSERVABILITY_ACTION}/toggle`] = "TOGGLE";
35
- ObservabilityAction2[ObservabilityAction2["SEND_EVENT"] = `${OBSERVABILITY_ACTION}/send-event`] = "SEND_EVENT";
36
- ObservabilityAction2[ObservabilityAction2["CAPTURE_USER_FEEDBACK"] = `${OBSERVABILITY_ACTION}/capture-feedback`] = "CAPTURE_USER_FEEDBACK";
37
- })(ObservabilityAction || (ObservabilityAction = {}));
38
- // Annotate the CommonJS export names for ESM import in node:
39
- 0 && (module.exports = {
40
- OBSERVABILITY_PLUGIN,
41
- ObservabilityAction,
42
- meta_default
43
- });
44
- //# sourceMappingURL=chunk-RAB7T73W.cjs.map
@@ -1,7 +0,0 @@
1
- {
2
- "version": 3,
3
- "sources": ["../../../src/meta.ts"],
4
- "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\nconst OBSERVABILITY_ACTION = 'dxos.org/plugin/observability';\nexport enum ObservabilityAction {\n TOGGLE = `${OBSERVABILITY_ACTION}/toggle`,\n SEND_EVENT = `${OBSERVABILITY_ACTION}/send-event`,\n CAPTURE_USER_FEEDBACK = `${OBSERVABILITY_ACTION}/capture-feedback`,\n}\n\nexport type UserFeedback = {\n name: string;\n email: string;\n message: string;\n};\n"],
5
- "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;AAMO,IAAMA,uBAAuB;AAEpC,IAAA,eAAe;EACbC,IAAID;EACJE,MAAM;AACR;AAEA,IAAMC,uBAAuB;;UACjBC,sBAAAA;wDACD,GAAGD,oBAAAA,SAA6B,IAAA;4DAC5B,GAAGA,oBAAAA,aAAiC,IAAA;uEACzB,GAAGA,oBAAAA,mBAAuC,IAAA;GAHxDC,wBAAAA,sBAAAA,CAAAA,EAAAA;",
6
- "names": ["OBSERVABILITY_PLUGIN", "id", "name", "OBSERVABILITY_ACTION", "ObservabilityAction"]
7
- }
@@ -1,7 +0,0 @@
1
- {
2
- "version": 3,
3
- "sources": ["meta.cjs"],
4
- "sourcesContent": ["import {\n OBSERVABILITY_PLUGIN,\n ObservabilityAction,\n meta_default\n} from \"./chunk-RAB7T73W.cjs\";\nexport {\n OBSERVABILITY_PLUGIN,\n ObservabilityAction,\n meta_default as default\n};\n//# sourceMappingURL=meta.cjs.map\n"],
5
- "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,4BAIO;",
6
- "names": []
7
- }
@@ -1,22 +0,0 @@
1
- import { createRequire } from 'node:module';const require = createRequire(import.meta.url);
2
-
3
- // packages/plugins/plugin-observability/src/meta.ts
4
- var OBSERVABILITY_PLUGIN = "dxos.org/plugin/observability";
5
- var meta_default = {
6
- id: OBSERVABILITY_PLUGIN,
7
- name: "Telemetry"
8
- };
9
- var OBSERVABILITY_ACTION = "dxos.org/plugin/observability";
10
- var ObservabilityAction;
11
- (function(ObservabilityAction2) {
12
- ObservabilityAction2[ObservabilityAction2["TOGGLE"] = `${OBSERVABILITY_ACTION}/toggle`] = "TOGGLE";
13
- ObservabilityAction2[ObservabilityAction2["SEND_EVENT"] = `${OBSERVABILITY_ACTION}/send-event`] = "SEND_EVENT";
14
- ObservabilityAction2[ObservabilityAction2["CAPTURE_USER_FEEDBACK"] = `${OBSERVABILITY_ACTION}/capture-feedback`] = "CAPTURE_USER_FEEDBACK";
15
- })(ObservabilityAction || (ObservabilityAction = {}));
16
-
17
- export {
18
- OBSERVABILITY_PLUGIN,
19
- meta_default,
20
- ObservabilityAction
21
- };
22
- //# sourceMappingURL=chunk-UVEE3XZO.mjs.map
@@ -1,7 +0,0 @@
1
- {
2
- "version": 3,
3
- "sources": ["../../../src/meta.ts"],
4
- "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\nconst OBSERVABILITY_ACTION = 'dxos.org/plugin/observability';\nexport enum ObservabilityAction {\n TOGGLE = `${OBSERVABILITY_ACTION}/toggle`,\n SEND_EVENT = `${OBSERVABILITY_ACTION}/send-event`,\n CAPTURE_USER_FEEDBACK = `${OBSERVABILITY_ACTION}/capture-feedback`,\n}\n\nexport type UserFeedback = {\n name: string;\n email: string;\n message: string;\n};\n"],
5
- "mappings": ";;;AAMO,IAAMA,uBAAuB;AAEpC,IAAA,eAAe;EACbC,IAAID;EACJE,MAAM;AACR;AAEA,IAAMC,uBAAuB;;UACjBC,sBAAAA;wDACD,GAAGD,oBAAAA,SAA6B,IAAA;4DAC5B,GAAGA,oBAAAA,aAAiC,IAAA;uEACzB,GAAGA,oBAAAA,mBAAuC,IAAA;GAHxDC,wBAAAA,sBAAAA,CAAAA,EAAAA;",
6
- "names": ["OBSERVABILITY_PLUGIN", "id", "name", "OBSERVABILITY_ACTION", "ObservabilityAction"]
7
- }
@@ -1,221 +0,0 @@
1
- //
2
- // Copyright 2023 DXOS.org
3
- //
4
-
5
- import React from 'react';
6
-
7
- import {
8
- type Plugin,
9
- type PluginDefinition,
10
- type IntentResolverProvides,
11
- type SettingsProvides,
12
- type SurfaceProvides,
13
- type TranslationsProvides,
14
- resolvePlugin,
15
- parseIntentPlugin,
16
- LayoutAction,
17
- SettingsAction,
18
- parsePluginHost,
19
- } from '@dxos/app-framework';
20
- import { EventSubscriptions } from '@dxos/async';
21
- import { create } from '@dxos/live-object';
22
- import { LocalStorageStore } from '@dxos/local-storage';
23
- import {
24
- type Observability,
25
- getTelemetryIdentifier,
26
- setupTelemetryListeners,
27
- isObservabilityDisabled,
28
- storeObservabilityDisabled,
29
- getObservabilityGroup,
30
- } from '@dxos/observability';
31
- import type { EventOptions } from '@dxos/observability/segment';
32
- import { parseClientPlugin } from '@dxos/plugin-client';
33
-
34
- import { ObservabilitySettings, type ObservabilitySettingsProps } from './components';
35
- import meta, { OBSERVABILITY_PLUGIN, ObservabilityAction, type UserFeedback } from './meta';
36
- import translations from './translations';
37
-
38
- export type ObservabilityPluginState = {
39
- group?: string;
40
- notified?: boolean;
41
- };
42
-
43
- export type ObservabilityPluginProvides = IntentResolverProvides &
44
- SurfaceProvides &
45
- SettingsProvides<ObservabilitySettingsProps> &
46
- TranslationsProvides & {
47
- observability: ObservabilityPluginState;
48
- };
49
-
50
- export const parseObservabilityPlugin = (plugin?: Plugin) =>
51
- (plugin?.provides as any).observability ? (plugin as Plugin<ObservabilityPluginProvides>) : undefined;
52
-
53
- export const ObservabilityPlugin = (options: {
54
- namespace: string;
55
- observability: () => Promise<Observability>;
56
- }): PluginDefinition<ObservabilityPluginProvides> => {
57
- const settings = create<ObservabilitySettingsProps>({});
58
- const state = new LocalStorageStore<ObservabilityPluginState>(OBSERVABILITY_PLUGIN);
59
- const subscriptions = new EventSubscriptions();
60
- let observability: Observability | undefined;
61
-
62
- return {
63
- meta,
64
- initialize: async () => {
65
- settings.enabled = !(await isObservabilityDisabled(options.namespace));
66
- state.values.group = await getObservabilityGroup(options.namespace);
67
- state.prop({ key: 'notified', type: LocalStorageStore.bool({ allowUndefined: true }) });
68
- },
69
- ready: async (plugins) => {
70
- const pluginHost = resolvePlugin(plugins, parsePluginHost);
71
- const clientPlugin = resolvePlugin(plugins, parseClientPlugin);
72
- const intentPlugin = resolvePlugin(plugins, parseIntentPlugin);
73
-
74
- const dispatch = intentPlugin?.provides?.intent?.dispatch;
75
- if (!dispatch) {
76
- return;
77
- }
78
-
79
- const sendPrivacyNotice = async () => {
80
- const environment = clientPlugin?.provides?.client?.config?.values.runtime?.app?.env?.DX_ENVIRONMENT;
81
- const notify =
82
- environment && environment !== 'ci' && !environment.endsWith('.local') && !environment.endsWith('.lan');
83
- if (!state.values.notified && notify) {
84
- await dispatch({
85
- action: LayoutAction.SET_LAYOUT,
86
- data: {
87
- element: 'toast',
88
- subject: {
89
- id: `${OBSERVABILITY_PLUGIN}/notice`,
90
- // TODO(wittjosiah): Non-react translation utils.
91
- title: translations[0]['en-US'][OBSERVABILITY_PLUGIN]['observability toast label'],
92
- description: translations[0]['en-US'][OBSERVABILITY_PLUGIN]['observability toast description'],
93
- duration: Infinity,
94
- icon: 'ph--info--regular',
95
- actionLabel: translations[0]['en-US'][OBSERVABILITY_PLUGIN]['observability toast action label'],
96
- actionAlt: translations[0]['en-US'][OBSERVABILITY_PLUGIN]['observability toast action alt'],
97
- closeLabel: translations[0]['en-US'][OBSERVABILITY_PLUGIN]['observability toast close label'],
98
- onAction: () => dispatch({ action: SettingsAction.OPEN, data: { plugin: OBSERVABILITY_PLUGIN } }),
99
- },
100
- },
101
- });
102
-
103
- state.values.notified = true;
104
- }
105
- };
106
-
107
- // Initialize asynchronously in the background, not in plugin initialization.
108
- // Should not block application startup.
109
- void options.observability().then(async (obs) => {
110
- observability = obs;
111
-
112
- // Ensure errors are tagged with enabled plugins to help with reproductions.
113
- pluginHost?.provides?.plugins?.enabled?.map((plugin) =>
114
- observability?.setTag(`pluginEnabled-${plugin}`, 'true', 'errors'),
115
- );
116
-
117
- // Start client observability (i.e. not running as shared worker)
118
- // TODO(nf): how to prevent multiple instances for single shared worker?
119
- const client = clientPlugin?.provides?.client;
120
- if (!client) {
121
- return;
122
- }
123
-
124
- await dispatch({
125
- action: ObservabilityAction.SEND_EVENT,
126
- data: {
127
- name: 'page.load',
128
- properties: {
129
- href: window.location.href,
130
- // TODO(wittjosiah): These apis are deprecated. Is there a better way to find this information?
131
- loadDuration: window.performance.timing.loadEventEnd - window.performance.timing.loadEventStart,
132
- },
133
- },
134
- });
135
-
136
- setupTelemetryListeners(options.namespace, client, observability);
137
-
138
- await Promise.all([
139
- observability.setIdentityTags(client.services.services),
140
- observability.startRuntimeMetrics(client),
141
- observability.startNetworkMetrics(client.services.services),
142
- observability.startSpacesMetrics(client, options.namespace),
143
- ]);
144
-
145
- if (client.halo.identity.get()) {
146
- await sendPrivacyNotice();
147
- } else {
148
- const subscription = client.halo.identity.subscribe(async (identity) => {
149
- if (identity && observability) {
150
- await sendPrivacyNotice();
151
- await observability.setIdentityTags(client.services.services);
152
- subscription.unsubscribe();
153
- }
154
- });
155
- }
156
- });
157
- },
158
- unload: async () => {
159
- subscriptions.clear();
160
- await observability?.close();
161
- },
162
- provides: {
163
- intent: {
164
- resolver: async (intent, plugins) => {
165
- const client = resolvePlugin(plugins, parseClientPlugin)?.provides?.client;
166
- if (!client || !observability) {
167
- return;
168
- }
169
-
170
- switch (intent.action) {
171
- case ObservabilityAction.TOGGLE:
172
- settings.enabled = !settings.enabled;
173
- observability.event({
174
- identityId: getTelemetryIdentifier(client),
175
- name: `${options.namespace}.observability.toggle`,
176
- properties: {
177
- enabled: settings.enabled,
178
- },
179
- });
180
- observability.setMode(settings.enabled ? 'basic' : 'disabled');
181
- await storeObservabilityDisabled(options.namespace, !settings.enabled);
182
- return { data: settings.enabled };
183
-
184
- case ObservabilityAction.SEND_EVENT: {
185
- const data = intent.data as EventOptions;
186
- const event = {
187
- identityId: getTelemetryIdentifier(client),
188
- name: `${options.namespace}.${data.name}`,
189
- properties: {
190
- ...data.properties,
191
- },
192
- };
193
- observability.event(event);
194
- return { data: event };
195
- }
196
-
197
- case ObservabilityAction.CAPTURE_USER_FEEDBACK: {
198
- const feedback = intent.data as UserFeedback;
199
-
200
- observability.captureUserFeedback(feedback.email, feedback.name, feedback.message);
201
- return { data: true };
202
- }
203
- }
204
- },
205
- },
206
- observability: state.values,
207
- settings,
208
- surface: {
209
- component: ({ role, data }) => {
210
- switch (role) {
211
- case 'settings':
212
- return data.plugin === meta.id ? <ObservabilitySettings settings={settings} /> : null;
213
- }
214
-
215
- return null;
216
- },
217
- },
218
- translations,
219
- },
220
- };
221
- };