add ingest settings to log envelope payload

Author: nicohrubec

dev-packages/browser-integration-tests/suites/public-api/logger/simple/test.ts

@@ -23,6 +23,8 @@ sentryTest('should capture all logging methods', async ({ getLocalTestUrl, page
       content_type: 'application/vnd.sentry.items.log+json',
     },
     {
+      version: 2,
+      ingest_settings: { infer_ip: 'never', infer_useragent: 'never' },
       items: [
         {
           timestamp: expect.any(Number),

packages/core/src/logs/envelope.ts

@@ -4,21 +4,28 @@ import type { SerializedLog } from '../types-hoist/log';
 import type { SdkMetadata } from '../types-hoist/sdkmetadata';
 import { dsnToString } from '../utils/dsn';
 import { createEnvelope } from '../utils/envelope';
+import { isBrowser } from '../utils/isBrowser';
 
 /**
  * Creates a log container envelope item for a list of logs.
  *
  * @param items - The logs to include in the envelope.
+ * @param inferUserData - If true, tells Relay to infer the end-user IP and User-Agent from the incoming request.
  * @returns The created log container envelope item.
  */
-export function createLogContainerEnvelopeItem(items: Array<SerializedLog>): LogContainerItem {
+export function createLogContainerEnvelopeItem(items: Array<SerializedLog>, inferUserData?: boolean): LogContainerItem {
+  const inferSetting = inferUserData ? 'auto' : 'never';
   return [
     {
       type: 'log',
       item_count: items.length,
       content_type: 'application/vnd.sentry.items.log+json',
     },
     {
+      version: 2,
+      ...(isBrowser() && {
+        ingest_settings: { infer_ip: inferSetting, infer_useragent: inferSetting },
+      }),
       items,
     },
   ];
@@ -33,13 +40,15 @@ export function createLogContainerEnvelopeItem(items: Array<SerializedLog>): Log
  * @param metadata - The metadata to include in the envelope.
  * @param tunnel - The tunnel to include in the envelope.
  * @param dsn - The DSN to include in the envelope.
+ * @param inferUserData - If true, tells Relay to infer the end-user IP and User-Agent from the incoming request.
  * @returns The created envelope.
  */
 export function createLogEnvelope(
   logs: Array<SerializedLog>,
   metadata?: SdkMetadata,
   tunnel?: string,
   dsn?: DsnComponents,
+  inferUserData?: boolean,
 ): LogEnvelope {
   const headers: LogEnvelope[0] = {};
 
@@ -54,5 +63,5 @@ export function createLogEnvelope(
     headers.dsn = dsnToString(dsn);
   }
 
-  return createEnvelope<LogEnvelope>(headers, [createLogContainerEnvelopeItem(logs)]);
+  return createEnvelope<LogEnvelope>(headers, [createLogContainerEnvelopeItem(logs, inferUserData)]);
 }

packages/core/src/logs/internal.ts

@@ -192,7 +192,13 @@ export function _INTERNAL_flushLogsBuffer(client: Client, maybeLogBuffer?: Array
   }
 
   const clientOptions = client.getOptions();
-  const envelope = createLogEnvelope(logBuffer, clientOptions._metadata, clientOptions.tunnel, client.getDsn());
+  const envelope = createLogEnvelope(
+    logBuffer,
+    clientOptions._metadata,
+    clientOptions.tunnel,
+    client.getDsn(),
+    clientOptions.sendDefaultPii,
+  );
 
   // Clear the log buffer after envelopes have been constructed.
   _getBufferMap().set(client, []);

packages/core/src/types-hoist/log.ts

@@ -64,5 +64,10 @@ export interface SerializedLog {
 }
 
 export type SerializedLogContainer = {
+  version?: number;
+  ingest_settings?: {
+    infer_ip?: 'auto' | 'never';
+    infer_useragent?: 'auto' | 'never';
+  };
   items: Array<SerializedLog>;
 };

packages/core/test/lib/logs/envelope.test.ts

@@ -5,6 +5,7 @@ import type { SerializedLog } from '../../../src/types-hoist/log';
 import type { SdkMetadata } from '../../../src/types-hoist/sdkmetadata';
 import * as utilsDsn from '../../../src/utils/dsn';
 import * as utilsEnvelope from '../../../src/utils/envelope';
+import { isBrowser } from '../../../src/utils/isBrowser';
 
 // Mock utils functions
 vi.mock('../../../src/utils/dsn', () => ({
@@ -13,6 +14,13 @@ vi.mock('../../../src/utils/dsn', () => ({
 vi.mock('../../../src/utils/envelope', () => ({
   createEnvelope: vi.fn((_headers, items) => [_headers, items]),
 }));
+vi.mock('../../../src/utils/isBrowser', () => ({
+  isBrowser: vi.fn(() => false),
+}));
+
+afterEach(() => {
+  vi.mocked(isBrowser).mockReturnValue(false);
+});
 
 describe('createLogContainerEnvelopeItem', () => {
   it('creates an envelope item with correct structure', () => {
@@ -26,7 +34,58 @@ describe('createLogContainerEnvelopeItem', () => {
 
     expect(result).toHaveLength(2);
     expect(result[0]).toEqual({ type: 'log', item_count: 2, content_type: 'application/vnd.sentry.items.log+json' });
-    expect(result[1]).toEqual({ items: [mockLog, mockLog] });
+    expect(result[1]).toEqual({ version: 2, items: [mockLog, mockLog] });
+  });
+
+  it("includes ingest_settings with 'auto' values when in browser and sendDefaultPii is true", () => {
+    vi.mocked(isBrowser).mockReturnValue(true);
+
+    const mockLog: SerializedLog = {
+      timestamp: 1713859200,
+      level: 'info',
+      body: 'Test log message',
+    };
+
+    const result = createLogContainerEnvelopeItem([mockLog], true);
+
+    expect(result[1]).toEqual({
+      version: 2,
+      ingest_settings: { infer_ip: 'auto', infer_useragent: 'auto' },
+      items: [mockLog],
+    });
+  });
+
+  it("includes ingest_settings with 'never' values when in browser and sendDefaultPii is false", () => {
+    vi.mocked(isBrowser).mockReturnValue(true);
+
+    const mockLog: SerializedLog = {
+      timestamp: 1713859200,
+      level: 'info',
+      body: 'Test log message',
+    };
+
+    const result = createLogContainerEnvelopeItem([mockLog], false);
+
+    expect(result[1]).toEqual({
+      version: 2,
+      ingest_settings: { infer_ip: 'never', infer_useragent: 'never' },
+      items: [mockLog],
+    });
+  });
+
+  it('omits ingest_settings when not in browser', () => {
+    const mockLog: SerializedLog = {
+      timestamp: 1713859200,
+      level: 'info',
+      body: 'Test log message',
+    };
+
+    const result = createLogContainerEnvelopeItem([mockLog], true);
+
+    expect(result[1]).toEqual({
+      version: 2,
+      items: [mockLog],
+    });
   });
 });
 
@@ -133,7 +192,7 @@ describe('createLogEnvelope', () => {
       expect.arrayContaining([
         expect.arrayContaining([
           { type: 'log', item_count: 2, content_type: 'application/vnd.sentry.items.log+json' },
-          { items: mockLogs },
+          { version: 2, items: mockLogs },
         ]),
       ]),
     );