feat: Show how to implement outside of client

Author: AbhiPrasad

packages/browser/src/client.ts

@@ -15,6 +15,7 @@ import {
   addAutoIpAddressToUser,
   applySdkMetadata,
   getSDKSource,
+  _INTERNAL_flushLogsBuffer,
 } from '@sentry/core';
 import { eventFromException, eventFromMessage } from './eventbuilder';
 import { WINDOW } from './helpers';
@@ -85,14 +86,21 @@ export class BrowserClient extends Client<BrowserClientOptions> {
       WINDOW.document.addEventListener('visibilitychange', () => {
         if (WINDOW.document.visibilityState === 'hidden') {
           this._flushOutcomes();
+          if (this._options._experiments?.enableLogs) {
+            _INTERNAL_flushLogsBuffer(this);
+          }
         }
       });
     }
 
     if (opts._experiments?.enableLogs) {
       setInterval(() => {
-        this._flushLogsBuffer();
+        _INTERNAL_flushLogsBuffer(this);
       }, 5000);
+
+      this.on('flush', () => {
+        _INTERNAL_flushLogsBuffer(this);
+      });
     }
 
     if (this._options.sendDefaultPii) {

packages/core/src/client.ts

@@ -63,13 +63,10 @@ import { parseSampleRate } from './utils/parseSampleRate';
 import { prepareEvent } from './utils/prepareEvent';
 import { showSpanDropWarning, spanToTraceContext } from './utils/spanUtils';
 import { convertSpanJsonToTransactionEvent, convertTransactionEventToSpanJson } from './utils/transactionEvent';
-import type { Log, SerializedOtelLog } from './types-hoist/log';
-import { SEVERITY_TEXT_TO_SEVERITY_NUMBER, createOtelLogEnvelope, logAttributeToSerializedLogAttribute } from './log';
 import { _getSpanForScope } from './utils/spanOnScope';
 
 const ALREADY_SEEN_ERROR = "Not capturing exception because it's already been captured.";
 const MISSING_RELEASE_FOR_SESSION_ERROR = 'Discarded session because of missing or non-string release';
-const MAX_LOG_BUFFER_SIZE = 100;
 
 /**
  * Base implementation for all JavaScript SDK clients.
@@ -125,8 +122,6 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
   // eslint-disable-next-line @typescript-eslint/ban-types
   private _hooks: Record<string, Function[]>;
 
-  private _logsBuffer: Array<SerializedOtelLog>;
-
   /**
    * Initializes this client instance.
    *
@@ -139,7 +134,6 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
     this._outcomes = {};
     this._hooks = {};
     this._eventProcessors = [];
-    this._logsBuffer = [];
 
     if (options.dsn) {
       this._dsn = makeDsn(options.dsn);
@@ -267,58 +261,6 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
    */
   public captureCheckIn?(checkIn: CheckIn, monitorConfig?: MonitorConfig, scope?: Scope): string;
 
-  /**
-   * Captures a log event and sends it to Sentry.
-   *
-   * @param log The log event to capture.
-   *
-   * @experimental This method will experience breaking changes. This is not yet part of
-   * the stable Sentry SDK API and can be changed or removed without warning.
-   */
-  public captureLog({ level, message, attributes, severityNumber }: Log, currentScope = getCurrentScope()): void {
-    const { _experiments, release, environment } = this.getOptions();
-    if (!_experiments?.enableLogs) {
-      DEBUG_BUILD && logger.warn('logging option not enabled, log will not be captured.');
-      return;
-    }
-
-    const [, traceContext] = _getTraceInfoFromScope(this, currentScope);
-
-    const logAttributes = {
-      ...attributes,
-    };
-
-    if (release) {
-      logAttributes.release = release;
-    }
-
-    if (environment) {
-      logAttributes.environment = environment;
-    }
-
-    const span = _getSpanForScope(currentScope);
-    if (span) {
-      // Add the parent span ID to the log attributes for trace context
-      logAttributes['sentry.trace.parent_span_id'] = span.spanContext().spanId;
-    }
-
-    const serializedLog: SerializedOtelLog = {
-      severityText: level,
-      body: {
-        stringValue: message,
-      },
-      attributes: Object.entries(logAttributes).map(([key, value]) => logAttributeToSerializedLogAttribute(key, value)),
-      timeUnixNano: `${new Date().getTime().toString()}000000`,
-      traceId: traceContext?.trace_id,
-      severityNumber: severityNumber ?? SEVERITY_TEXT_TO_SEVERITY_NUMBER[level],
-    };
-
-    this._logsBuffer.push(serializedLog);
-    if (this._logsBuffer.length > MAX_LOG_BUFFER_SIZE) {
-      this._flushLogsBuffer();
-    }
-  }
-
   /**
    * Get the current Dsn.
    */
@@ -358,7 +300,6 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
    * still events in the queue when the timeout is reached.
    */
   public flush(timeout?: number): PromiseLike<boolean> {
-    this._flushLogsBuffer();
     const transport = this._transport;
     if (transport) {
       this.emit('flush');
@@ -1200,21 +1141,6 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
     this.sendEnvelope(envelope);
   }
 
-  /**
-   * Flushes the logs buffer to Sentry.
-   */
-  protected _flushLogsBuffer(): void {
-    if (this._logsBuffer.length === 0) {
-      return;
-    }
-
-    const envelope = createOtelLogEnvelope(this._logsBuffer, this._options._metadata, this._options.tunnel, this._dsn);
-    this._logsBuffer = [];
-    // sendEnvelope should not throw
-    // eslint-disable-next-line @typescript-eslint/no-floating-promises
-    this.sendEnvelope(envelope);
-  }
-
   /**
    * Creates an {@link Event} from all inputs to `captureException` and non-primitive inputs to `captureMessage`.
    */

packages/core/src/index.ts

@@ -113,6 +113,7 @@ export { instrumentFetchRequest } from './fetch';
 export { trpcMiddleware } from './trpc';
 export { captureFeedback } from './feedback';
 export type { ReportDialogOptions } from './report-dialog';
+export { _INTERNAL_flushLogsBuffer } from './logs';
 
 // TODO: Make this structure pretty again and don't do "export *"
 export * from './utils-hoist/index';

packages/core/src/log.ts

@@ -0,0 +1,10 @@
+import type { LogSeverityLevel } from '../types-hoist';
+
+export const SEVERITY_TEXT_TO_SEVERITY_NUMBER: Partial<Record<LogSeverityLevel, number>> = {
+  trace: 1,
+  debug: 5,
+  info: 9,
+  warn: 13,
+  error: 17,
+  fatal: 21,
+};

packages/core/src/logs/constants.ts

@@ -0,0 +1,46 @@
+import { createEnvelope } from '../utils-hoist';
+
+import type { DsnComponents, SdkMetadata, SerializedOtelLog } from '../types-hoist';
+import type { OtelLogEnvelope, OtelLogItem } from '../types-hoist/envelope';
+import { dsnToString } from '../utils-hoist';
+
+/**
+ * Creates envelope item for a single log
+ */
+export function createOtelLogEnvelopeItem(log: SerializedOtelLog): OtelLogItem {
+  const headers: OtelLogItem[0] = {
+    type: 'otel_log',
+  };
+
+  return [headers, log];
+}
+
+/**
+ * Records a log and sends it to sentry.
+ *
+ * Logs represent a message (and optionally some structured data) which provide context for a trace or error.
+ * Ex: sentry.addLog({level: 'warning', message: `user ${user} just bought ${item}`, attributes: {user, item}}
+ *
+ * @params log - the log object which will be sent
+ */
+export function createOtelLogEnvelope(
+  logs: Array<SerializedOtelLog>,
+  metadata?: SdkMetadata,
+  tunnel?: string,
+  dsn?: DsnComponents,
+): OtelLogEnvelope {
+  const headers: OtelLogEnvelope[0] = {};
+
+  if (metadata?.sdk) {
+    headers.sdk = {
+      name: metadata.sdk.name,
+      version: metadata.sdk.version,
+    };
+  }
+
+  if (!!tunnel && !!dsn) {
+    headers.dsn = dsnToString(dsn);
+  }
+
+  return createEnvelope<OtelLogEnvelope>(headers, logs.map(createOtelLogEnvelopeItem));
+}