fix(browser): Add ingest_settings to v2 log envelope payload (#20453)

Adds `version: 2` and `ingest_settings` to the log envelope payload so
Relay can infer the end-user IP address and User-Agent from the incoming
request ([link to
spec](https://develop.sentry.dev/sdk/telemetry/logs/#wire-format)). This
is only emitted by the browser SDK.

Both settings are currently gated behind `sendDefaultPii` (modeled after
how `event.sdk.settings.infer_ip`).

This slightly changes behavior in this case because we were always
inferring some user data on logs before (e.g. `browser.name/version`).
This data will not be there anymore after this change, unless
`sendDefaultPii` is enabled.

Closes #20277

Author: nicohrubec

CHANGELOG.md

@@ -4,6 +4,10 @@
 
 - "You miss 100 percent of the chances you don't take. — Wayne Gretzky" — Michael Scott
 
+- **feat(browser): Add `ingest_settings` to v2 log envelope payload ([#20453](https://github.com/getsentry/sentry-javascript/pull/20453))**
+
+  Inference of user data (e.g. IP address, browser name/version) on log events is now gated behind the `sendDefaultPii` option. Previously, this data was always inferred by default.
+
 ## 10.51.0
 
 ### Important Changes

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

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

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

@@ -22,6 +22,8 @@ sentryTest('captures logs with scope attributes', async ({ getLocalTestUrl, page
       content_type: 'application/vnd.sentry.items.log+json',
     },
     {
+      version: 2,
+      ingest_settings: { infer_ip: 'never', infer_user_agent: 'never' },
       items: [
         {
           timestamp: expect.any(Number),

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_user_agent: 'never' },
       items: [
         {
           timestamp: expect.any(Number),

dev-packages/node-core-integration-tests/suites/light-mode/logs/test.ts

@@ -11,6 +11,7 @@ describe('light mode logs', () => {
       .expect({
         log: logsContainer => {
           expect(logsContainer).toEqual({
+            version: 2,
             items: [
               {
                 attributes: {

dev-packages/node-core-integration-tests/suites/public-api/logs/test.ts

@@ -11,6 +11,7 @@ describe('logger public API', () => {
       .expect({
         log: logsContainer => {
           expect(logsContainer).toEqual({
+            version: 2,
             items: [
               {
                 attributes: {

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

@@ -39,6 +39,7 @@ describe('logs', () => {
       .expect({
         log: logsContainer => {
           expect(logsContainer).toEqual({
+            version: 2,
             items: [
               {
                 timestamp: expect.any(Number),

packages/core/src/logs/envelope.ts

@@ -4,21 +4,29 @@ 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.
+ *                        Only emitted as `ingest_settings` in browser environments.
  * @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_user_agent: inferSetting },
+      }),
       items,
     },
   ];
@@ -33,13 +41,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 +64,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_user_agent?: 'auto' | 'never';
+  };
   items: Array<SerializedLog>;
 };