@sentry/core 10.31.0 → 10.32.0-alpha.0

package/build/types-ts3.8/types-hoist/envelope.d.ts

@@ -11,7 +11,7 @@ import { Profile, ProfileChunk } from './profiling';
 import { ReplayEvent, ReplayRecordingData } from './replay';
 import { SdkInfo } from './sdkinfo';
 import { SerializedSession, SessionAggregates } from './session';
-import { SpanJSON } from './span';
+import { SerializedSpanContainer, SpanJSON } from './span';
 export type DynamicSamplingContext = {
     trace_id: string;
     public_key: DsnComponents['publicKey'];
@@ -87,6 +87,21 @@ type ProfileChunkItemHeaders = {
 type SpanItemHeaders = {
     type: 'span';
 };
+type SpanContainerItemHeaders = {
+    /**
+     * Same as v1 span item type but this envelope is distinguished by {@link SpanContainerItemHeaders.content_type}.
+     */
+    type: 'span';
+    /**
+     * The number of span items in the container. This must be the same as the number of span items in the payload.
+     */
+    item_count: number;
+    /**
+     * The content type of the span items. This must be `application/vnd.sentry.items.span.v2+json`.
+     * (the presence of this field also distinguishes the span item from the v1 span item)
+     */
+    content_type: 'application/vnd.sentry.items.span.v2+json';
+};
 type LogContainerItemHeaders = {
     type: 'log';
     /**
@@ -120,6 +135,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 SpanContainerItem = BaseEnvelopeItem<SpanContainerItemHeaders, SerializedSpanContainer>;
 export type LogContainerItem = BaseEnvelopeItem<LogContainerItemHeaders, SerializedLogContainer>;
 export type MetricContainerItem = BaseEnvelopeItem<MetricContainerItemHeaders, SerializedMetricContainer>;
 export type RawSecurityItem = BaseEnvelopeItem<RawSecurityHeaders, LegacyCSPReport>;
@@ -139,6 +155,9 @@ type ReplayEnvelopeHeaders = BaseEnvelopeHeaders;
 type SpanEnvelopeHeaders = BaseEnvelopeHeaders & {
     trace?: DynamicSamplingContext;
 };
+type SpanV2EnvelopeHeaders = BaseEnvelopeHeaders & {
+    trace?: DynamicSamplingContext;
+};
 type LogEnvelopeHeaders = BaseEnvelopeHeaders;
 type MetricEnvelopeHeaders = BaseEnvelopeHeaders;
 export type EventEnvelope = BaseEnvelope<EventEnvelopeHeaders, EventItem | AttachmentItem | UserFeedbackItem | FeedbackItem | ProfileItem>;
@@ -153,11 +172,12 @@ export type ReplayEnvelope = [
 ];
 export type CheckInEnvelope = BaseEnvelope<CheckInEnvelopeHeaders, CheckInItem>;
 export type SpanEnvelope = BaseEnvelope<SpanEnvelopeHeaders, SpanItem>;
+export type SpanV2Envelope = BaseEnvelope<SpanV2EnvelopeHeaders, SpanContainerItem>;
 export type ProfileChunkEnvelope = BaseEnvelope<BaseEnvelopeHeaders, ProfileChunkItem>;
 export type RawSecurityEnvelope = BaseEnvelope<BaseEnvelopeHeaders, RawSecurityItem>;
 export type LogEnvelope = BaseEnvelope<LogEnvelopeHeaders, LogContainerItem>;
 export type MetricEnvelope = BaseEnvelope<MetricEnvelopeHeaders, MetricContainerItem>;
-export type Envelope = EventEnvelope | SessionEnvelope | ClientReportEnvelope | ProfileChunkEnvelope | ReplayEnvelope | CheckInEnvelope | SpanEnvelope | RawSecurityEnvelope | LogEnvelope | MetricEnvelope;
+export type Envelope = EventEnvelope | SessionEnvelope | ClientReportEnvelope | ProfileChunkEnvelope | ReplayEnvelope | CheckInEnvelope | SpanEnvelope | SpanV2Envelope | RawSecurityEnvelope | LogEnvelope | MetricEnvelope;
 export type EnvelopeItem = Envelope[1][number];
 export {};
 //# sourceMappingURL=envelope.d.ts.map

package/build/types-ts3.8/types-hoist/link.d.ts

@@ -19,11 +19,11 @@ export interface SpanLink {
  * Link interface for the event envelope item. It's a flattened representation of `SpanLink`.
  * Can include additional fields defined by OTel.
  */
-export interface SpanLinkJSON extends Record<string, unknown> {
+export interface SpanLinkJSON<TAttributes = SpanLinkAttributes> extends Record<string, unknown> {
     span_id: string;
     trace_id: string;
     sampled?: boolean;
-    attributes?: SpanLinkAttributes;
+    attributes?: TAttributes;
 }
 export {};
 //# sourceMappingURL=link.d.ts.map

package/build/types-ts3.8/types-hoist/options.d.ts

@@ -6,7 +6,7 @@ import { Log } from './log';
 import { Metric } from './metric';
 import { TracesSamplerSamplingContext } from './samplingcontext';
 import { SdkMetadata } from './sdkmetadata';
-import { SpanJSON } from './span';
+import { SpanJSON, SpanV2JSON } from './span';
 import { StackLineParser, StackParser } from './stacktrace';
 import { TracePropagationTargets } from './tracing';
 import { BaseTransportOptions, Transport } from './transport';
@@ -356,6 +356,15 @@ export interface ClientOptions<TO extends BaseTransportOptions = BaseTransportOp
      * @default false
      */
     strictTraceContinuation?: boolean;
+    /**
+     * [Experimental] The trace lifecycle, determining whether spans are sent statically when the entire local span tree is complete, or
+     * in batches, following interval- and action-based triggers.
+     *
+     * @experimental this option is currently still experimental and its type, name, or entire presence is subject to break and change at any time.
+     *
+     * @default 'static'
+     */
+    traceLifecycle?: 'static' | 'stream';
     /**
      * The organization ID for your Sentry project.
      *
@@ -432,7 +441,7 @@ export interface ClientOptions<TO extends BaseTransportOptions = BaseTransportOp
      *
      * @returns The modified span payload that will be sent.
      */
-    beforeSendSpan?: (span: SpanJSON) => SpanJSON;
+    beforeSendSpan?: ((span: SpanJSON) => SpanJSON) | SpanV2CompatibleBeforeSendSpanCallback;
     /**
      * An event-processing callback for transaction events, guaranteed to be invoked after all other event
      * processors. This allows an event to be modified or dropped before it's sent.
@@ -458,6 +467,13 @@ export interface ClientOptions<TO extends BaseTransportOptions = BaseTransportOp
      */
     beforeBreadcrumb?: (breadcrumb: Breadcrumb, hint?: BreadcrumbHint) => Breadcrumb | null;
 }
+/**
+ * A callback that is known to be compatible with actually receiving and returning a span v2 JSON object.
+ * Only useful in conjunction with the {@link CoreOptions.traceLifecycle} option.
+ */
+export type SpanV2CompatibleBeforeSendSpanCallback = ((span: SpanV2JSON) => SpanV2JSON) & {
+    _v2: true;
+};
 /** Base configuration options for every SDK. */
 export interface CoreOptions<TO extends BaseTransportOptions = BaseTransportOptions> extends Pick<Partial<ClientOptions<TO>>, Exclude<keyof Partial<ClientOptions<TO>>, 'integrations' | 'transport' | 'stackParser'>> {
     /**

package/build/types-ts3.8/types-hoist/span.d.ts

@@ -1,3 +1,4 @@
+import { TypedAttributes } from '../attributes';
 import { SpanLink, SpanLinkJSON } from './link';
 import { Measurements } from './measurement';
 import { HrTime } from './opentelemetry';
@@ -17,6 +18,32 @@ export type SpanAttributes = Partial<{
 }> & Record<string, SpanAttributeValue | undefined>;
 /** This type is aligned with the OpenTelemetry TimeInput type. */
 export type SpanTimeInput = HrTime | number | Date;
+/**
+ * JSON representation of a v2 span, as it should be sent to Sentry.
+ */
+export interface SpanV2JSON {
+    trace_id: string;
+    parent_span_id?: string;
+    span_id: string;
+    name: string;
+    start_timestamp: number;
+    end_timestamp: number;
+    status: 'ok' | 'error';
+    is_segment: boolean;
+    attributes?: TypedAttributes;
+    links?: SpanLinkJSON<TypedAttributes>[];
+}
+/**
+ * A SpanV2JSON with an attached reference to the segment span.
+ * This reference is used to compute dynamic sampling context before sending.
+ * The reference MUST be removed before sending the span envelope.
+ */
+export interface SpanV2JSONWithSegmentRef extends SpanV2JSON {
+    _segmentSpan: Span;
+}
+export type SerializedSpanContainer = {
+    items: Array<SpanV2JSON>;
+};
 /** A JSON representation of a span. */
 export interface SpanJSON {
     data: SpanAttributes;

package/build/types-ts3.8/utils/beforeSendSpan.d.ts

@@ -0,0 +1,22 @@
+import { ClientOptions, SpanV2CompatibleBeforeSendSpanCallback } from '../types-hoist/options';
+import { SpanV2JSON } from '../types-hoist/span';
+/**
+ * A wrapper to use the new span format in your `beforeSendSpan` callback.
+ *
+ * @example
+ *
+ * Sentry.init({
+ *   beforeSendSpan: withStreamSpan((span) => {
+ *     return span;
+ *   }),
+ * });
+ *
+ * @param callback
+ * @returns
+ */
+export declare function withStreamSpan(callback: (span: SpanV2JSON) => SpanV2JSON): SpanV2CompatibleBeforeSendSpanCallback;
+/**
+ * Typesafe check to identify the expected span json format of the `beforeSendSpan` callback.
+ */
+export declare function isV2BeforeSendSpanCallback(callback: ClientOptions['beforeSendSpan']): callback is SpanV2CompatibleBeforeSendSpanCallback;
+//# sourceMappingURL=beforeSendSpan.d.ts.map

package/build/types-ts3.8/utils/should-ignore-span.d.ts

@@ -1,12 +1,12 @@
 import { ClientOptions } from '../types-hoist/options';
-import { SpanJSON } from '../types-hoist/span';
+import { SpanJSON, SpanV2JSON } from '../types-hoist/span';
 /**
  * Check if a span should be ignored based on the ignoreSpans configuration.
  */
-export declare function shouldIgnoreSpan(span: Pick<SpanJSON, 'description' | 'op'>, ignoreSpans: Required<ClientOptions>['ignoreSpans']): boolean;
+export declare function shouldIgnoreSpan(span: Pick<SpanJSON, 'description' | 'op'> | Pick<SpanV2JSON, 'name' | 'attributes'>, ignoreSpans: Required<ClientOptions>['ignoreSpans']): boolean;
 /**
  * Takes a list of spans, and a span that was dropped, and re-parents the child spans of the dropped span to the parent of the dropped span, if possible.
  * This mutates the spans array in place!
  */
-export declare function reparentChildSpans(spans: SpanJSON[], dropSpan: SpanJSON): void;
+export declare function reparentChildSpans(spans: Pick<SpanV2JSON, 'parent_span_id' | 'span_id'>[], dropSpan: Pick<SpanV2JSON, 'parent_span_id' | 'span_id'>): void;
 //# sourceMappingURL=should-ignore-span.d.ts.map

package/build/types-ts3.8/utils/spanUtils.d.ts

@@ -1,6 +1,7 @@
+import { TypedAttributes } from '../attributes';
 import { TraceContext } from '../types-hoist/context';
 import { SpanLink, SpanLinkJSON } from '../types-hoist/link';
-import { Span, SpanAttributes, SpanJSON, SpanTimeInput } from '../types-hoist/span';
+import { Span, SpanAttributes, SpanJSON, SpanTimeInput, SpanV2JSON } from '../types-hoist/span';
 import { SpanStatus } from '../types-hoist/spanStatus';
 export declare const TRACE_FLAG_NONE = 0;
 export declare const TRACE_FLAG_SAMPLED = 1;
@@ -28,6 +29,12 @@ export declare function spanToTraceparentHeader(span: Span): string;
  *  If the links array is empty, it returns `undefined` so the empty value can be dropped before it's sent.
  */
 export declare function convertSpanLinksForEnvelope(links?: SpanLink[]): SpanLinkJSON[] | undefined;
+/**
+ *
+ * @param links
+ * @returns
+ */
+export declare function getV2SpanLinks(links?: SpanLink[]): SpanLinkJSON<TypedAttributes>[] | undefined;
 /**
  * Convert a span time input into a timestamp in seconds.
  */
@@ -36,6 +43,11 @@ export declare function spanTimeInputToSeconds(input: SpanTimeInput | undefined)
  * Convert a span to a JSON representation.
  */
 export declare function spanToJSON(span: Span): SpanJSON;
+/**
+ * Convert a span to a SpanV2JSON representation.
+ * @returns
+ */
+export declare function spanToV2JSON(span: Span): SpanV2JSON;
 /** Exported only for tests. */
 export interface OpenTelemetrySdkTraceBaseSpan extends Span {
     attributes: SpanAttributes;
@@ -55,6 +67,14 @@ export interface OpenTelemetrySdkTraceBaseSpan extends Span {
 export declare function spanIsSampled(span: Span): boolean;
 /** Get the status message to use for a JSON representation of a span. */
 export declare function getStatusMessage(status: SpanStatus | undefined): string | undefined;
+/**
+ * Convert the various statuses to the ones expected by Sentry ('ok' is default)
+ */
+export declare function getV2StatusMessage(status: SpanStatus | undefined): 'ok' | 'error';
+/**
+ * Convert the attributes to the ones expected by Sentry, including the type annotation
+ */
+export declare function getV2Attributes(attributes: SpanAttributes): TypedAttributes;
 declare const CHILD_SPANS_FIELD = "_sentryChildSpans";
 declare const ROOT_SPAN_FIELD = "_sentryRootSpan";
 type SpanWithPotentialChildren = Span & {
@@ -74,7 +94,11 @@ export declare function getSpanDescendants(span: SpanWithPotentialChildren): Spa
 /**
  * Returns the root span of a given span.
  */
-export declare function getRootSpan(span: SpanWithPotentialChildren): Span;
+export declare const getRootSpan: typeof INTERNAL_getSegmentSpan;
+/**
+ * Returns the segment span of a given span.
+ */
+export declare function INTERNAL_getSegmentSpan(span: SpanWithPotentialChildren): Span;
 /**
  * Returns the currently active span.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sentry/core",
-  "version": "10.31.0",
+  "version": "10.32.0-alpha.0",
   "description": "Base implementation for all Sentry JavaScript SDKs",
   "repository": "git://github.com/getsentry/sentry-javascript.git",
   "homepage": "https://github.com/getsentry/sentry-javascript/tree/master/packages/core",