feat: Export logging methods for node/server-side SDKs

Author: AbhiPrasad

packages/astro/src/index.server.ts

@@ -127,6 +127,7 @@ export {
   withScope,
   zodErrorsIntegration,
   profiler,
+  _experiment_log,
 } from '@sentry/node';
 
 export { init } from './server/sdk';

packages/aws-serverless/src/index.ts

@@ -113,6 +113,7 @@ export {
   profiler,
   amqplibIntegration,
   vercelAIIntegration,
+  _experiment_log,
 } from '@sentry/node';
 
 export {

packages/bun/src/index.ts

@@ -132,6 +132,7 @@ export {
   profiler,
   amqplibIntegration,
   vercelAIIntegration,
+  _experiment_log,
 } from '@sentry/node';
 
 export {

packages/cloudflare/src/index.ts

@@ -85,6 +85,7 @@ export {
   spanToTraceHeader,
   spanToBaggageHeader,
   updateSpanName,
+  _experiment_log,
 } from '@sentry/core';
 
 export { withSentry } from './handler';

packages/core/src/exports.ts

@@ -12,7 +12,6 @@ import type {
   Extras,
   FinishedCheckIn,
   MonitorConfig,
-  ParameterizedString,
   Primitive,
   Session,
   SessionContext,
@@ -341,7 +340,7 @@ export function captureSession(end: boolean = false): void {
 /**
  * A namespace for experimental logging functions.
  *
- * @experimental Will be removed in future versions. Do not use.
+ * @experimental Will be removed in future versions. Use with caution.
  */
 export const _experiment_log = {
   /**

packages/core/src/log.ts

@@ -82,13 +82,24 @@ function valueToAttribute(key: string, value: unknown): LogAttribute {
   }
 }
 
+let hasRegisteredFlushHook = false;
+
 function addToLogBuffer(client: Client, log: Log, scope: Scope): void {
   function sendLogs(flushedLogs: Log[]): void {
     const envelope = createLogEnvelope(flushedLogs, client, scope);
     // eslint-disable-next-line @typescript-eslint/no-floating-promises
     void client.sendEnvelope(envelope);
   }
 
+  // Only register the hook once
+  if (!hasRegisteredFlushHook) {
+    client.on('flush', () => {
+      sendLogs(GLOBAL_LOG_BUFFER);
+      GLOBAL_LOG_BUFFER = [];
+    });
+    hasRegisteredFlushHook = true;
+  }
+
   if (GLOBAL_LOG_BUFFER.length >= LOG_BUFFER_MAX_LENGTH) {
     sendLogs(GLOBAL_LOG_BUFFER);
     GLOBAL_LOG_BUFFER = [];
@@ -99,12 +110,17 @@ function addToLogBuffer(client: Client, log: Log, scope: Scope): void {
   // this is the first time logs have been enabled, let's kick off an interval to flush them
   // we should only do this once.
   if (!isFlushingLogs) {
-    setInterval(() => {
+    const flushTimer = setInterval(() => {
       if (GLOBAL_LOG_BUFFER.length > 0) {
         sendLogs(GLOBAL_LOG_BUFFER);
         GLOBAL_LOG_BUFFER = [];
       }
     }, 5000);
+
+    // We need to unref the timer in node.js, otherwise the node process never exit.
+    if (typeof flushTimer !== 'number' && flushTimer.unref) {
+      flushTimer.unref();
+    }
   }
   isFlushingLogs = true;
 }

packages/deno/src/index.ts

@@ -83,6 +83,7 @@ export {
   spanToTraceHeader,
   spanToBaggageHeader,
   updateSpanName,
+  _experiment_log,
 } from '@sentry/core';
 
 export { DenoClient } from './client';

packages/google-cloud-serverless/src/index.ts

@@ -113,6 +113,7 @@ export {
   amqplibIntegration,
   childProcessIntegration,
   vercelAIIntegration,
+  _experiment_log,
 } from '@sentry/node';
 
 export {

packages/node/src/index.ts

@@ -130,6 +130,7 @@ export {
   updateSpanName,
   zodErrorsIntegration,
   profiler,
+  _experiment_log,
 } from '@sentry/core';
 
 export type {

packages/remix/src/server/index.ts

@@ -112,6 +112,7 @@ export {
   withMonitor,
   withScope,
   zodErrorsIntegration,
+  _experiment_log,
 } from '@sentry/node';
 
 // Keeping the `*` exports for backwards compatibility and types