fix(span): Make _performance_issues_spans a top-level field by jjbayer · Pull Request #5870 · getsentry/relay

jjbayer · 2026-04-21T14:03:57Z

sentry expects it as a top-level field, see https://github.com/getsentry/sentry/blob/70b3082b692723d5f7a561659b41274c2076bd38/src/sentry/spans/consumers/process_segments/message.py#L290.
It is a temporary and internal feature flag that we do not want to document in sentry-conventions.

cursor

Cursor Bugbot has reviewed your changes and found 1 potential issue.

^{❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.}

^{Reviewed by Cursor Bugbot for commit 03ee6f7. Configure here.}

Consolidate performance issues spans and remove deprecated config.

Dav1dde · 2026-04-22T07:02:11Z

+        skip_serialization = "empty",
+        trim = false
+    )]
+    pub performance_issues_spans: Annotated<bool>,


Why does this need to be top level and not an attribute (what it already is)? Can we instead change the consumer code?

I feel like this may set a bad precedent where we start adding things top level.

It can be. Then we need to define it in conventions and adjust the consuming code accordingly.

It's using an _internal attribute right now, we decided not to define these in conventions.

That being said, _internal is also not the best option here, but I think it's fine if we tackle this separately (or not at all considering there is a plan to remove it alltogether)

jjbayer · 2026-04-23T11:32:59Z

I will check if we can easily make this part of SpanMeta (i.e. extra fields that are injected into the kafka message), then it is no longer part of the protocol.

elramen · 2026-04-28T08:27:18Z

+    /// When the flag is set to true, performance issues will be detected on this span provided it
+    /// is a root (segment) instead of the transaction event.
+    ///
+    /// Only set on root spans extracted from transactions.


Suggested change

/// When the flag is set to true, performance issues will be detected on this span provided it

/// is a root (segment) instead of the transaction event.

///

/// Only set on root spans extracted from transactions.

/// By default, performance issues are detected on transactions. When this flag is

/// `true` and the span is a segment (root) span, detection runs on this span instead — this

/// lets Sentry migrate detection from the legacy transaction-event pipeline to the new

/// standalone-spans (EAP) pipeline without double-reporting issues.

///

/// This flag is only meaningful on segment (root) spans that originated from a transaction event.

Found the original phrasing ambiguous, but maybe I just lack context

elramen · 2026-04-28T08:29:19Z

+    ///
+    /// Only set on root spans extracted from transactions.
+    #[metastructure(
+        field = "_performance_issues_spans",


Should a top level field be underscored?

linear-code · 2026-04-28T08:30:38Z

INGEST-879 Fix flag _performance_issues_spans

Lift the temporary `_performance_issues_spans` flag out of the SpanV2 protocol body and onto the Kafka envelope (`SpanMeta`). The on-the-wire JSON key is unchanged because `SpanMeta` and the span body are flattened into the same object. The legacy V1 path reads the value off `SpanV1` before conversion and forwards it on `StoreSpanV2`; the native V2 path hardcodes false (it never sets this flag). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

jjbayer · 2026-04-28T08:46:00Z

        routing_key,
        retention_days: ctx.retention.standard,
        downsampled_retention_days: ctx.retention.downsampled,
+        performance_issues_spans: false,


Suggested change

performance_issues_spans: false,

performance_issues_spans: false, // only used for legacy spans

jjbayer · 2026-04-28T08:46:14Z

+    ///
+    /// Travels on the Kafka envelope (`SpanMeta`) rather than the SpanV2 body.


Suggested change

///

/// Travels on the Kafka envelope (`SpanMeta`) rather than the SpanV2 body.

jjbayer · 2026-04-28T08:47:26Z

+    /// When the flag is set to true, performance issues will be detected on this span provided it
+    /// is a root (segment) instead of the transaction event.


Suggested change

/// When the flag is set to true, performance issues will be detected on this span provided it

/// is a root (segment) instead of the transaction event.

/// When the flag is set to true, performance issues will be detected on this span

/// instead of the transaction event (provided it is a segment span).

jjbayer · 2026-04-28T08:48:39Z

        was_transaction,
        kind,
-        performance_issues_spans,
+        performance_issues_spans: _, // moved to SpanMeta on the Kafka envelope


Suggested change

performance_issues_spans: _, // moved to SpanMeta on the Kafka envelope

performance_issues_spans: _, // not part of the V2 protocol (but still used by `legacy_spans::store::convert`).

jjbayer · 2026-04-28T08:49:09Z

 - Retry failing objectstore requests. ([#5836](https://github.com/getsentry/relay/pull/5836))
 - Add mobile normalizations to SpanV2 processing pipeline (mobile tag, main thread, outlier filtering, app start backfill from V1 transactions, device class). ([#5824](https://github.com/getsentry/relay/pull/5824))
 - Remove the deprecated `aiModelCosts` global config, superseded by `aiModelMetadata`. ([#5862](https://github.com/getsentry/relay/pull/5862))
+- Make `_performance_issues_spans` a top-level field. ([#5870](https://github.com/getsentry/relay/pull/5870))


Suggested change

- Make `_performance_issues_spans` a top-level field. ([#5870](https://github.com/getsentry/relay/pull/5870))

- Make `_performance_issues_spans` a top-level field on the Kafka message. ([#5870](https://github.com/getsentry/relay/pull/5870))

fix(span): Make a top-level field

1504eda

jjbayer requested a review from loewenheim April 21, 2026 14:04

test

2c662d0

jjbayer marked this pull request as ready for review April 21, 2026 15:13

jjbayer requested a review from a team as a code owner April 21, 2026 15:13

jjbayer added 2 commits April 21, 2026 17:29

changelog

0903f1d

Merge branch 'master' into fix/performance-issues-span

03ee6f7

cursor Bot reviewed Apr 21, 2026

View reviewed changes

Comment thread CHANGELOG.md Outdated

Update CHANGELOG with recent changes and fixes

9e40ff6

Consolidate performance issues spans and remove deprecated config.

loewenheim approved these changes Apr 22, 2026

View reviewed changes

loewenheim requested a review from Dav1dde April 22, 2026 06:53

Dav1dde requested changes Apr 22, 2026

View reviewed changes

Dav1dde assigned jjbayer Apr 24, 2026

elramen approved these changes Apr 28, 2026

View reviewed changes

jjbayer marked this pull request as draft April 28, 2026 08:36

jjbayer commented Apr 28, 2026

View reviewed changes

-    /// When the flag is set to true, performance issues will be detected on this span provided it
-    /// is a root (segment) instead of the transaction event.
-    ///
-    /// Only set on root spans extracted from transactions.
+    /// By default, performance issues are detected on transactions. When this flag is
+    /// `true` and the span is a segment (root) span, detection runs on this span instead — this
+    /// lets Sentry migrate detection from the legacy transaction-event pipeline to the new
+    /// standalone-spans (EAP) pipeline without double-reporting issues.
+    ///
+    /// This flag is only meaningful on segment (root) spans that originated from a transaction event.

	performance_issues_spans: false,
	performance_issues_spans: false, // only used for legacy spans

		///
		/// Travels on the Kafka envelope (`SpanMeta`) rather than the SpanV2 body.

		/// When the flag is set to true, performance issues will be detected on this span provided it
		/// is a root (segment) instead of the transaction event.

	performance_issues_spans: _, // moved to SpanMeta on the Kafka envelope
	performance_issues_spans: _, // not part of the V2 protocol (but still used by `legacy_spans::store::convert`).

	- Make `_performance_issues_spans` a top-level field. ([#5870](https://github.com/getsentry/relay/pull/5870))
	- Make `_performance_issues_spans` a top-level field on the Kafka message. ([#5870](https://github.com/getsentry/relay/pull/5870))

Conversation

jjbayer commented Apr 21, 2026

Uh oh!

cursor Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jjbayer commented Apr 23, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

linear-code Bot commented Apr 28, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants