@dxos/observability 0.8.4-main.a4bbb77 → 0.8.4-main.abd8ff62ef

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',
-}

package/src/sentry/browser.ts

@@ -1,133 +0,0 @@
-//
-// Copyright 2022 DXOS.org
-//
-
-import {
-  breadcrumbsIntegration,
-  browserTracingIntegration,
-  feedbackIntegration,
-  httpClientIntegration,
-  metrics,
-  addBreadcrumb as naturalAddBreadcrumb,
-  captureException as naturalCaptureException,
-  captureMessage as naturalCaptureMessage,
-  init as naturalInit,
-  sendFeedback as naturalSendFeedback,
-  withScope as naturalWithScope,
-  replayIntegration,
-  setTag,
-  startInactiveSpan,
-} from '@sentry/browser';
-
-import { log } from '@dxos/log';
-import { TRACE_PROCESSOR } from '@dxos/tracing';
-
-import { type InitOptions } from './types';
-
-// Polyfill export.
-export { setTag, setTags, setUser } from '@sentry/browser';
-
-/**
- * To use this SDK, call the init function as early as possible when loading the web page.
- * To set context information or send manual events, use the provided methods.
- *
- * @param options {InitOptions}
- */
-export const init = (options: InitOptions) => {
-  try {
-    log('sentry init', options);
-    naturalInit({
-      enabled: options.enable ?? true,
-      dsn: options.destination,
-      release: options.release,
-      environment: options.environment,
-      integrations: [
-        breadcrumbsIntegration({ console: false, fetch: false }),
-        httpClientIntegration({
-          failedRequestStatusCodes: [
-            // 401 errors are omitted as they happen as a part of the EDGE authentication flow.
-            [400, 400],
-            [402, 599],
-          ],
-        }),
-        feedbackIntegration({ autoInject: false }),
-        ...(options.tracing ? [browserTracingIntegration()] : []),
-        ...(options.replay ? [replayIntegration({ blockAllMedia: true, maskAllText: true })] : []),
-      ],
-      replaysSessionSampleRate: options.replaySampleRate,
-      replaysOnErrorSampleRate: options.replaySampleRateOnError,
-      tracesSampleRate: options.sampleRate,
-      transport: options.transport,
-      beforeSend: (event) => {
-        options.onError?.(event);
-        return event;
-      },
-    });
-
-    if (options.tracing) {
-      TRACE_PROCESSOR.remoteMetrics.registerProcessor(metrics);
-      TRACE_PROCESSOR.remoteTracing.registerProcessor({
-        startSpan: startInactiveSpan,
-      });
-    }
-
-    Object.entries(options.properties ?? {}).forEach(([key, value]) => {
-      setTag(key, value);
-    });
-  } catch (err) {
-    log.catch('Failed to initialize sentry', err);
-  }
-};
-
-/**
- * Records a new breadcrumb which will be attached to future events.
- *
- * Breadcrumbs will be added to subsequent events to provide more context on user's actions prior to an error or crash.
- *
- * https://docs.sentry.io/platforms/javascript/enriching-events/breadcrumbs/
- *
- * @param breadcrumb — The breadcrumb to record.
- */
-export const addBreadcrumb: typeof naturalAddBreadcrumb = (breadcrumb) => {
-  try {
-    naturalAddBreadcrumb(breadcrumb);
-    log('add breadcrumb', breadcrumb);
-  } catch (err) {
-    log.catch('Failed to add breadcrumb', err);
-  }
-};
-
-/**
- * Captures an exception event and sends it to Sentry.
- *
- * @param exception — An exception-like object.
- * @param captureContext — Additional scope data to apply to exception event.
- * @returns — The generated eventId.
- */
-export const captureException: typeof naturalCaptureException = (exception, captureContext) => {
-  try {
-    const eventId = naturalCaptureException(exception, captureContext);
-    log('capture exception', { exception, eventId, ...captureContext });
-    return eventId;
-  } catch (err) {
-    log.catch('Failed to capture exception', err);
-    return 'unknown';
-  }
-};
-
-export const captureMessage: typeof naturalCaptureMessage = (exception, captureContext) => {
-  try {
-    const eventId = naturalCaptureMessage(exception, captureContext);
-    log('capture message', { exception, eventId, captureContext });
-    return eventId;
-  } catch (err) {
-    log.catch('Failed to capture message', err);
-    return 'unknown';
-  }
-};
-
-export const captureUserFeedback = (message: string) => {
-  return naturalSendFeedback({ message }, { includeReplay: true });
-};
-
-export const withScope = naturalWithScope;

package/src/sentry/index.ts

@@ -1,6 +0,0 @@
-//
-// Copyright 2022 DXOS.org
-//
-
-export * from './node';
-export type * from './types';

package/src/sentry/node.node.test.ts

@@ -1,40 +0,0 @@
-//
-// Copyright 2022 DXOS.org
-//
-
-import type { Stacktrace } from '@sentry/types';
-import { beforeAll, beforeEach, describe, expect, test } from 'vitest';
-
-import { sentryTestkit } from '../testing';
-
-import * as Sentry from './node';
-
-const { testkit, sentryTransport } = sentryTestkit();
-
-// TODO(burdon): https://example.com?
-const MOCK_DESTINATION = 'https://acacaeaccacacacabcaacdacdacadaca@sentry.io/000001';
-
-describe('Node error reporting', () => {
-  beforeAll(() => {
-    Sentry.init({
-      destination: MOCK_DESTINATION,
-      release: 'test',
-      transport: sentryTransport,
-      scrubFilenames: true,
-    });
-  });
-
-  beforeEach(() => {
-    testkit.reset();
-  });
-
-  test('should scrub stacktraces', async () => {
-    const err = new Error('error to look for');
-    Sentry.captureException(err);
-    await expect.poll(() => testkit.reports()).toHaveLength(1);
-    const report = testkit.findReport(err);
-    (report?.error?.stacktrace as Stacktrace).frames?.forEach((frame) => {
-      expect(frame.filename?.includes('/')).to.be.false;
-    });
-  });
-});

package/src/sentry/node.ts

@@ -1,126 +0,0 @@
-//
-// Copyright 2022 DXOS.org
-//
-
-import {
-  type Event,
-  metrics,
-  addBreadcrumb as naturalAddBreadcrumb,
-  captureException as naturalCaptureException,
-  captureMessage as naturalCaptureMessage,
-  init as naturalInit,
-  withScope as naturalWithScope,
-  setTag,
-  startInactiveSpan,
-} from '@sentry/node';
-
-import { log } from '@dxos/log';
-import { TRACE_PROCESSOR } from '@dxos/tracing';
-
-import { type InitOptions } from './types';
-
-// Polyfill export.
-export { setTag, setTags, setUser } from '@sentry/node';
-
-/**
- * To use this SDK, call the init function as early as possible in the main entry module.
- * To set context information or send manual events, use the provided methods.
- *
- * @param options {InitOptions}
- */
-export const init = (options: InitOptions) => {
-  try {
-    naturalInit({
-      enabled: options.enable ?? true,
-      dsn: options.destination,
-      serverName: options.installationId,
-      release: options.release,
-      environment: options.environment ?? process.env.DX_ENVIRONMENT,
-      integrations: [],
-      tracesSampleRate: options.sampleRate,
-      transport: options.transport,
-      beforeSend: (event) => {
-        options.scrubFilenames && scrub(event);
-        options.onError?.(event);
-
-        return event;
-      },
-    });
-
-    if (options.tracing) {
-      TRACE_PROCESSOR.remoteMetrics.registerProcessor(metrics);
-      TRACE_PROCESSOR.remoteTracing.registerProcessor({
-        startSpan: startInactiveSpan,
-      });
-    }
-
-    Object.entries(options.properties ?? {}).forEach(([key, value]) => {
-      setTag(key, value);
-    });
-  } catch (err) {
-    log.catch('Failed to initialize sentry', err);
-  }
-};
-
-const scrub = (event: Event) => {
-  event.exception?.values?.forEach((value) => {
-    value.stacktrace?.frames?.forEach((frame) => {
-      const filename = frame.filename?.split('/');
-      frame.filename = filename && filename[filename.length - 1];
-    });
-  });
-};
-
-/**
- * Records a new breadcrumb which will be attached to future events.
- *
- * Breadcrumbs will be added to subsequent events to provide more context on user's actions prior to an error or crash.
- *
- * https://docs.sentry.io/platforms/javascript/enriching-events/breadcrumbs/
- *
- * @param breadcrumb — The breadcrumb to record.
- */
-export const addBreadcrumb: typeof naturalAddBreadcrumb = (breadcrumb) => {
-  try {
-    naturalAddBreadcrumb(breadcrumb);
-    log('add breadcrumb', breadcrumb);
-  } catch (err) {
-    log.catch('Failed to add breadcrumb', err);
-  }
-};
-
-/**
- * Captures an exception event and sends it to Sentry.
- *
- * @param exception — An exception-like object.
- * @param captureContext — Additional scope data to apply to exception event.
- * @returns — The generated eventId.
- */
-export const captureException: typeof naturalCaptureException = (exception, captureContext) => {
-  try {
-    const eventId = naturalCaptureException(exception, captureContext);
-    log('capture exception', { exception, eventId, ...captureContext });
-    return eventId;
-  } catch (err) {
-    log.catch('Failed to capture exception', err);
-    return 'unknown';
-  }
-};
-
-export const captureMessage: typeof naturalCaptureMessage = (exception, captureContext) => {
-  try {
-    const eventId = naturalCaptureMessage(exception, captureContext);
-    log('capture message', { exception, eventId, captureContext });
-    return eventId;
-  } catch (err) {
-    log.catch('Failed to capture message', err);
-    return 'unknown';
-  }
-};
-
-export const captureUserFeedback = (message: string): Promise<void> => {
-  const feedback = `User feedback: ${message}`;
-  throw new Error(`Capture user feedback not implemented in node. Use @sentry/browser. Message: ${feedback}`);
-};
-
-export const withScope = naturalWithScope;

package/src/sentry/sentry-log-processor.ts

@@ -1,174 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import type { Breadcrumb, Event, SeverityLevel } from '@sentry/types';
-
-import { InvariantViolation } from '@dxos/invariant';
-import { type LogConfig, type LogEntry, LogLevel, type LogProcessor, shouldLog } from '@dxos/log';
-import { CircularBuffer, getDebugName } from '@dxos/util';
-
-import { captureException, captureMessage, withScope } from './node';
-
-const MAX_LOG_BREADCRUMBS = 150;
-
-export class SentryLogProcessor {
-  private _breadcrumbs = new CircularBuffer<Breadcrumb>(MAX_LOG_BREADCRUMBS);
-
-  public readonly logProcessor: LogProcessor = (config: LogConfig, entry: LogEntry) => {
-    const { level, meta, error } = entry;
-    // Don't forward logs from remote sessions.
-    if (!shouldLog(entry, config.captureFilters) || meta?.S?.remoteSessionId) {
-      if (entry.level > LogLevel.DEBUG) {
-        this._addBreadcrumb(
-          undefined,
-          entry.message ?? (entry.error ? (entry.error.message ?? String(entry.error)) : ''),
-          convertLevel(entry.level),
-          undefined,
-        );
-      }
-      return;
-    }
-    if (entry.level !== LogLevel.WARN && entry.level !== LogLevel.ERROR) {
-      return;
-    }
-
-    // TODO(nf): add rate limiting to avoid spamming Sentry/consuming excessive quota.
-    withScope((scope) => {
-      const severity = convertLevel(level);
-      scope.setLevel(severity);
-      scope.setContext('dxoslog', entry.context ?? null);
-      if (meta) {
-        scope.setTag('transaction', `${getRelativeFilename(meta.F)}:${meta.L}`);
-
-        if (meta.S?.hostSessionId) {
-          scope.setTags({
-            service_host_issue: true,
-            service_host_session: meta.S?.hostSessionId,
-          });
-        }
-
-        if (!Number.isNaN(meta.S?.uptimeSeconds)) {
-          scope.setExtra('uptime_seconds', meta.S?.uptimeSeconds);
-        }
-      }
-
-      const extendedMessage = formatMessageForSentry(entry);
-      let capturedError = error;
-      if (capturedError == null && entry.level === LogLevel.ERROR) {
-        capturedError = Object.values(entry.context ?? {}).find((v): v is Error => v instanceof Error);
-      }
-      if (capturedError) {
-        if (capturedError instanceof InvariantViolation) {
-          scope.setExtra('invariant_violation', true);
-        }
-        const isMessageDifferentFromStackTrace = error == null;
-        if (isMessageDifferentFromStackTrace) {
-          scope.setExtra('message', extendedMessage);
-        }
-        const eventId = captureException(capturedError);
-        this._addBreadcrumb(eventId, extendedMessage, severity, entry.context);
-        return;
-      }
-
-      const message = entry.message ?? (entry.error ? (entry.error.message ?? String(entry.error)) : '');
-      scope.setFingerprint([message]);
-      const eventId = captureMessage(extendedMessage);
-      this._addBreadcrumb(eventId, extendedMessage, severity, entry.context);
-    });
-  };
-
-  public addLogBreadcrumbsTo(event: Event): void {
-    event.breadcrumbs ??= [];
-    for (const breadcrumb of this._breadcrumbs) {
-      event.breadcrumbs.push(breadcrumb);
-    }
-    event.breadcrumbs.sort((b1, b2) => {
-      if (b1.timestamp === undefined || b2.timestamp === undefined) {
-        return b1.timestamp === b2.timestamp ? 0 : b1.timestamp === undefined ? -1 : 1;
-      }
-      return b1.timestamp - b2.timestamp;
-    });
-  }
-
-  private _addBreadcrumb(
-    eventId: string | undefined,
-    message: string,
-    severity: SeverityLevel,
-    context: { [key: string]: any } | undefined,
-  ): void {
-    const breadcrumb: Breadcrumb = {
-      type: 'console',
-      level: severity,
-      event_id: eventId,
-      category: 'log',
-      message,
-      data: context,
-      timestamp: Math.floor(Date.now() / 1000),
-    };
-    const lastRecorded = this._breadcrumbs.getLast();
-    if (lastRecorded && lastRecorded.message === breadcrumb.message) {
-      const firstBreadcrumbData = lastRecorded.data?.firstBreadcrumbData ?? lastRecorded.data ?? {};
-      const mergedBreadcrumbCount = Number.isNaN(lastRecorded.data?.mergedBreadcrumbCount)
-        ? 1
-        : Number(lastRecorded.data?.mergedBreadcrumbCount);
-      lastRecorded.data = {
-        mergedBreadcrumbCount: mergedBreadcrumbCount + 1,
-        firstBreadcrumbData,
-        lastBreadcrumbData: breadcrumb.data,
-      };
-      return;
-    }
-    this._breadcrumbs.push(breadcrumb);
-  }
-}
-
-const formatMessageForSentry = (entry: LogEntry): string => {
-  const message = entry.message ?? (entry.error ? (entry.error.message ?? String(entry.error)) : '');
-
-  let scopePrefix: string | undefined;
-  if (entry.meta?.S) {
-    const scope = entry.meta?.S;
-    scopePrefix = scope.name || getDebugName(scope);
-  }
-  if (scopePrefix == null) {
-    return message;
-  }
-
-  const workerPrefix = entry.meta?.S?.hostSessionId ? '[worker] ' : '';
-  return `${workerPrefix}${scopePrefix} ${message}`;
-};
-
-const convertLevel = (level: LogLevel): SeverityLevel => {
-  switch (level) {
-    case LogLevel.ERROR:
-      return 'error';
-    case LogLevel.VERBOSE:
-      return 'info';
-    case LogLevel.INFO:
-      return 'info';
-    case LogLevel.WARN:
-      return 'warning';
-    case LogLevel.DEBUG:
-    case LogLevel.TRACE:
-      return 'debug';
-    default:
-      throw never(level);
-  }
-};
-
-const never = (_: never) => {
-  return new Error('unhandled value');
-};
-
-const getRelativeFilename = (filename: string) => {
-  // TODO(burdon): Hack uses "packages" as an anchor (pre-parse NX?)
-  // Including `packages/` part of the path so that excluded paths (e.g. from dist) are clickable in vscode.
-  const match = filename.match(/.+\/(packages\/.+\/.+)/);
-  if (match) {
-    const [, filePath] = match;
-    return filePath;
-  }
-
-  return filename;
-};

package/src/sentry/sentry.node.test.ts

@@ -1,35 +0,0 @@
-//
-// Copyright 2022 DXOS.org
-//
-
-import { beforeAll, beforeEach, describe, expect, test } from 'vitest';
-
-import { sentryTestkit } from '../testing';
-
-import * as Sentry from './node';
-
-const { testkit, sentryTransport } = sentryTestkit();
-
-const MOCK_DESTINATION = 'https://acacaeaccacacacabcaacdacdacadaca@sentry.io/000001';
-
-describe('Error reporting', () => {
-  beforeAll(() => {
-    Sentry.init({
-      destination: MOCK_DESTINATION,
-      release: 'test',
-      transport: sentryTransport,
-    });
-  });
-
-  beforeEach(() => {
-    testkit.reset();
-  });
-
-  test('should capture errors', async () => {
-    const err = new Error('error to look for');
-    Sentry.captureException(err);
-    await expect.poll(() => testkit.reports()).toHaveLength(1);
-    const report = testkit.findReport(err);
-    expect(report).to.exist;
-  });
-});

package/src/sentry/types.ts

@@ -1,22 +0,0 @@
-//
-// Copyright 2022 DXOS.org
-//
-
-import type { Event, Transport } from '@sentry/types';
-
-export type InitOptions = {
-  enable?: boolean;
-  destination?: string;
-  installationId?: string;
-  release?: string;
-  environment?: string;
-  tracing?: boolean;
-  sampleRate?: number;
-  replay?: boolean;
-  replaySampleRate?: number;
-  replaySampleRateOnError?: number;
-  scrubFilenames?: boolean;
-  properties?: object;
-  transport?: () => Transport;
-  onError?: (event: Event) => void;
-};

package/src/testing/index.ts

@@ -1,5 +0,0 @@
-//
-// Copyright 2022 DXOS.org
-//
-
-export * from './testkit';

package/src/testing/testkit/browser.ts

@@ -1,8 +0,0 @@
-//
-// Copyright 2022 DXOS.org
-//
-
-// eslint-disable-next-line no-restricted-imports
-import testkit from 'sentry-testkit/dist/browser';
-
-export const sentryTestkit = testkit;

package/src/testing/testkit/index.ts

@@ -1,7 +0,0 @@
-//
-// Copyright 2022 DXOS.org
-//
-
-import testkit from 'sentry-testkit';
-
-export const sentryTestkit = testkit;

package/src/testing/testkit/shims.d.ts

@@ -1,5 +0,0 @@
-//
-// Copyright 2022 DXOS.org
-//
-
-declare module 'sentry-testkit/dist/browser';