Skip to content

Commit 9582f69

Browse files
authored
Merge pull request #6623 from getsentry/feat/4818-stack-overflow-truncation
fix(core): Preserve both ends of stack traces
2 parents 162664a + 3188dde commit 9582f69

5 files changed

Lines changed: 122 additions & 39 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,8 @@
127127

128128
### Improvements
129129

130+
- Preserve both ends of deep stack traces when truncating them ([#6623](https://github.com/getsentry/sentry-java/pull/6623))
131+
- Stack traces up to 250 frames remain complete. Longer traces retain the 50 oldest and 200 newest frames instead of only the 100 newest frames
130132
- Promote check-in APIs from experimental to stable ([#6422](https://github.com/getsentry/sentry-java/pull/6422))
131133
- Promote the backpressure handling option from experimental to stable ([#6423](https://github.com/getsentry/sentry-java/pull/6423))
132134
- Promote structured logs APIs from experimental to stable ([#6424](https://github.com/getsentry/sentry-java/pull/6424))

‎sentry/src/main/java/io/sentry/SentryStackTraceFactory.java‎

Lines changed: 48 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@
1313
@ApiStatus.Internal
1414
public final class SentryStackTraceFactory {
1515

16-
private static final int STACKTRACE_FRAME_LIMIT = 100;
16+
private static final int NEWEST_FRAMES_LIMIT = 200;
17+
private static final int OLDEST_FRAMES_LIMIT = 50;
1718
private final @NotNull SentryOptions options;
1819

1920
public SentryStackTraceFactory(final @NotNull SentryOptions options) {
@@ -32,45 +33,62 @@ public List<SentryStackFrame> getStackFrames(
3233
List<SentryStackFrame> sentryStackFrames = null;
3334

3435
if (elements != null && elements.length > 0) {
35-
sentryStackFrames = new ArrayList<>();
36-
for (StackTraceElement item : elements) {
37-
if (item != null) {
38-
39-
// we don't want to add our own frames
40-
final String className = item.getClassName();
41-
if (!includeSentryFrames
42-
&& (className.startsWith("io.sentry.")
43-
&& !className.startsWith("io.sentry.samples.")
44-
&& !className.startsWith("io.sentry.mobile."))) {
45-
continue;
46-
}
36+
int frameCount = 0;
37+
for (final StackTraceElement item : elements) {
38+
if (shouldIncludeFrame(item, includeSentryFrames)) {
39+
frameCount++;
40+
}
41+
}
4742

48-
final SentryStackFrame sentryStackFrame = new SentryStackFrame();
49-
// https://docs.sentry.io/development/sdk-dev/features/#in-app-frames
50-
sentryStackFrame.setInApp(isInApp(className));
51-
sentryStackFrame.setModule(className);
52-
sentryStackFrame.setFunction(item.getMethodName());
53-
sentryStackFrame.setFilename(item.getFileName());
54-
// Protocol doesn't accept negative line numbers.
55-
// The runtime seem to use -2 as a way to signal a native method
56-
if (item.getLineNumber() >= 0) {
57-
sentryStackFrame.setLineno(item.getLineNumber());
58-
}
59-
sentryStackFrame.setNative(item.isNativeMethod());
60-
sentryStackFrames.add(sentryStackFrame);
43+
sentryStackFrames =
44+
new ArrayList<>(Math.min(frameCount, NEWEST_FRAMES_LIMIT + OLDEST_FRAMES_LIMIT));
45+
int frameIndex = 0;
46+
for (final StackTraceElement item : elements) {
47+
if (!shouldIncludeFrame(item, includeSentryFrames)) {
48+
continue;
49+
}
6150

62-
// hard cap to not exceed payload size limit
63-
if (sentryStackFrames.size() >= STACKTRACE_FRAME_LIMIT) {
64-
break;
65-
}
51+
if (frameIndex < NEWEST_FRAMES_LIMIT || frameIndex >= frameCount - OLDEST_FRAMES_LIMIT) {
52+
sentryStackFrames.add(getSentryStackFrame(item));
6653
}
54+
frameIndex++;
6755
}
6856
Collections.reverse(sentryStackFrames);
6957
}
7058

7159
return sentryStackFrames;
7260
}
7361

62+
private static boolean shouldIncludeFrame(
63+
final @Nullable StackTraceElement item, final boolean includeSentryFrames) {
64+
if (item == null) {
65+
return false;
66+
}
67+
68+
final String className = item.getClassName();
69+
return includeSentryFrames
70+
|| !className.startsWith("io.sentry.")
71+
|| className.startsWith("io.sentry.samples.")
72+
|| className.startsWith("io.sentry.mobile.");
73+
}
74+
75+
private @NotNull SentryStackFrame getSentryStackFrame(final @NotNull StackTraceElement item) {
76+
final SentryStackFrame sentryStackFrame = new SentryStackFrame();
77+
final String className = item.getClassName();
78+
// https://docs.sentry.io/development/sdk-dev/features/#in-app-frames
79+
sentryStackFrame.setInApp(isInApp(className));
80+
sentryStackFrame.setModule(className);
81+
sentryStackFrame.setFunction(item.getMethodName());
82+
sentryStackFrame.setFilename(item.getFileName());
83+
// Protocol doesn't accept negative line numbers.
84+
// The runtime seem to use -2 as a way to signal a native method
85+
if (item.getLineNumber() >= 0) {
86+
sentryStackFrame.setLineno(item.getLineNumber());
87+
}
88+
sentryStackFrame.setNative(item.isNativeMethod());
89+
return sentryStackFrame;
90+
}
91+
7492
/**
7593
* Provides the logic to decide whether a className is part of the includes or excludes list of
7694
* strings. The bias is towards includes, meaning once a className starts with a prefix in the

‎sentry/src/test/java/io/sentry/SentryExceptionFactoryTest.kt‎

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
package io.sentry
22

3+
import com.google.common.truth.Truth.assertThat
34
import io.sentry.exception.ExceptionMechanismException
45
import io.sentry.protocol.Mechanism
56
import io.sentry.protocol.SentryStackFrame
@@ -44,7 +45,8 @@ class SentryExceptionFactoryTest {
4445
@Test
4546
fun `when frames are null, do not set a stack trace object`() {
4647
val stackTraceFactory = mock<SentryStackTraceFactory>()
47-
whenever(stackTraceFactory.getStackFrames(any(), eq(false))).thenReturn(null)
48+
whenever(stackTraceFactory.getStackFrames(any<Array<StackTraceElement>>(), eq(false)))
49+
.thenReturn(null)
4850

4951
val sut = fixture.getSut(stackTraceFactory)
5052
val exception = Exception("Exception")
@@ -57,7 +59,8 @@ class SentryExceptionFactoryTest {
5759
@Test
5860
fun `when frames are empty, do not set a stack trace object`() {
5961
val stackTraceFactory = mock<SentryStackTraceFactory>()
60-
whenever(stackTraceFactory.getStackFrames(any(), eq(false))).thenReturn(emptyList())
62+
whenever(stackTraceFactory.getStackFrames(any<Array<StackTraceElement>>(), eq(false)))
63+
.thenReturn(emptyList())
6164

6265
val sut = fixture.getSut(stackTraceFactory)
6366
val exception = Exception("Exception")
@@ -67,6 +70,20 @@ class SentryExceptionFactoryTest {
6770
assertNull(sentryExceptions[0].stacktrace)
6871
}
6972

73+
@Test
74+
fun `limits exception stack trace to 50 oldest and 200 newest frames`() {
75+
val exception = Exception("Exception")
76+
exception.stackTrace = Array(300) { StackTraceElement("frame-$it", "method", "File.java", it) }
77+
78+
val frames = fixture.getSut().getSentryExceptions(exception).single().stacktrace!!.frames!!
79+
80+
assertThat(frames).hasSize(250)
81+
assertThat(frames[0].module).isEqualTo("frame-299")
82+
assertThat(frames[49].module).isEqualTo("frame-250")
83+
assertThat(frames[50].module).isEqualTo("frame-199")
84+
assertThat(frames[249].module).isEqualTo("frame-0")
85+
}
86+
7087
@Test
7188
fun `when getSentryExceptions is called passing a ExceptionMechanism, it should set its fields`() {
7289
val mechanism = Mechanism()

‎sentry/src/test/java/io/sentry/SentryStackTraceFactoryTest.kt‎

Lines changed: 33 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
package io.sentry
22

3+
import com.google.common.truth.Truth.assertThat
34
import java.lang.Exception
45
import kotlin.test.Test
56
import kotlin.test.assertEquals
@@ -284,15 +285,40 @@ class SentryStackTraceFactoryTest {
284285
}
285286

286287
@Test
287-
fun `caps number of stack frames to STACKTRACE_FRAME_LIMIT to not exceed payload size limit`() {
288-
val exception = Exception()
289-
exception.stackTrace = arrayOf()
290-
repeat(120) { exception.stackTrace += generateStackTrace("com.me.stackoverflow") }
288+
fun `does not truncate stack frames within the limit`() {
289+
val stackTrace = Array(250) { generateStackTrace("frame-$it") }
291290

292-
val sut = SentryStackTraceFactory(SentryOptions())
293-
val sentryFrames = sut.getStackFrames(exception.stackTrace, false)
291+
val sentryFrames = sut.getStackFrames(stackTrace, false)
292+
293+
assertThat(sentryFrames).hasSize(250)
294+
}
295+
296+
@Test
297+
fun `retains 50 oldest and 200 newest stack frames`() {
298+
val stackTrace = Array(300) { generateStackTrace("frame-$it") }
299+
300+
val sentryFrames = sut.getStackFrames(stackTrace, false)!!
294301

295-
assertEquals(100, sentryFrames!!.size)
302+
assertThat(sentryFrames).hasSize(250)
303+
assertThat(sentryFrames[0].module).isEqualTo("frame-299")
304+
assertThat(sentryFrames[49].module).isEqualTo("frame-250")
305+
assertThat(sentryFrames[50].module).isEqualTo("frame-199")
306+
assertThat(sentryFrames[249].module).isEqualTo("frame-0")
307+
}
308+
309+
@Test
310+
fun `filters sentry frames before applying stack frame limit`() {
311+
val stackTrace =
312+
Array(50) { generateStackTrace("io.sentry.frame-$it") } +
313+
Array(300) { generateStackTrace("frame-$it") }
314+
315+
val sentryFrames = sut.getStackFrames(stackTrace, false)!!
316+
317+
assertThat(sentryFrames).hasSize(250)
318+
assertThat(sentryFrames[0].module).isEqualTo("frame-299")
319+
assertThat(sentryFrames[49].module).isEqualTo("frame-250")
320+
assertThat(sentryFrames[50].module).isEqualTo("frame-199")
321+
assertThat(sentryFrames[249].module).isEqualTo("frame-0")
296322
}
297323

298324
private fun generateStackTrace(className: String?) =

‎sentry/src/test/java/io/sentry/SentryThreadFactoryTest.kt‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
package io.sentry
22

3+
import com.google.common.truth.Truth.assertThat
34
import kotlin.test.Test
45
import kotlin.test.assertEquals
56
import kotlin.test.assertFalse
@@ -91,6 +92,25 @@ class SentryThreadFactoryTest {
9192
assertNotNull(threads!!.firstOrNull { it.id == currentThread.id })
9293
}
9394

95+
@Test
96+
fun `limits thread stack trace to 50 oldest and 200 newest frames`() {
97+
val sut = fixture.getSut()
98+
val thread = Thread()
99+
val stackTrace = Array(300) { StackTraceElement("frame-$it", "method", "File.java", it) }
100+
101+
val sentryThread =
102+
sut.getCurrentThreads(mutableMapOf(thread to stackTrace), null, false, true)!!.single {
103+
it.id == thread.id
104+
}
105+
val frames = sentryThread.stacktrace!!.frames!!
106+
107+
assertThat(frames).hasSize(250)
108+
assertThat(frames[0].module).isEqualTo("frame-299")
109+
assertThat(frames[49].module).isEqualTo("frame-250")
110+
assertThat(frames[50].module).isEqualTo("frame-199")
111+
assertThat(frames[249].module).isEqualTo("frame-0")
112+
}
113+
94114
@Test
95115
fun `When passing empty param to getCurrentThreads, returns null`() {
96116
val sut = fixture.getSut()

0 commit comments

Comments
 (0)