@dxos/observability 0.8.4-main.84f28bd → 0.8.4-main.8baae0fced

package/src/helpers/setup-telemetry-listeners.ts

@@ -1,108 +0,0 @@
-//
-// Copyright 2022 DXOS.org
-//
-
-import type { Client } from '@dxos/client';
-
-import { getTelemetryIdentity } from './common';
-import { type Observability } from '../observability';
-
-let lastFocusEvent = new Date();
-let totalTime = 0;
-
-export const setupTelemetryListeners = (namespace: string, client: Client, observability: Observability) => {
-  const clickCallback = (event: Event) => {
-    const id = (event.target as HTMLElement)?.id;
-    if (!id) {
-      return;
-    }
-
-    setTimeout(() => {
-      observability.track({
-        ...getTelemetryIdentity(client),
-        action: 'window.click',
-        properties: {
-          id: (event.target as HTMLElement)?.id,
-          path: (event.composedPath() as HTMLElement[])
-            .filter((el) => Boolean(el.tagName))
-            .map((el) => `${el.tagName.toLowerCase()}${el.id ? `#${el.id}` : ''}`)
-            .reverse()
-            .join('>'),
-        },
-      });
-    });
-  };
-
-  const focusCallback = () => {
-    const now = new Date();
-    setTimeout(() => {
-      observability.track({
-        ...getTelemetryIdentity(client),
-        action: 'window.focus',
-        properties: {
-          timeAway: now.getTime() - lastFocusEvent.getTime(),
-        },
-      });
-    });
-
-    lastFocusEvent = now;
-  };
-
-  const blurCallback = () => {
-    const now = new Date();
-    const duration = now.getTime() - lastFocusEvent.getTime();
-    setTimeout(() => {
-      observability.track({
-        ...getTelemetryIdentity(client),
-        action: 'window.blur',
-        properties: {
-          duration,
-        },
-      });
-    });
-
-    lastFocusEvent = now;
-    totalTime = totalTime + duration;
-  };
-
-  const unloadCallback = () => {
-    setTimeout(() => {
-      observability.track({
-        ...getTelemetryIdentity(client),
-        action: 'page.unload',
-        properties: {
-          duration: totalTime,
-        },
-      });
-    });
-  };
-
-  const errorCallback = (event: ErrorEvent) => {
-    setTimeout(() => {
-      observability.track({
-        ...getTelemetryIdentity(client),
-        action: 'window.error',
-        properties: {
-          message: event.message,
-          filename: event.filename,
-          stack: (event.error as Error)?.stack,
-          cause: (event.error as Error)?.cause,
-        },
-      });
-    });
-  };
-
-  window.addEventListener('click', clickCallback, true);
-  window.addEventListener('focus', focusCallback);
-  window.addEventListener('blur', blurCallback);
-  window.addEventListener('beforeunload', unloadCallback);
-  window.addEventListener('error', errorCallback);
-
-  return () => {
-    window.removeEventListener('click', clickCallback, true);
-    window.removeEventListener('focus', focusCallback);
-    window.removeEventListener('blur', blurCallback);
-    window.removeEventListener('beforeunload', unloadCallback);
-    window.removeEventListener('error', errorCallback);
-  };
-};

package/src/otel/index.ts

@@ -1,8 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-export * from './otel';
-export * from './logs';
-export * from './metrics';
-export * from './traces';

package/src/otel/logs.ts

@@ -1,100 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { SeverityNumber } from '@opentelemetry/api-logs';
-import { OTLPLogExporter } from '@opentelemetry/exporter-logs-otlp-http';
-import { Resource } from '@opentelemetry/resources';
-import { BatchLogRecordProcessor, LoggerProvider } from '@opentelemetry/sdk-logs';
-import { SEMRESATTRS_SERVICE_NAME, SEMRESATTRS_SERVICE_VERSION } from '@opentelemetry/semantic-conventions';
-
-import {
-  getContextFromEntry,
-  getRelativeFilename,
-  type LogConfig,
-  type LogEntry,
-  LogLevel,
-  type LogProcessor,
-} from '@dxos/log';
-import { jsonlogify } from '@dxos/util';
-
-import { type OtelOptions, setDiagLogger } from './otel';
-
-export type OtelLogOptions = OtelOptions & {
-  logLevel: LogLevel;
-  /**
-   * Set `true` to capture logs sent through LoggingService from shared worker.
-   * Better to set to `false` because shared worker is initializing its own logger.
-   */
-  includeSharedWorkerLogs: boolean;
-};
-
-export class OtelLogs {
-  private _loggerProvider: LoggerProvider;
-  constructor(private readonly options: OtelLogOptions) {
-    setDiagLogger(options.consoleDiagLogLevel);
-    const resource = Resource.default().merge(
-      new Resource({
-        [SEMRESATTRS_SERVICE_NAME]: this.options.serviceName,
-        [SEMRESATTRS_SERVICE_VERSION]: this.options.serviceVersion,
-      }),
-    );
-    const logExporter = new OTLPLogExporter({
-      url: this.options.endpoint + '/v1/logs',
-      headers: {
-        Authorization: this.options.authorizationHeader,
-      },
-      concurrencyLimit: 10, // an optional limit on pending requests
-    });
-    this._loggerProvider = new LoggerProvider({ resource });
-    this._loggerProvider.addLogRecordProcessor(new BatchLogRecordProcessor(logExporter));
-  }
-
-  public readonly logProcessor: LogProcessor = (config: LogConfig, entry: LogEntry) => {
-    const logger = this._loggerProvider.getLogger('dxos-observability', this.options.serviceVersion);
-
-    if (
-      entry.level < this.options.logLevel ||
-      (!this.options.includeSharedWorkerLogs && entry.meta?.S?.remoteSessionId)
-    ) {
-      return;
-    }
-
-    const record = {
-      ...entry,
-      ...(entry.meta ? { meta: { file: getRelativeFilename(entry.meta.F), line: entry.meta.L } } : {}),
-      context: jsonlogify(getContextFromEntry(entry)),
-    };
-
-    logger.emit({
-      severityNumber: convertLevel(entry.level),
-      body: JSON.stringify(record),
-      attributes: this.options.getTags(),
-    });
-  };
-
-  flush(): Promise<void> {
-    return this._loggerProvider.forceFlush();
-  }
-
-  close(): Promise<void> {
-    return this._loggerProvider.shutdown();
-  }
-}
-
-const convertLevel = (level: LogLevel): SeverityNumber => {
-  switch (level) {
-    case LogLevel.DEBUG:
-      return SeverityNumber.DEBUG;
-    case LogLevel.VERBOSE:
-      return SeverityNumber.INFO;
-    case LogLevel.INFO:
-      return SeverityNumber.INFO;
-    case LogLevel.WARN:
-      return SeverityNumber.WARN;
-    case LogLevel.ERROR:
-      return SeverityNumber.ERROR;
-    default:
-      return SeverityNumber.ERROR;
-  }
-};

package/src/otel/otel.ts

@@ -1,21 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { diag, DiagConsoleLogger, DiagLogLevel } from '@opentelemetry/api';
-
-export type OtelOptions = {
-  endpoint: string;
-  authorizationHeader: string;
-  serviceName: string; // For the Otel API, the name of the entity for which signals (metrics or trace) are collected.
-  serviceVersion: string; // For the Otel API, The name of the entity for which signals (metrics or trace) are collected.
-  getTags: () => { [key: string]: string };
-  consoleDiagLogLevel?: string;
-};
-
-export const setDiagLogger = (level?: string) => {
-  const logLevel = DiagLogLevel[level as keyof typeof DiagLogLevel];
-  if (logLevel) {
-    diag.setLogger(new DiagConsoleLogger(), logLevel);
-  }
-};

package/src/otel/traces-browser.ts

@@ -1,59 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { trace, type Tracer } from '@opentelemetry/api';
-import { getWebAutoInstrumentations } from '@opentelemetry/auto-instrumentations-web';
-import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-http';
-import { registerInstrumentations } from '@opentelemetry/instrumentation';
-import { Resource } from '@opentelemetry/resources';
-import { ConsoleSpanExporter, SimpleSpanProcessor, BatchSpanProcessor } from '@opentelemetry/sdk-trace-base';
-import { WebTracerProvider } from '@opentelemetry/sdk-trace-web';
-import { SEMRESATTRS_SERVICE_NAME, SEMRESATTRS_SERVICE_VERSION } from '@opentelemetry/semantic-conventions';
-
-import { log } from '@dxos/log';
-import { TRACE_PROCESSOR, type StartSpanOptions } from '@dxos/tracing';
-
-import { type OtelOptions } from './otel';
-
-export class OtelTraces {
-  private _tracer: Tracer;
-  constructor(private readonly options: OtelOptions) {
-    const resource = Resource.default().merge(
-      new Resource({
-        [SEMRESATTRS_SERVICE_NAME]: this.options.serviceName,
-        [SEMRESATTRS_SERVICE_VERSION]: this.options.serviceVersion,
-      }),
-    );
-
-    const tracerProvider = new WebTracerProvider({ resource });
-    tracerProvider.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter()));
-    tracerProvider.addSpanProcessor(
-      new BatchSpanProcessor(
-        new OTLPTraceExporter({
-          url: this.options.endpoint + '/v1/traces',
-          headers: {
-            Authorization: this.options.authorizationHeader,
-          },
-          concurrencyLimit: 10, // an optional limit on pending requests
-        }),
-      ),
-    );
-    // TODO(nf): ContextManager? Propogator?
-    tracerProvider.register({});
-    this._tracer = trace.getTracer('dxos-observability', this.options.serviceVersion);
-  }
-
-  public start(): void {
-    registerInstrumentations({
-      instrumentations: [getWebAutoInstrumentations()],
-    });
-    log('trace processor registered');
-    TRACE_PROCESSOR.remoteTracing.registerProcessor({
-      startSpan: (options: StartSpanOptions) => {
-        log('begin otel trace', { options });
-        return this._tracer.startSpan(options.name, options);
-      },
-    });
-  }
-}

package/src/otel/traces.ts

@@ -1,57 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { trace, type Tracer } from '@opentelemetry/api';
-import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-http';
-import { Resource } from '@opentelemetry/resources';
-import {
-  BasicTracerProvider,
-  BatchSpanProcessor,
-  ConsoleSpanExporter,
-  SimpleSpanProcessor,
-} from '@opentelemetry/sdk-trace-base';
-import { SEMRESATTRS_SERVICE_NAME, SEMRESATTRS_SERVICE_VERSION } from '@opentelemetry/semantic-conventions';
-import { log } from 'debug';
-
-import { TRACE_PROCESSOR, type StartSpanOptions } from '@dxos/tracing';
-
-import { type OtelOptions } from './otel';
-
-export class OtelTraces {
-  private _tracer: Tracer;
-  constructor(private readonly options: OtelOptions) {
-    const resource = Resource.default().merge(
-      new Resource({
-        [SEMRESATTRS_SERVICE_NAME]: this.options.serviceName,
-        [SEMRESATTRS_SERVICE_VERSION]: this.options.serviceVersion,
-      }),
-    );
-
-    const tracerProvider = new BasicTracerProvider({ resource });
-    tracerProvider.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter()));
-    tracerProvider.addSpanProcessor(
-      new BatchSpanProcessor(
-        new OTLPTraceExporter({
-          url: this.options.endpoint + '/v1/traces',
-          headers: {
-            Authorization: this.options.authorizationHeader,
-          },
-          concurrencyLimit: 10, // an optional limit on pending requests
-        }),
-      ),
-    );
-    tracerProvider.register();
-    this._tracer = trace.getTracer('dxos-observability', this.options.serviceVersion);
-  }
-
-  public start(): void {
-    log('trace processor registered');
-    TRACE_PROCESSOR.remoteTracing.registerProcessor({
-      startSpan: (options: StartSpanOptions) => {
-        log('begin otel trace', { options });
-        return this._tracer.startSpan(options.name, options);
-      },
-    });
-  }
-}

package/src/segment/base.ts

@@ -1,69 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { type TrackParams, type PageParams, type IdentifyParams } from '@segment/analytics-node';
-
-import { log } from '@dxos/log';
-
-import {
-  type IdentityOptions,
-  type PageOptions,
-  type SegmentIdentityOptions,
-  type Tags,
-  TelemetryEvent,
-  type TrackOptions,
-} from './types';
-
-/**
- * NOTE: Segment provides a default ID if we don't provide one.
- */
-const getIdentityOptions = ({ did, installationId }: IdentityOptions): SegmentIdentityOptions => {
-  if (!did && !installationId) {
-    log.warn('No telemetry identifier provided.');
-  }
-
-  return {
-    userId: did,
-    anonymousId: installationId,
-  } as SegmentIdentityOptions;
-};
-
-/**
- * Base class for Node and BrowserSegment telemetry.
- */
-export abstract class AbstractSegmentTelemetry {
-  constructor(private readonly _getTags: () => Tags) {}
-
-  abstract identify(options: IdentifyParams): void;
-
-  abstract page(options: PageOptions): void;
-
-  abstract track(options: TrackOptions): void;
-
-  protected createPageProps(options: PageOptions): PageParams {
-    const { properties, ...rest } = options;
-    return {
-      ...getIdentityOptions(options),
-      ...rest,
-      properties: {
-        common: this._getTags(),
-        custom: properties,
-      },
-    };
-  }
-
-  protected createTrackProps(options: TrackOptions): TrackParams {
-    const { event, action, properties, ...rest } = options;
-    return {
-      ...getIdentityOptions(options),
-      ...rest,
-      event: event ?? TelemetryEvent.ACTION,
-      properties: {
-        action,
-        common: this._getTags(),
-        custom: properties,
-      },
-    };
-  }
-}

package/src/segment/browser.ts

@@ -1,68 +0,0 @@
-//
-// Copyright 2022 DXOS.org
-//
-
-import { type IdentifyParams } from '@segment/analytics-node';
-import snippet from '@segment/snippet';
-
-import { log } from '@dxos/log';
-
-import { AbstractSegmentTelemetry } from './base';
-import type { TrackOptions, SegmentTelemetryOptions, PageOptions } from './types';
-import { captureException } from '../sentry';
-
-/**
- * Browser telemetry.
- */
-// https://segment.com/docs/connections/sources/catalog/libraries/website/javascript/#basic-tracking-methods
-export class SegmentTelemetry extends AbstractSegmentTelemetry {
-  constructor({ apiKey, batchSize, getTags }: SegmentTelemetryOptions) {
-    super(getTags);
-    try {
-      const contents = snippet.min({ apiKey, page: false });
-      const script = document.createElement('script');
-      script.innerHTML = contents;
-      document.body.append(script);
-    } catch (err) {
-      log.catch('failed to initialize telemetry', err);
-    }
-  }
-
-  identify(options: IdentifyParams): void {
-    try {
-      (window as any).analytics?.identify(options.userId, options.traits);
-    } catch (err) {
-      log.catch('failed to identify', err);
-    }
-  }
-
-  page(options: PageOptions): void {
-    try {
-      const props = this.createPageProps(options);
-      (window as any).analytics?.page(props.category, props.name, props.properties);
-    } catch (err) {
-      log.catch('failed to track page', err);
-    }
-  }
-
-  track(options: TrackOptions): void {
-    try {
-      const props = this.createTrackProps(options);
-      (window as any).analytics?.track(props.event, props.properties);
-    } catch (err) {
-      log.catch('failed to track event', err);
-    }
-  }
-
-  async flush(): Promise<void> {
-    try {
-      await (window as any).analytics?.flush((err: any) => {
-        captureException(err);
-      });
-    } catch (err) {
-      log.catch('failed to flush telemetry', err);
-    }
-  }
-
-  async close(): Promise<void> {}
-}

package/src/segment/node.ts

@@ -1,94 +0,0 @@
-//
-// Copyright 2022 DXOS.org
-//
-
-import { Analytics, type IdentifyParams } from '@segment/analytics-node';
-
-import { invariant } from '@dxos/invariant';
-import { log } from '@dxos/log';
-
-import { AbstractSegmentTelemetry } from './base';
-import type { SegmentTelemetryOptions, PageOptions, TrackOptions } from './types';
-import { captureException } from '../sentry';
-
-/**
- * Node telemetry.
- */
-export class SegmentTelemetry extends AbstractSegmentTelemetry {
-  private _analytics?: Analytics;
-
-  constructor({ apiKey, batchSize, getTags }: SegmentTelemetryOptions) {
-    super(getTags);
-    try {
-      invariant(apiKey, 'Missing API key.');
-      this._analytics = new Analytics({
-        writeKey: apiKey,
-        flushAt: batchSize,
-      });
-    } catch (err) {
-      log.catch('Failed to initialize telemetry', err);
-    }
-  }
-
-  identify(options: IdentifyParams): void {
-    if (!this._analytics) {
-      log('Analytics not initialized', { action: 'identify' });
-      return;
-    }
-
-    try {
-      this._analytics.identify(options);
-    } catch (err) {
-      log.catch('Failed to identify', err);
-    }
-  }
-
-  page(options: PageOptions): void {
-    if (!this._analytics) {
-      log('Analytics not initialized', { action: 'page' });
-      return;
-    }
-
-    try {
-      this._analytics.page(this.createPageProps(options));
-    } catch (err) {
-      log.catch('Failed to track page', err);
-    }
-  }
-
-  track(options: TrackOptions): void {
-    if (!this._analytics) {
-      log('Analytics not initialized', { action: 'track' });
-      return;
-    }
-
-    log.info('sending event to telemetry', { options });
-    try {
-      this._analytics.track(this.createTrackProps(options));
-    } catch (err) {
-      log.catch('Failed to track action', err);
-    }
-  }
-
-  async flush(): Promise<void> {
-    if (!this._analytics) {
-      log('Analytics not initialized', { action: 'flush' });
-      return;
-    }
-
-    try {
-      await this._analytics.flush();
-    } catch (err) {
-      // are these errors worth capturing?
-      captureException(err);
-    }
-  }
-
-  async close(): Promise<void> {
-    if (!this._analytics) {
-      return;
-    }
-
-    await this._analytics.closeAndFlush();
-  }
-}

package/src/segment/types.ts

@@ -1,57 +0,0 @@
-//
-// Copyright 2022 DXOS.org
-//
-
-export type Tags = Record<string, string>;
-
-export type SegmentTelemetryOptions = {
-  apiKey?: string;
-  batchSize?: number;
-  enable?: boolean;
-  getTags: () => Tags;
-};
-
-// Copied from @segment/analytics-node.
-export type SegmentIdentityOptions =
-  | { userId: string; anonymousId?: string }
-  | { userId?: string; anonymousId: string };
-
-// TODO(burdon): Should require one or the other.
-export type IdentityOptions = { did?: string; installationId?: string };
-
-export type CommonOptions = IdentityOptions & {
-  timestamp?: Date;
-  properties?: Record<string, unknown>;
-};
-
-/**
- * Page views.
- * https://segment.com/docs/connections/sources/catalog/libraries/server/node/#page
- */
-export type PageOptions = CommonOptions & {
-  category?: string;
-  name?: string;
-};
-
-/**
- * Track actions.
- * https://segment.com/docs/connections/sources/catalog/libraries/server/node/#track
- */
-export type TrackOptions = CommonOptions & {
-  event?: TelemetryEvent;
-  action: string;
-};
-
-/**
- * Each event will be mapped to a different Postgres table via segment.
- */
-export enum TelemetryEvent {
-  /**
-   * Use actions.
-   */
-  ACTION = 'action',
-  /**
-   * High-volume technical metrics.
-   */
-  METRICS = 'metrics',
-}