switch to log container envelope

Author: AbhiPrasad

packages/core/src/index.ts

@@ -323,8 +323,6 @@ export type {
   ProfileChunkItem,
   SpanEnvelope,
   SpanItem,
-  OtelLogEnvelope,
-  OtelLogItem,
 } from './types-hoist/envelope';
 export type { ExtendedError } from './types-hoist/error';
 export type { Event, EventHint, EventType, ErrorEvent, TransactionEvent } from './types-hoist/event';
@@ -385,13 +383,7 @@ export type {
   TraceFlag,
 } from './types-hoist/span';
 export type { SpanStatus } from './types-hoist/spanStatus';
-export type {
-  Log,
-  LogSeverityLevel,
-  SerializedOtelLog,
-  SerializedLogAttribute,
-  SerializedLogAttributeValueType,
-} from './types-hoist/log';
+export type { Log, LogSeverityLevel } from './types-hoist/log';
 export type { TimedEvent } from './types-hoist/timedEvent';
 export type { StackFrame } from './types-hoist/stackframe';
 export type { Stacktrace, StackParser, StackLineParser, StackLineParserFn } from './types-hoist/stacktrace';

packages/core/src/logs/envelope.ts

@@ -1,41 +1,47 @@
 import type { DsnComponents } from '../types-hoist/dsn';
 import type { SdkMetadata } from '../types-hoist/sdkmetadata';
-import type { SerializedOtelLog } from '../types-hoist/log';
-import type { OtelLogEnvelope, OtelLogItem } from '../types-hoist/envelope';
+import type { SerializedLog } from '../types-hoist/log';
+import type { LogContainerItem, LogEnvelope } from '../types-hoist/envelope';
 import { dsnToString } from '../utils-hoist/dsn';
 import { createEnvelope } from '../utils-hoist/envelope';
 
 /**
- * Creates OTEL log envelope item for a serialized OTEL log.
+ * Creates a log container envelope item for a list of logs.
  *
- * @param log - The serialized OTEL log to include in the envelope.
- * @returns The created OTEL log envelope item.
+ * @param items - The logs to include in the envelope.
+ * @returns The created log container envelope item.
  */
-export function createOtelLogEnvelopeItem(log: SerializedOtelLog): OtelLogItem {
+export function createLogContainerEnvelopeItem(items: Array<SerializedLog>): LogContainerItem {
   return [
     {
-      type: 'otel_log',
+      type: 'log',
+      item_count: items.length,
+      content_type: 'application/vnd.sentry.items.log+json',
+    },
+    {
+      items,
     },
-    log,
   ];
 }
 
 /**
  * Creates an envelope for a list of logs.
  *
+ * Logs from multiple traces can be included in the same envelope.
+ *
  * @param logs - The logs to include in the envelope.
  * @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.
  * @returns The created envelope.
  */
-export function createOtelLogEnvelope(
-  logs: Array<SerializedOtelLog>,
+export function createLogEnvelope(
+  logs: Array<SerializedLog>,
   metadata?: SdkMetadata,
   tunnel?: string,
   dsn?: DsnComponents,
-): OtelLogEnvelope {
-  const headers: OtelLogEnvelope[0] = {};
+): LogEnvelope {
+  const headers: LogEnvelope[0] = {};
 
   if (metadata?.sdk) {
     headers.sdk = {
@@ -48,5 +54,5 @@ export function createOtelLogEnvelope(
     headers.dsn = dsnToString(dsn);
   }
 
-  return createEnvelope<OtelLogEnvelope>(headers, logs.map(createOtelLogEnvelopeItem));
+  return createEnvelope<LogEnvelope>(headers, [createLogContainerEnvelopeItem(logs)]);
 }

packages/core/src/logs/exports.ts

@@ -1,18 +1,20 @@
 import type { Client } from '../client';
+import type { SerializedLog, SerializedLogAttributeValue } from '../types-hoist/log';
+import type { Log } from '../types-hoist/log';
+
 import { _getTraceInfoFromScope } from '../client';
 import { getClient, getCurrentScope } from '../currentScopes';
 import { DEBUG_BUILD } from '../debug-build';
 import { SEVERITY_TEXT_TO_SEVERITY_NUMBER } from './constants';
-import type { SerializedLogAttribute, SerializedOtelLog } from '../types-hoist/log';
-import type { Log } from '../types-hoist/log';
 import { _getSpanForScope } from '../utils/spanOnScope';
-import { createOtelLogEnvelope } from './envelope';
+import { createLogEnvelope } from './envelope';
 import { logger } from '../utils-hoist/logger';
 import { isParameterizedString } from '../utils-hoist/is';
+import { timestampInSeconds } from '../utils-hoist/time';
 
 const MAX_LOG_BUFFER_SIZE = 100;
 
-const CLIENT_TO_LOG_BUFFER_MAP = new WeakMap<Client, Array<SerializedOtelLog>>();
+const CLIENT_TO_LOG_BUFFER_MAP = new WeakMap<Client, Array<SerializedLog>>();
 
 /**
  * Converts a log attribute to a serialized log attribute.
@@ -21,22 +23,28 @@ const CLIENT_TO_LOG_BUFFER_MAP = new WeakMap<Client, Array<SerializedOtelLog>>()
  * @param value - The value of the log attribute.
  * @returns The serialized log attribute.
  */
-export function logAttributeToSerializedLogAttribute(key: string, value: unknown): SerializedLogAttribute {
+export function logAttributeToSerializedLogAttribute(value: unknown): SerializedLogAttributeValue {
   switch (typeof value) {
     case 'number':
+      if (Number.isInteger(value)) {
+        return {
+          value,
+          type: 'integer',
+        };
+      }
       return {
-        key,
-        value: { doubleValue: value },
+        value,
+        type: 'double',
       };
     case 'boolean':
       return {
-        key,
-        value: { boolValue: value },
+        value,
+        type: 'boolean',
       };
     case 'string':
       return {
-        key,
-        value: { stringValue: value },
+        value,
+        type: 'string',
       };
     default: {
       let stringValue = '';
@@ -46,8 +54,8 @@ export function logAttributeToSerializedLogAttribute(key: string, value: unknown
         // Do nothing
       }
       return {
-        key,
-        value: { stringValue },
+        value: stringValue,
+        type: 'string',
       };
     }
   }
@@ -128,15 +136,19 @@ export function _INTERNAL_captureLog(
 
   const { level, message, attributes = {}, severityNumber } = log;
 
-  const serializedLog: SerializedOtelLog = {
-    severityText: level,
-    body: {
-      stringValue: message,
-    },
-    attributes: Object.entries(attributes).map(([key, value]) => logAttributeToSerializedLogAttribute(key, value)),
-    timeUnixNano: `${new Date().getTime().toString()}000000`,
-    traceId: traceContext?.trace_id,
-    severityNumber: severityNumber ?? SEVERITY_TEXT_TO_SEVERITY_NUMBER[level],
+  const serializedLog: SerializedLog = {
+    timestamp: timestampInSeconds(),
+    level,
+    body: message,
+    trace_id: traceContext?.trace_id,
+    severity_number: severityNumber ?? SEVERITY_TEXT_TO_SEVERITY_NUMBER[level],
+    attributes: Object.keys(attributes).reduce(
+      (acc, key) => {
+        acc[key] = logAttributeToSerializedLogAttribute(attributes[key]);
+        return acc;
+      },
+      {} as Record<string, SerializedLogAttributeValue>,
+    ),
   };
 
   const logBuffer = CLIENT_TO_LOG_BUFFER_MAP.get(client);
@@ -161,14 +173,14 @@ export function _INTERNAL_captureLog(
  * @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.
  */
-export function _INTERNAL_flushLogsBuffer(client: Client, maybeLogBuffer?: Array<SerializedOtelLog>): void {
+export function _INTERNAL_flushLogsBuffer(client: Client, maybeLogBuffer?: Array<SerializedLog>): void {
   const logBuffer = maybeLogBuffer ?? CLIENT_TO_LOG_BUFFER_MAP.get(client) ?? [];
   if (logBuffer.length === 0) {
     return;
   }
 
   const clientOptions = client.getOptions();
-  const envelope = createOtelLogEnvelope(logBuffer, clientOptions._metadata, clientOptions.tunnel, client.getDsn());
+  const envelope = createLogEnvelope(logBuffer, clientOptions._metadata, clientOptions.tunnel, client.getDsn());
 
   // Clear the log buffer after envelopes have been constructed.
   logBuffer.length = 0;
@@ -188,6 +200,6 @@ export function _INTERNAL_flushLogsBuffer(client: Client, maybeLogBuffer?: Array
  * @param client - The client to get the log buffer for.
  * @returns The log buffer for the given client.
  */
-export function _INTERNAL_getLogBuffer(client: Client): Array<SerializedOtelLog> | undefined {
+export function _INTERNAL_getLogBuffer(client: Client): Array<SerializedLog> | undefined {
   return CLIENT_TO_LOG_BUFFER_MAP.get(client);
 }

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

@@ -5,7 +5,7 @@ import type { LegacyCSPReport } from './csp';
 import type { DsnComponents } from './dsn';
 import type { Event } from './event';
 import type { FeedbackEvent, UserFeedback } from './feedback';
-import type { SerializedOtelLog } from './log';
+import type { SerializedLogContainer } from './log';
 import type { Profile, ProfileChunk } from './profiling';
 import type { ReplayEvent, ReplayRecordingData } from './replay';
 import type { SdkInfo } from './sdkinfo';
@@ -44,7 +44,7 @@ export type EnvelopeItemType =
   | 'replay_recording'
   | 'check_in'
   | 'span'
-  | 'otel_log'
+  | 'log'
   | 'raw_security';
 
 export type BaseEnvelopeHeaders = {
@@ -87,7 +87,17 @@ type CheckInItemHeaders = { type: 'check_in' };
 type ProfileItemHeaders = { type: 'profile' };
 type ProfileChunkItemHeaders = { type: 'profile_chunk' };
 type SpanItemHeaders = { type: 'span' };
-type OtelLogItemHeaders = { type: 'otel_log' };
+type LogContainerItemHeaders = {
+  type: 'log';
+  /**
+   * The number of log items in the container. This must be the same as the number of log items in the payload.
+   */
+  item_count: number;
+  /**
+   * The content type of the log items. This must be `application/vnd.sentry.items.log+json`.
+   */
+  content_type: 'application/vnd.sentry.items.log+json';
+};
 type RawSecurityHeaders = { type: 'raw_security'; sentry_release?: string; sentry_environment?: string };
 
 export type EventItem = BaseEnvelopeItem<EventItemHeaders, Event>;
@@ -104,7 +114,7 @@ export type FeedbackItem = BaseEnvelopeItem<FeedbackItemHeaders, FeedbackEvent>;
 export type ProfileItem = BaseEnvelopeItem<ProfileItemHeaders, Profile>;
 export type ProfileChunkItem = BaseEnvelopeItem<ProfileChunkItemHeaders, ProfileChunk>;
 export type SpanItem = BaseEnvelopeItem<SpanItemHeaders, Partial<SpanJSON>>;
-export type OtelLogItem = BaseEnvelopeItem<OtelLogItemHeaders, SerializedOtelLog>;
+export type LogContainerItem = BaseEnvelopeItem<LogContainerItemHeaders, SerializedLogContainer>;
 export type RawSecurityItem = BaseEnvelopeItem<RawSecurityHeaders, LegacyCSPReport>;
 
 export type EventEnvelopeHeaders = { event_id: string; sent_at: string; trace?: Partial<DynamicSamplingContext> };
@@ -113,8 +123,7 @@ type CheckInEnvelopeHeaders = { trace?: DynamicSamplingContext };
 type ClientReportEnvelopeHeaders = BaseEnvelopeHeaders;
 type ReplayEnvelopeHeaders = BaseEnvelopeHeaders;
 type SpanEnvelopeHeaders = BaseEnvelopeHeaders & { trace?: DynamicSamplingContext };
-type OtelLogEnvelopeHeaders = BaseEnvelopeHeaders & { trace?: DynamicSamplingContext };
-
+type LogEnvelopeHeaders = BaseEnvelopeHeaders;
 export type EventEnvelope = BaseEnvelope<
   EventEnvelopeHeaders,
   EventItem | AttachmentItem | UserFeedbackItem | FeedbackItem | ProfileItem
@@ -126,7 +135,7 @@ export type CheckInEnvelope = BaseEnvelope<CheckInEnvelopeHeaders, CheckInItem>;
 export type SpanEnvelope = BaseEnvelope<SpanEnvelopeHeaders, SpanItem>;
 export type ProfileChunkEnvelope = BaseEnvelope<BaseEnvelopeHeaders, ProfileChunkItem>;
 export type RawSecurityEnvelope = BaseEnvelope<BaseEnvelopeHeaders, RawSecurityItem>;
-export type OtelLogEnvelope = BaseEnvelope<OtelLogEnvelopeHeaders, OtelLogItem>;
+export type LogEnvelope = BaseEnvelope<LogEnvelopeHeaders, LogContainerItem>;
 
 export type Envelope =
   | EventEnvelope
@@ -137,6 +146,5 @@ export type Envelope =
   | CheckInEnvelope
   | SpanEnvelope
   | RawSecurityEnvelope
-  | OtelLogEnvelope;
-
+  | LogEnvelope;
 export type EnvelopeItem = Envelope[1][number];