Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@

### Improvements

- Preserve the oldest and newest frames when truncating deep stack traces ([#6623](https://github.com/getsentry/sentry-java/pull/6623))
- Promote check-in APIs from experimental to stable ([#6422](https://github.com/getsentry/sentry-java/pull/6422))
- Promote the backpressure handling option from experimental to stable ([#6423](https://github.com/getsentry/sentry-java/pull/6423))
- Promote structured logs APIs from experimental to stable ([#6424](https://github.com/getsentry/sentry-java/pull/6424))
Expand Down
78 changes: 48 additions & 30 deletions sentry/src/main/java/io/sentry/SentryStackTraceFactory.java
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@
@ApiStatus.Internal
public final class SentryStackTraceFactory {

private static final int STACKTRACE_FRAME_LIMIT = 100;
private static final int NEWEST_FRAMES_LIMIT = 200;
private static final int OLDEST_FRAMES_LIMIT = 50;
private final @NotNull SentryOptions options;

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

if (elements != null && elements.length > 0) {
sentryStackFrames = new ArrayList<>();
for (StackTraceElement item : elements) {
if (item != null) {

// we don't want to add our own frames
final String className = item.getClassName();
if (!includeSentryFrames
&& (className.startsWith("io.sentry.")
&& !className.startsWith("io.sentry.samples.")
&& !className.startsWith("io.sentry.mobile."))) {
continue;
}
int frameCount = 0;
for (final StackTraceElement item : elements) {
if (shouldIncludeFrame(item, includeSentryFrames)) {
frameCount++;
}
}

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

// hard cap to not exceed payload size limit
if (sentryStackFrames.size() >= STACKTRACE_FRAME_LIMIT) {
break;
}
if (frameIndex < NEWEST_FRAMES_LIMIT || frameIndex >= frameCount - OLDEST_FRAMES_LIMIT) {
sentryStackFrames.add(getSentryStackFrame(item));
}
frameIndex++;
}
Collections.reverse(sentryStackFrames);
}

return sentryStackFrames;
}

private static boolean shouldIncludeFrame(
final @Nullable StackTraceElement item, final boolean includeSentryFrames) {
if (item == null) {
return false;
}

final String className = item.getClassName();
return includeSentryFrames
|| !className.startsWith("io.sentry.")
|| className.startsWith("io.sentry.samples.")
|| className.startsWith("io.sentry.mobile.");
}

private @NotNull SentryStackFrame getSentryStackFrame(final @NotNull StackTraceElement item) {
final SentryStackFrame sentryStackFrame = new SentryStackFrame();
final String className = item.getClassName();
// https://docs.sentry.io/development/sdk-dev/features/#in-app-frames
sentryStackFrame.setInApp(isInApp(className));
sentryStackFrame.setModule(className);
sentryStackFrame.setFunction(item.getMethodName());
sentryStackFrame.setFilename(item.getFileName());
// Protocol doesn't accept negative line numbers.
// The runtime seem to use -2 as a way to signal a native method
if (item.getLineNumber() >= 0) {
sentryStackFrame.setLineno(item.getLineNumber());
}
sentryStackFrame.setNative(item.isNativeMethod());
return sentryStackFrame;
}

/**
* Provides the logic to decide whether a className is part of the includes or excludes list of
* strings. The bias is towards includes, meaning once a className starts with a prefix in the
Expand Down
21 changes: 19 additions & 2 deletions sentry/src/test/java/io/sentry/SentryExceptionFactoryTest.kt
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
package io.sentry

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

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

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

@Test
fun `limits exception stack trace to 50 oldest and 200 newest frames`() {
val exception = Exception("Exception")
exception.stackTrace = Array(300) { StackTraceElement("frame-$it", "method", "File.java", it) }

val frames = fixture.getSut().getSentryExceptions(exception).single().stacktrace!!.frames!!

assertThat(frames).hasSize(250)
assertThat(frames[0].module).isEqualTo("frame-299")
assertThat(frames[49].module).isEqualTo("frame-250")
assertThat(frames[50].module).isEqualTo("frame-199")
assertThat(frames[249].module).isEqualTo("frame-0")
}

@Test
fun `when getSentryExceptions is called passing a ExceptionMechanism, it should set its fields`() {
val mechanism = Mechanism()
Expand Down
40 changes: 33 additions & 7 deletions sentry/src/test/java/io/sentry/SentryStackTraceFactoryTest.kt
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
package io.sentry

import com.google.common.truth.Truth.assertThat
import java.lang.Exception
import kotlin.test.Test
import kotlin.test.assertEquals
Expand Down Expand Up @@ -284,15 +285,40 @@ class SentryStackTraceFactoryTest {
}

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

val sut = SentryStackTraceFactory(SentryOptions())
val sentryFrames = sut.getStackFrames(exception.stackTrace, false)
val sentryFrames = sut.getStackFrames(stackTrace, false)

assertThat(sentryFrames).hasSize(250)
}

@Test
fun `retains 50 oldest and 200 newest stack frames`() {
val stackTrace = Array(300) { generateStackTrace("frame-$it") }

val sentryFrames = sut.getStackFrames(stackTrace, false)!!

assertEquals(100, sentryFrames!!.size)
assertThat(sentryFrames).hasSize(250)
assertThat(sentryFrames[0].module).isEqualTo("frame-299")
assertThat(sentryFrames[49].module).isEqualTo("frame-250")
assertThat(sentryFrames[50].module).isEqualTo("frame-199")
assertThat(sentryFrames[249].module).isEqualTo("frame-0")
}

@Test
fun `filters sentry frames before applying stack frame limit`() {
val stackTrace =
Array(50) { generateStackTrace("io.sentry.frame-$it") } +
Array(300) { generateStackTrace("frame-$it") }

val sentryFrames = sut.getStackFrames(stackTrace, false)!!

assertThat(sentryFrames).hasSize(250)
assertThat(sentryFrames[0].module).isEqualTo("frame-299")
assertThat(sentryFrames[49].module).isEqualTo("frame-250")
assertThat(sentryFrames[50].module).isEqualTo("frame-199")
assertThat(sentryFrames[249].module).isEqualTo("frame-0")
}

private fun generateStackTrace(className: String?) =
Expand Down
20 changes: 20 additions & 0 deletions sentry/src/test/java/io/sentry/SentryThreadFactoryTest.kt
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
package io.sentry

import com.google.common.truth.Truth.assertThat
import kotlin.test.Test
import kotlin.test.assertEquals
import kotlin.test.assertFalse
Expand Down Expand Up @@ -91,6 +92,25 @@ class SentryThreadFactoryTest {
assertNotNull(threads!!.firstOrNull { it.id == currentThread.id })
}

@Test
fun `limits thread stack trace to 50 oldest and 200 newest frames`() {
val sut = fixture.getSut()
val thread = Thread()
val stackTrace = Array(300) { StackTraceElement("frame-$it", "method", "File.java", it) }

val sentryThread =
sut.getCurrentThreads(mutableMapOf(thread to stackTrace), null, false, true)!!.single {
it.id == thread.id
}
val frames = sentryThread.stacktrace!!.frames!!

assertThat(frames).hasSize(250)
assertThat(frames[0].module).isEqualTo("frame-299")
assertThat(frames[49].module).isEqualTo("frame-250")
assertThat(frames[50].module).isEqualTo("frame-199")
assertThat(frames[249].module).isEqualTo("frame-0")
}

@Test
fun `When passing empty param to getCurrentThreads, returns null`() {
val sut = fixture.getSut()
Expand Down
Loading