@dxos/tracing 0.5.3-main.6f2dfea → 0.5.3-main.77c09ab

package/dist/types/src/api.d.ts

@@ -1,3 +1,4 @@
+import { type MaybePromise } from '@dxos/util';
 export type InfoOptions = {
     /**
      * Value is of enum type and should be converted to string.
@@ -23,16 +24,36 @@ export type SpanOptions = {
     showInBrowserTimeline?: boolean;
 };
 export type AddLinkOptions = {};
+export type TraceDiagnosticParams<T> = {
+    /**
+     * Unique ID.
+     */
+    id: string;
+    /**
+     * Human-readable name.
+     * @defaults Defaults to `id`
+     */
+    name?: string;
+    /**
+     * Function that will be called to fetch the diagnostic data.
+     */
+    fetch: () => MaybePromise<T>;
+};
+export interface TraceDiagnostic {
+    id: string;
+    unregister(): void;
+}
 export declare const trace: {
+    addLink: (parent: any, child: any, opts?: AddLinkOptions) => void;
+    diagnostic: <T>(params: TraceDiagnosticParams<T>) => TraceDiagnostic;
+    info: (opts?: InfoOptions) => (target: any, propertyKey: string, descriptor?: PropertyDescriptor) => void;
+    mark: (name: string) => void;
+    metricsCounter: () => (target: any, propertyKey: string, descriptor?: PropertyDescriptor) => void;
     resource: (options?: {
         annotation?: symbol;
-    }) => <T extends new (...args: any[]) => {}>(constructor: T) => {
+    }) => <T_1 extends new (...args: any[]) => {}>(constructor: T_1) => {
         new (...rest: any[]): {};
-    } & T;
-    info: (opts?: InfoOptions) => (target: any, propertyKey: string, descriptor?: PropertyDescriptor) => void;
-    mark: (name: string) => void;
+    } & T_1;
     span: ({ showInBrowserTimeline }?: SpanOptions) => (target: any, propertyKey: string, descriptor: TypedPropertyDescriptor<(...args: any) => any>) => void;
-    metricsCounter: () => (target: any, propertyKey: string, descriptor?: PropertyDescriptor) => void;
-    addLink: (parent: any, child: any, opts?: AddLinkOptions) => void;
 };
 //# sourceMappingURL=api.d.ts.map

package/dist/types/src/api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../../src/api.ts"],"names":[],"mappings":"AA2BA,MAAM,MAAM,WAAW,GAAG;IACxB;;;;;;;;;OASG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE3B;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB,CAAC;AAeF,MAAM,MAAM,WAAW,GAAG;IACxB,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACjC,CAAC;AAmCF,MAAM,MAAM,cAAc,GAAG,EAAE,CAAC;AAMhC,eAAO,MAAM,KAAK;yBA7FL;QAAE,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,8BACP,GAAG,EAAE,KAAG,EAAE;sBAIV,GAAG,EAAE;;kBAoCzB,WAAW,cACT,GAAG,eAAe,MAAM,eAAe,kBAAkB;iBAIhD,MAAM;uCASY,WAAW,cACtC,GAAG,eAAe,MAAM,gDAAgD,GAAG,KAAK,GAAG;mCA2BxD,GAAG,eAAe,MAAM,eAAe,kBAAkB;sBAMtE,GAAG,SAAS,GAAG,SAAQ,cAAc;CAY7D,CAAC"}
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../../src/api.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,YAAY,CAAC;AAuB/C,MAAM,MAAM,WAAW,GAAG;IACxB;;;;;;;;;OASG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE3B;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB,CAAC;AAeF,MAAM,MAAM,WAAW,GAAG;IACxB,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACjC,CAAC;AAmCF,MAAM,MAAM,cAAc,GAAG,EAAE,CAAC;AAMhC,MAAM,MAAM,qBAAqB,CAAC,CAAC,IAAI;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,EAAE,MAAM,YAAY,CAAC,CAAC,CAAC,CAAC;CAC9B,CAAC;AAEF,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,IAAI,IAAI,CAAC;CACpB;AASD,eAAO,MAAM,KAAK;sBAlCO,GAAG,SAAS,GAAG,SAAQ,cAAc;4BA8B/B,sBAAsB,CAAC,CAAC,KAAG,eAAe;kBA9EhE,WAAW,cACT,GAAG,eAAe,MAAM,eAAe,kBAAkB;iBAIhD,MAAM;mCAqCY,GAAG,eAAe,MAAM,eAAe,kBAAkB;yBAnFlF;QAAE,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,gCACP,GAAG,EAAE,KAAG,EAAE;sBAIV,GAAG,EAAE;;uCAkDI,WAAW,cACtC,GAAG,eAAe,MAAM,cAAc,wBAAwB,CAAC,GAAG,IAAI,EAAE,GAAG,KAAK,GAAG,CAAC;CA2E9F,CAAC"}

package/dist/types/src/diagnostic.d.ts

@@ -0,0 +1,36 @@
+import { type TraceDiagnosticParams, type TraceDiagnostic } from './api';
+export declare const DIAGNOSTICS_TIMEOUT = 10000;
+export type DiagnosticMetadata = {
+    id: string;
+    instanceId: string;
+    instanceTag: string | null;
+    name: string;
+};
+export type DiagnosticsRequest = {
+    id: string;
+    instanceId: string;
+};
+export type DiagnosticsData = {
+    id: string;
+    instanceId: string;
+    data: any;
+    error?: string;
+};
+export declare class TraceDiagnosticImpl implements TraceDiagnostic {
+    id: string;
+    fetch: () => any;
+    name: string;
+    private readonly _onUnregister;
+    constructor(id: string, fetch: () => any, name: string, _onUnregister: () => void);
+    unregister(): void;
+}
+export declare class DiagnosticsManager {
+    readonly instanceId: string;
+    readonly registry: Map<string, TraceDiagnosticImpl>;
+    private _instanceTag;
+    setInstanceTag(tag: string): void;
+    registerDiagnostic(params: TraceDiagnosticParams<any>): TraceDiagnostic;
+    list(): DiagnosticMetadata[];
+    fetch(request: DiagnosticsRequest): Promise<DiagnosticsData>;
+}
+//# sourceMappingURL=diagnostic.d.ts.map

package/dist/types/src/diagnostic.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"diagnostic.d.ts","sourceRoot":"","sources":["../../../src/diagnostic.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,KAAK,qBAAqB,EAAE,KAAK,eAAe,EAAE,MAAM,OAAO,CAAC;AAGzE,eAAO,MAAM,mBAAmB,QAAS,CAAC;AAE1C,MAAM,MAAM,kBAAkB,GAAG;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,GAAG,CAAC;IACV,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,qBAAa,mBAAoB,YAAW,eAAe;IAEhD,EAAE,EAAE,MAAM;IACV,KAAK,EAAE,MAAM,GAAG;IAChB,IAAI,EAAE,MAAM;IACnB,OAAO,CAAC,QAAQ,CAAC,aAAa;gBAHvB,EAAE,EAAE,MAAM,EACV,KAAK,EAAE,MAAM,GAAG,EAChB,IAAI,EAAE,MAAM,EACF,aAAa,EAAE,MAAM,IAAI;IAG5C,UAAU,IAAI,IAAI;CAGnB;AAED,qBAAa,kBAAkB;IAC7B,QAAQ,CAAC,UAAU,SAAc;IAEjC,QAAQ,CAAC,QAAQ,mCAA0C;IAE3D,OAAO,CAAC,YAAY,CAAuB;IAE3C,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAIjC,kBAAkB,CAAC,MAAM,EAAE,qBAAqB,CAAC,GAAG,CAAC,GAAG,eAAe;IAUvE,IAAI,IAAI,kBAAkB,EAAE;IAStB,KAAK,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,eAAe,CAAC;CAqBnE"}

package/dist/types/src/diagnostics-channel.d.ts

@@ -0,0 +1,33 @@
+import { type DiagnosticMetadata, type DiagnosticsData, type DiagnosticsManager, type DiagnosticsRequest } from './diagnostic';
+export type DiagnosticChannelMessage = {
+    type: 'DIAGNOSTICS_DISCOVER';
+} | {
+    type: 'DIAGNOSTICS_ANNOUNCE';
+    diagnostics: DiagnosticMetadata[];
+} | {
+    type: 'DIAGNOSTICS_FETCH';
+    requestId: string;
+    request: DiagnosticsRequest;
+} | {
+    type: 'DIAGNOSTICS_RESPONSE';
+    requestId: string;
+    data: DiagnosticsData;
+};
+export declare class DiagnosticsChannel {
+    private readonly _channelName;
+    private _ctx;
+    private readonly _serveChannel;
+    private readonly _clientChannel;
+    constructor(_channelName?: string);
+    destroy(): void;
+    /**
+     * In node.js, the channel will keep the process alive.
+     * This method allows the process to exit.
+     * Noop in the browser.
+     */
+    unref(): void;
+    serve(manager: DiagnosticsManager): void;
+    discover(): Promise<DiagnosticMetadata[]>;
+    fetch(request: DiagnosticsRequest): Promise<DiagnosticsData>;
+}
+//# sourceMappingURL=diagnostics-channel.d.ts.map

package/dist/types/src/diagnostics-channel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"diagnostics-channel.d.ts","sourceRoot":"","sources":["../../../src/diagnostics-channel.ts"],"names":[],"mappings":"AAOA,OAAO,EAEL,KAAK,kBAAkB,EACvB,KAAK,eAAe,EACpB,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACxB,MAAM,cAAc,CAAC;AAOtB,MAAM,MAAM,wBAAwB,GAChC;IACE,IAAI,EAAE,sBAAsB,CAAC;CAC9B,GACD;IACE,IAAI,EAAE,sBAAsB,CAAC;IAC7B,WAAW,EAAE,kBAAkB,EAAE,CAAC;CACnC,GACD;IACE,IAAI,EAAE,mBAAmB,CAAC;IAC1B,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,kBAAkB,CAAC;CAC7B,GACD;IACE,IAAI,EAAE,sBAAsB,CAAC;IAC7B,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,eAAe,CAAC;CACvB,CAAC;AAEN,qBAAa,kBAAkB;IAOjB,OAAO,CAAC,QAAQ,CAAC,YAAY;IANzC,OAAO,CAAC,IAAI,CAAiB;IAG7B,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAmB;IACjD,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAmB;gBAErB,YAAY,GAAE,MAA6B;IAKxE,OAAO;IAMP;;;;OAIG;IACH,KAAK;IAOL,KAAK,CAAC,OAAO,EAAE,kBAAkB;IAgC3B,QAAQ,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC;IAgCzC,KAAK,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,eAAe,CAAC;CA2BnE"}

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

@@ -3,4 +3,5 @@ export * from './symbols';
 export * from './trace-processor';
 export * from './trace-sender';
 export * from './metrics';
+export * from './diagnostic';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAIA,cAAc,OAAO,CAAC;AACtB,cAAc,WAAW,CAAC;AAC1B,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,WAAW,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAMA,cAAc,OAAO,CAAC;AACtB,cAAc,WAAW,CAAC;AAC1B,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC"}

package/dist/types/src/trace-processor.d.ts

@@ -3,6 +3,8 @@ import { type LogEntry } from '@dxos/protocols/proto/dxos/client/services';
 import { type Error as SerializedError } from '@dxos/protocols/proto/dxos/error';
 import { type Metric, type Resource, type Span } from '@dxos/protocols/proto/dxos/tracing';
 import type { AddLinkOptions } from './api';
+import { DiagnosticsManager } from './diagnostic';
+import { DiagnosticsChannel } from './diagnostics-channel';
 import { TraceSender } from './trace-sender';
 export type Diagnostics = {
     resources: Record<string, Resource>;
@@ -42,6 +44,8 @@ export type TraceSubscription = {
     newLogs: LogEntry[];
 };
 export declare class TraceProcessor {
+    readonly diagnostics: DiagnosticsManager;
+    readonly diagnosticsChannel: DiagnosticsChannel;
     readonly subscriptions: Set<TraceSubscription>;
     readonly resources: Map<number, ResourceEntry>;
     readonly resourceInstanceIndex: WeakMap<any, ResourceEntry>;
@@ -49,7 +53,9 @@ export declare class TraceProcessor {
     readonly spans: Map<number, Span>;
     readonly spanIdList: number[];
     readonly logs: LogEntry[];
+    private _instanceTag;
     constructor();
+    setInstanceTag(tag: string): void;
     createTraceSender(): TraceSender;
     traceSpan(params: TraceSpanParams): TracingSpan;
     addLink(parent: any, child: any, opts: AddLinkOptions): void;

package/dist/types/src/trace-processor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"trace-processor.d.ts","sourceRoot":"","sources":["../../../src/trace-processor.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,eAAe,CAAC;AAE7C,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,4CAA4C,CAAC;AAC3E,OAAO,EAAE,KAAK,KAAK,IAAI,eAAe,EAAE,MAAM,kCAAkC,CAAC;AACjF,OAAO,EAAE,KAAK,MAAM,EAAE,KAAK,QAAQ,EAAE,KAAK,IAAI,EAAE,MAAM,oCAAoC,CAAC;AAG3F,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AAG5C,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,MAAM,WAAW,GAAG;IACxB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACpC,KAAK,EAAE,IAAI,EAAE,CAAC;IACd,IAAI,EAAE,QAAQ,EAAE,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG;IAC3C,WAAW,EAAE;QAAE,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,CAAA;KAAE,CAAC;IAC1C,QAAQ,EAAE,GAAG,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,QAAQ,EAAE,GAAG,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,OAAO,GAAG,IAAI,CAAC;IAC1B,qBAAqB,EAAE,OAAO,CAAC;CAChC,CAAC;AAEF,qBAAa,aAAa;aASN,IAAI,EAAE,QAAQ;aACd,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC;aACtB,UAAU,CAAC;IAV7B;;;;OAIG;IACH,SAAgB,kBAAkB,EAAE,MAAM,CAAC;gBAGzB,IAAI,EAAE,QAAQ,EACd,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,EACtB,UAAU,CAAC,oBAAQ;IAKrC,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;CAG5C;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,KAAK,EAAE,MAAM,IAAI,CAAC;IAElB,cAAc,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC5B,UAAU,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IACxB,OAAO,EAAE,QAAQ,EAAE,CAAC;CACrB,CAAC;AAUF,qBAAa,cAAc;IACzB,QAAQ,CAAC,aAAa,EAAE,GAAG,CAAC,iBAAiB,CAAC,CAAa;IAE3D,QAAQ,CAAC,SAAS,6BAAoC;IACtD,QAAQ,CAAC,qBAAqB,8BAAqC;IACnE,QAAQ,CAAC,cAAc,EAAE,MAAM,EAAE,CAAM;IAEvC,QAAQ,CAAC,KAAK,oBAA2B;IACzC,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,CAAM;IAEnC,QAAQ,CAAC,IAAI,EAAE,QAAQ,EAAE,CAAM;;IA6C/B,iBAAiB;IAIjB,SAAS,CAAC,MAAM,EAAE,eAAe,GAAG,WAAW;IAO/C,OAAO,CAAC,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,cAAc;IAQrD,cAAc,IAAI,WAAW;IAe7B,eAAe,CAAC,QAAQ,EAAE,GAAG,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAuBnD,kBAAkB,CAAC,QAAQ,EAAE,GAAG,GAAG,MAAM,EAAE;IAU3C,aAAa,CAAC,QAAQ,EAAE,GAAG,GAAG,MAAM,GAAG,IAAI;IAK3C,wBAAwB,CAAC,SAAS,EAAE,MAAM,GAAG,aAAa,EAAE;IAM5D,yBAAyB,CAAC,UAAU,EAAE,MAAM,GAAG,aAAa,EAAE;IAI9D,OAAO;IAmDP,OAAO,CAAC,kBAAkB;IAM1B,OAAO,CAAC,cAAc;IAMtB,OAAO,CAAC,eAAe;IAQvB,OAAO,CAAC,WAAW;IAOnB,OAAO,CAAC,QAAQ;IAWhB,OAAO,CAAC,aAAa,CAgCnB;CACH;AAGD,qBAAa,WAAW;IAepB,OAAO,CAAC,eAAe;IAdzB,MAAM,CAAC,MAAM,SAAK;IAElB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAQ;IACxC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAQ;IAC1C,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAQ;IAC5B,KAAK,EAAE,eAAe,GAAG,IAAI,CAAQ;IAErC,OAAO,CAAC,sBAAsB,CAAU;IACxC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAwB;gBAGnC,eAAe,EAAE,cAAc,EACvC,MAAM,EAAE,eAAe;IAqBzB,IAAI,GAAG,IAAI,OAAO,GAAG,IAAI,CAExB;IAED,WAAW;IASX,SAAS,CAAC,GAAG,EAAE,OAAO;IAUtB,SAAS,IAAI,IAAI;IAYjB,OAAO,CAAC,sBAAsB;CAO/B;AAiBD,eAAO,MAAM,eAAe,EAAE,cAA+E,CAAC;AAsE9G,eAAO,MAAM,iBAAiB,cAAe,MAAM,WAQlD,CAAC"}
+{"version":3,"file":"trace-processor.d.ts","sourceRoot":"","sources":["../../../src/trace-processor.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,eAAe,CAAC;AAE7C,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,4CAA4C,CAAC;AAC3E,OAAO,EAAE,KAAK,KAAK,IAAI,eAAe,EAAE,MAAM,kCAAkC,CAAC;AACjF,OAAO,EAAE,KAAK,MAAM,EAAE,KAAK,QAAQ,EAAE,KAAK,IAAI,EAAE,MAAM,oCAAoC,CAAC;AAG3F,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AAC5C,OAAO,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAClD,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,MAAM,WAAW,GAAG;IACxB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACpC,KAAK,EAAE,IAAI,EAAE,CAAC;IACd,IAAI,EAAE,QAAQ,EAAE,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG;IAC3C,WAAW,EAAE;QAAE,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,CAAA;KAAE,CAAC;IAC1C,QAAQ,EAAE,GAAG,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,QAAQ,EAAE,GAAG,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,OAAO,GAAG,IAAI,CAAC;IAC1B,qBAAqB,EAAE,OAAO,CAAC;CAChC,CAAC;AAEF,qBAAa,aAAa;aASN,IAAI,EAAE,QAAQ;aACd,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC;aACtB,UAAU,CAAC;IAV7B;;;;OAIG;IACH,SAAgB,kBAAkB,EAAE,MAAM,CAAC;gBAGzB,IAAI,EAAE,QAAQ,EACd,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,EACtB,UAAU,CAAC,oBAAQ;IAKrC,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;CAG5C;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,KAAK,EAAE,MAAM,IAAI,CAAC;IAElB,cAAc,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC5B,UAAU,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IACxB,OAAO,EAAE,QAAQ,EAAE,CAAC;CACrB,CAAC;AAUF,qBAAa,cAAc;IACzB,SAAgB,WAAW,qBAA4B;IACvD,SAAgB,kBAAkB,qBAA4B;IAE9D,QAAQ,CAAC,aAAa,EAAE,GAAG,CAAC,iBAAiB,CAAC,CAAa;IAE3D,QAAQ,CAAC,SAAS,6BAAoC;IACtD,QAAQ,CAAC,qBAAqB,8BAAqC;IACnE,QAAQ,CAAC,cAAc,EAAE,MAAM,EAAE,CAAM;IAEvC,QAAQ,CAAC,KAAK,oBAA2B;IACzC,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,CAAM;IAEnC,QAAQ,CAAC,IAAI,EAAE,QAAQ,EAAE,CAAM;IAE/B,OAAO,CAAC,YAAY,CAAuB;;IAY3C,cAAc,CAAC,GAAG,EAAE,MAAM;IAyC1B,iBAAiB;IAIjB,SAAS,CAAC,MAAM,EAAE,eAAe,GAAG,WAAW;IAO/C,OAAO,CAAC,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,cAAc;IAQrD,cAAc,IAAI,WAAW;IAe7B,eAAe,CAAC,QAAQ,EAAE,GAAG,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAuBnD,kBAAkB,CAAC,QAAQ,EAAE,GAAG,GAAG,MAAM,EAAE;IAU3C,aAAa,CAAC,QAAQ,EAAE,GAAG,GAAG,MAAM,GAAG,IAAI;IAK3C,wBAAwB,CAAC,SAAS,EAAE,MAAM,GAAG,aAAa,EAAE;IAM5D,yBAAyB,CAAC,UAAU,EAAE,MAAM,GAAG,aAAa,EAAE;IAI9D,OAAO;IAmDP,OAAO,CAAC,kBAAkB;IAM1B,OAAO,CAAC,cAAc;IAMtB,OAAO,CAAC,eAAe;IAQvB,OAAO,CAAC,WAAW;IAOnB,OAAO,CAAC,QAAQ;IAWhB,OAAO,CAAC,aAAa,CAgCnB;CACH;AAGD,qBAAa,WAAW;IAepB,OAAO,CAAC,eAAe;IAdzB,MAAM,CAAC,MAAM,SAAK;IAElB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAQ;IACxC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAQ;IAC1C,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAQ;IAC5B,KAAK,EAAE,eAAe,GAAG,IAAI,CAAQ;IAErC,OAAO,CAAC,sBAAsB,CAAU;IACxC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAwB;gBAGnC,eAAe,EAAE,cAAc,EACvC,MAAM,EAAE,eAAe;IAqBzB,IAAI,GAAG,IAAI,OAAO,GAAG,IAAI,CAExB;IAED,WAAW;IASX,SAAS,CAAC,GAAG,EAAE,OAAO;IAUtB,SAAS,IAAI,IAAI;IAYjB,OAAO,CAAC,sBAAsB;CAO/B;AAiBD,eAAO,MAAM,eAAe,EAAE,cAA+E,CAAC;AAsE9G,eAAO,MAAM,iBAAiB,cAAe,MAAM,WAQlD,CAAC"}

package/dist/types/src/util.d.ts

@@ -0,0 +1,2 @@
+export declare const createId: () => string;
+//# sourceMappingURL=util.d.ts.map

package/dist/types/src/util.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../../../src/util.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,QAAQ,cAA4C,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/tracing",
-  "version": "0.5.3-main.6f2dfea",
+  "version": "0.5.3-main.77c09ab",
   "description": "Async utilities.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -16,18 +16,18 @@
     "src"
   ],
   "dependencies": {
-    "@dxos/async": "0.5.3-main.6f2dfea",
-    "@dxos/codec-protobuf": "0.5.3-main.6f2dfea",
-    "@dxos/context": "0.5.3-main.6f2dfea",
-    "@dxos/debug": "0.5.3-main.6f2dfea",
-    "@dxos/invariant": "0.5.3-main.6f2dfea",
-    "@dxos/log": "0.5.3-main.6f2dfea",
-    "@dxos/node-std": "0.5.3-main.6f2dfea",
-    "@dxos/protocols": "0.5.3-main.6f2dfea",
-    "@dxos/util": "0.5.3-main.6f2dfea"
+    "@dxos/async": "0.5.3-main.77c09ab",
+    "@dxos/codec-protobuf": "0.5.3-main.77c09ab",
+    "@dxos/context": "0.5.3-main.77c09ab",
+    "@dxos/debug": "0.5.3-main.77c09ab",
+    "@dxos/invariant": "0.5.3-main.77c09ab",
+    "@dxos/log": "0.5.3-main.77c09ab",
+    "@dxos/protocols": "0.5.3-main.77c09ab",
+    "@dxos/node-std": "0.5.3-main.77c09ab",
+    "@dxos/util": "0.5.3-main.77c09ab"
   },
   "devDependencies": {
-    "@dxos/test": "0.5.3-main.6f2dfea"
+    "@dxos/test": "0.5.3-main.77c09ab"
   },
   "publishConfig": {
     "access": "public"

package/src/api.ts

@@ -3,6 +3,7 @@
 //
 
 import { Context } from '@dxos/context';
+import { type MaybePromise } from '@dxos/util';
 
 import { getTracingContext } from './symbols';
 import { TRACE_PROCESSOR } from './trace-processor';
@@ -104,12 +105,42 @@ const addLink = (parent: any, child: any, opts: AddLinkOptions = {}) => {
   TRACE_PROCESSOR.addLink(parent, child, opts);
 };
 
+export type TraceDiagnosticParams<T> = {
+  /**
+   * Unique ID.
+   */
+  id: string;
+
+  /**
+   * Human-readable name.
+   * @defaults Defaults to `id`
+   */
+  name?: string;
+
+  /**
+   * Function that will be called to fetch the diagnostic data.
+   */
+  fetch: () => MaybePromise<T>;
+};
+
+export interface TraceDiagnostic {
+  id: string;
+  unregister(): void;
+}
+
+/**
+ * Register a diagnostic that could be queried.
+ */
+const diagnostic = <T>(params: TraceDiagnosticParams<T>): TraceDiagnostic => {
+  return TRACE_PROCESSOR.diagnostics.registerDiagnostic(params);
+};
+
 export const trace = {
-  resource,
+  addLink,
+  diagnostic,
   info,
   mark,
-  span,
   metricsCounter,
-
-  addLink,
+  resource,
+  span,
 };

package/src/diagnostic.ts

@@ -0,0 +1,96 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { asyncTimeout } from '@dxos/async';
+import { invariant } from '@dxos/invariant';
+
+import { type TraceDiagnosticParams, type TraceDiagnostic } from './api';
+import { createId } from './util';
+
+export const DIAGNOSTICS_TIMEOUT = 10_000;
+
+export type DiagnosticMetadata = {
+  id: string;
+  instanceId: string;
+  instanceTag: string | null;
+  name: string;
+};
+
+export type DiagnosticsRequest = {
+  id: string;
+  instanceId: string;
+};
+
+export type DiagnosticsData = {
+  id: string;
+  instanceId: string;
+  data: any;
+  error?: string;
+};
+
+export class TraceDiagnosticImpl implements TraceDiagnostic {
+  constructor(
+    public id: string,
+    public fetch: () => any,
+    public name: string,
+    private readonly _onUnregister: () => void,
+  ) {}
+
+  unregister(): void {
+    this._onUnregister();
+  }
+}
+
+export class DiagnosticsManager {
+  readonly instanceId = createId();
+
+  readonly registry = new Map<string, TraceDiagnosticImpl>();
+
+  private _instanceTag: string | null = null;
+
+  setInstanceTag(tag: string): void {
+    this._instanceTag = tag;
+  }
+
+  registerDiagnostic(params: TraceDiagnosticParams<any>): TraceDiagnostic {
+    const impl = new TraceDiagnosticImpl(params.id, params.fetch, params.name ?? params.id, () => {
+      if (this.registry.get(params.id) === impl) {
+        this.registry.delete(params.id);
+      }
+    });
+    this.registry.set(params.id, impl);
+    return impl;
+  }
+
+  list(): DiagnosticMetadata[] {
+    return Array.from(this.registry.values()).map((diagnostic) => ({
+      id: diagnostic.id,
+      instanceId: this.instanceId,
+      instanceTag: this._instanceTag,
+      name: diagnostic.name,
+    }));
+  }
+
+  async fetch(request: DiagnosticsRequest): Promise<DiagnosticsData> {
+    invariant(request.instanceId === this.instanceId, 'Invalid instance id');
+    const { id } = request;
+    const diagnostic = this.registry.get(id);
+    invariant(diagnostic, 'Diagnostic not found');
+    try {
+      const data = await asyncTimeout(diagnostic.fetch(), DIAGNOSTICS_TIMEOUT);
+      return {
+        id,
+        instanceId: this.instanceId,
+        data,
+      };
+    } catch (err: any) {
+      return {
+        id,
+        instanceId: this.instanceId,
+        data: null,
+        error: err.stack,
+      };
+    }
+  }
+}

package/src/diagnostics-channel.ts

@@ -0,0 +1,161 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { Trigger, sleep } from '@dxos/async';
+import { Context } from '@dxos/context';
+
+import {
+  DIAGNOSTICS_TIMEOUT,
+  type DiagnosticMetadata,
+  type DiagnosticsData,
+  type DiagnosticsManager,
+  type DiagnosticsRequest,
+} from './diagnostic';
+import { createId } from './util';
+
+const DEFAULT_CHANNEL_NAME = 'dxos-diagnostics';
+
+const DISCOVER_TIME = 500;
+
+export type DiagnosticChannelMessage =
+  | {
+      type: 'DIAGNOSTICS_DISCOVER';
+    }
+  | {
+      type: 'DIAGNOSTICS_ANNOUNCE';
+      diagnostics: DiagnosticMetadata[];
+    }
+  | {
+      type: 'DIAGNOSTICS_FETCH';
+      requestId: string;
+      request: DiagnosticsRequest;
+    }
+  | {
+      type: 'DIAGNOSTICS_RESPONSE';
+      requestId: string;
+      data: DiagnosticsData;
+    };
+
+export class DiagnosticsChannel {
+  private _ctx = new Context();
+
+  // Separate channels becauase the client and server may be in the same process.
+  private readonly _serveChannel: BroadcastChannel;
+  private readonly _clientChannel: BroadcastChannel;
+
+  constructor(private readonly _channelName: string = DEFAULT_CHANNEL_NAME) {
+    this._serveChannel = new BroadcastChannel(_channelName);
+    this._clientChannel = new BroadcastChannel(_channelName);
+  }
+
+  destroy() {
+    void this._ctx.dispose();
+    this._serveChannel.close();
+    this._clientChannel.close();
+  }
+
+  /**
+   * In node.js, the channel will keep the process alive.
+   * This method allows the process to exit.
+   * Noop in the browser.
+   */
+  unref() {
+    if (typeof (this._serveChannel as any).unref === 'function') {
+      (this._serveChannel as any).unref();
+      (this._clientChannel as any).unref();
+    }
+  }
+
+  serve(manager: DiagnosticsManager) {
+    const listener = async (event: MessageEvent) => {
+      switch (event.data.type) {
+        case 'DIAGNOSTICS_DISCOVER': {
+          const diagnostics = manager.list();
+          this._serveChannel.postMessage({
+            type: 'DIAGNOSTICS_ANNOUNCE',
+            diagnostics,
+          } satisfies DiagnosticChannelMessage);
+          break;
+        }
+        case 'DIAGNOSTICS_FETCH': {
+          const { requestId, request } = event.data;
+          if (request.instanceId !== manager.instanceId) {
+            break;
+          }
+
+          const data = await manager.fetch(request);
+          this._serveChannel.postMessage({
+            type: 'DIAGNOSTICS_RESPONSE',
+            requestId,
+            data,
+          } satisfies DiagnosticChannelMessage);
+          break;
+        }
+      }
+    };
+
+    this._serveChannel.addEventListener('message', listener);
+    this._ctx.onDispose(() => this._serveChannel.removeEventListener('message', listener));
+  }
+
+  async discover(): Promise<DiagnosticMetadata[]> {
+    const diagnostics: DiagnosticMetadata[] = [];
+
+    const collector = (event: MessageEvent) => {
+      const data = event.data as DiagnosticChannelMessage;
+      switch (data.type) {
+        case 'DIAGNOSTICS_ANNOUNCE':
+          diagnostics.push(...data.diagnostics);
+          break;
+      }
+    };
+
+    try {
+      this._clientChannel.addEventListener('message', collector);
+      this._clientChannel.postMessage({ type: 'DIAGNOSTICS_DISCOVER' } satisfies DiagnosticChannelMessage);
+
+      await sleep(DISCOVER_TIME);
+
+      // Dedup.
+      const result: DiagnosticMetadata[] = [];
+      for (const diagnostic of diagnostics) {
+        if (!result.some((d) => d.id === diagnostic.id && d.instanceId === diagnostic.instanceId)) {
+          result.push(diagnostic);
+        }
+      }
+
+      return diagnostics;
+    } finally {
+      this._clientChannel.removeEventListener('message', collector);
+    }
+  }
+
+  async fetch(request: DiagnosticsRequest): Promise<DiagnosticsData> {
+    const requestId = createId();
+
+    const trigger = new Trigger<DiagnosticsData>();
+    const listener = (event: MessageEvent) => {
+      const data = event.data as DiagnosticChannelMessage;
+      if (data.type === 'DIAGNOSTICS_RESPONSE' && data.requestId === requestId) {
+        trigger.wake(data.data);
+      }
+    };
+
+    try {
+      this._clientChannel.addEventListener('message', listener);
+      this._clientChannel.postMessage({
+        type: 'DIAGNOSTICS_FETCH',
+        requestId,
+        request,
+      } satisfies DiagnosticChannelMessage);
+
+      // NOTE: Must have await keyword in this block.
+      const result = await trigger.wait({ timeout: DIAGNOSTICS_TIMEOUT });
+
+      return result;
+    } finally {
+      this._clientChannel.removeEventListener('message', listener);
+    }
+  }
+}

package/src/index.ts

@@ -2,8 +2,24 @@
 // Copyright 2023 DXOS.org
 //
 
+import { trace } from './api';
+
 export * from './api';
 export * from './symbols';
 export * from './trace-processor';
 export * from './trace-sender';
 export * from './metrics';
+export * from './diagnostic';
+
+trace.diagnostic({
+  id: 'process-info',
+  name: 'Process Info',
+  fetch: async () => {
+    return {
+      platform: globalThis.process?.platform,
+      arch: globalThis.process?.arch,
+      versions: globalThis.process?.versions,
+      href: globalThis.location?.href,
+    };
+  },
+});

package/src/trace-processor.ts

@@ -11,6 +11,8 @@ import { type Metric, type Resource, type Span } from '@dxos/protocols/proto/dxo
 import { getPrototypeSpecificInstanceId } from '@dxos/util';
 
 import type { AddLinkOptions } from './api';
+import { DiagnosticsManager } from './diagnostic';
+import { DiagnosticsChannel } from './diagnostics-channel';
 import { type BaseCounter } from './metrics';
 import { TRACE_SPAN_ATTRIBUTE, getTracingContext } from './symbols';
 import { TraceSender } from './trace-sender';
@@ -72,6 +74,9 @@ const REFRESH_INTERVAL = 1_000;
 const MAX_INFO_OBJECT_DEPTH = 8;
 
 export class TraceProcessor {
+  public readonly diagnostics = new DiagnosticsManager();
+  public readonly diagnosticsChannel = new DiagnosticsChannel();
+
   readonly subscriptions: Set<TraceSubscription> = new Set();
 
   readonly resources = new Map<number, ResourceEntry>();
@@ -83,11 +88,21 @@ export class TraceProcessor {
 
   readonly logs: LogEntry[] = [];
 
+  private _instanceTag: string | null = null;
+
   constructor() {
     log.addProcessor(this._logProcessor.bind(this));
 
     const refreshInterval = setInterval(this.refresh.bind(this), REFRESH_INTERVAL);
     unrefTimeout(refreshInterval);
+
+    this.diagnosticsChannel.serve(this.diagnostics);
+    this.diagnosticsChannel.unref();
+  }
+
+  setInstanceTag(tag: string) {
+    this._instanceTag = tag;
+    this.diagnostics.setInstanceTag(tag);
   }
 
   /**

package/src/util.ts

@@ -0,0 +1,6 @@
+// TODO(dmaretskyi): Use UUID.
+//
+// Copyright 2024 DXOS.org
+//
+
+export const createId = () => Math.random().toString(36).slice(2);