From 37cfabc896f0ffda35d5c9887e51b50a127e8013 Mon Sep 17 00:00:00 2001 From: Markus Hintersteiner Date: Tue, 10 Nov 2026 16:27:17 +0100 Subject: [PATCH 1/3] ref(android): Store the thread state in ANR stack samples --- .../api/sentry-android-core.api | 2 + .../android/core/anr/AnrStackTrace.java | 75 +++++++++++----- .../android/core/anr/AnrStackTraceTest.kt | 87 +++++++++++++++++++ 3 files changed, 140 insertions(+), 24 deletions(-) diff --git a/sentry-android-core/api/sentry-android-core.api b/sentry-android-core/api/sentry-android-core.api index 4c972c1f3d3..712f981ecd2 100644 --- a/sentry-android-core/api/sentry-android-core.api +++ b/sentry-android-core/api/sentry-android-core.api @@ -759,8 +759,10 @@ public final class io/sentry/android/core/anr/AnrProfilingIntegration : io/sentr public final class io/sentry/android/core/anr/AnrStackTrace : java/lang/Comparable { public final field stack [Ljava/lang/StackTraceElement; + public final field state Ljava/lang/Thread$State; public final field timestampMs J public fun (J[Ljava/lang/StackTraceElement;)V + public fun (J[Ljava/lang/StackTraceElement;Ljava/lang/Thread$State;)V public fun compareTo (Lio/sentry/android/core/anr/AnrStackTrace;)I public synthetic fun compareTo (Ljava/lang/Object;)I public static fun deserialize (Ljava/io/DataInputStream;)Lio/sentry/android/core/anr/AnrStackTrace; diff --git a/sentry-android-core/src/main/java/io/sentry/android/core/anr/AnrStackTrace.java b/sentry-android-core/src/main/java/io/sentry/android/core/anr/AnrStackTrace.java index 2d165c501bf..fc3a5ecc051 100644 --- a/sentry-android-core/src/main/java/io/sentry/android/core/anr/AnrStackTrace.java +++ b/sentry-android-core/src/main/java/io/sentry/android/core/anr/AnrStackTrace.java @@ -16,10 +16,17 @@ public final class AnrStackTrace implements Comparable { public final StackTraceElement[] stack; public final long timestampMs; + public final @Nullable Thread.State state; public AnrStackTrace(final long timestampMs, final StackTraceElement[] stack) { + this(timestampMs, stack, null); + } + + public AnrStackTrace( + final long timestampMs, final StackTraceElement[] stack, final @Nullable Thread.State state) { this.timestampMs = timestampMs; this.stack = stack; + this.state = state; } @Override @@ -28,8 +35,9 @@ public int compareTo(final @NotNull AnrStackTrace o) { } public void serialize(final @NotNull DataOutputStream dos) throws IOException { - dos.writeShort(1); // version + dos.writeShort(2); // version dos.writeLong(timestampMs); + dos.writeUTF(state == null ? "" : state.name()); dos.writeInt(stack.length); for (final @NotNull StackTraceElement element : stack) { dos.writeUTF(StringUtils.getOrEmpty(element.getClassName())); @@ -46,34 +54,53 @@ public void serialize(final @NotNull DataOutputStream dos) throws IOException { public static AnrStackTrace deserialize(final @NotNull DataInputStream dis) throws IOException { try { final short version = dis.readShort(); - if (version == 1) { - final long timestampMs = dis.readLong(); - final int stackLength = dis.readInt(); - if (stackLength < 0 || stackLength > MAX_STACK_LENGTH) { - return null; - } - final @NotNull StackTraceElement[] stack = new StackTraceElement[stackLength]; - - for (int i = 0; i < stackLength; i++) { - final @NotNull String className = dis.readUTF(); - final @NotNull String methodName = dis.readUTF(); - // Read the null marker to restore null vs empty string distinction - final boolean isFileNameNull = dis.readBoolean(); - final @NotNull String fileNameStr = dis.readUTF(); - final @Nullable String fileName = isFileNameNull ? null : fileNameStr; - final int lineNumber = dis.readInt(); - final StackTraceElement element = - new StackTraceElement(className, methodName, fileName, lineNumber); - stack[i] = element; - } - - return new AnrStackTrace(timestampMs, stack); - } else { + if (version != 1 && version != 2) { // unsupported future version return null; } + final long timestampMs = dis.readLong(); + final @Nullable Thread.State state = version == 2 ? readState(dis) : null; + final @Nullable StackTraceElement[] stack = readStack(dis); + if (stack == null) { + return null; + } + return new AnrStackTrace(timestampMs, stack, state); } catch (EOFException e) { return null; } } + + private static @Nullable Thread.State readState(final @NotNull DataInputStream dis) + throws IOException { + final @NotNull String name = dis.readUTF(); + if (name.isEmpty()) { + return null; + } + try { + return Thread.State.valueOf(name); + } catch (IllegalArgumentException e) { + // written by a runtime with a state this one does not know + return null; + } + } + + private static @Nullable StackTraceElement[] readStack(final @NotNull DataInputStream dis) + throws IOException { + final int stackLength = dis.readInt(); + if (stackLength < 0 || stackLength > MAX_STACK_LENGTH) { + return null; + } + final @NotNull StackTraceElement[] stack = new StackTraceElement[stackLength]; + for (int i = 0; i < stackLength; i++) { + final @NotNull String className = dis.readUTF(); + final @NotNull String methodName = dis.readUTF(); + // Read the null marker to restore null vs empty string distinction + final boolean isFileNameNull = dis.readBoolean(); + final @NotNull String fileNameStr = dis.readUTF(); + final @Nullable String fileName = isFileNameNull ? null : fileNameStr; + final int lineNumber = dis.readInt(); + stack[i] = new StackTraceElement(className, methodName, fileName, lineNumber); + } + return stack; + } } diff --git a/sentry-android-core/src/test/java/io/sentry/android/core/anr/AnrStackTraceTest.kt b/sentry-android-core/src/test/java/io/sentry/android/core/anr/AnrStackTraceTest.kt index e53ad507bc1..091a7ba4a2c 100644 --- a/sentry-android-core/src/test/java/io/sentry/android/core/anr/AnrStackTraceTest.kt +++ b/sentry-android-core/src/test/java/io/sentry/android/core/anr/AnrStackTraceTest.kt @@ -1,5 +1,6 @@ package io.sentry.android.core.anr +import com.google.common.truth.Truth.assertThat import java.io.ByteArrayInputStream import java.io.ByteArrayOutputStream import java.io.DataInputStream @@ -124,4 +125,90 @@ class AnrStackTraceTest { assertNull(deserialized) } + + @Test + fun `v2 round trip keeps the thread state`() { + val stack = arrayOf(StackTraceElement("com.example.MyClass", "method1", "MyClass.java", 42)) + val original = AnrStackTrace(1234567890L, stack, Thread.State.BLOCKED) + + val deserialized = roundTrip(original) + + assertThat(deserialized).isNotNull() + assertThat(deserialized!!.state).isEqualTo(Thread.State.BLOCKED) + assertThat(deserialized.timestampMs).isEqualTo(1234567890L) + assertThat(deserialized.stack).isEqualTo(stack) + } + + @Test + fun `v2 round trip keeps a null thread state`() { + val original = AnrStackTrace(1234567890L, emptyArray(), null) + + val deserialized = roundTrip(original) + + assertThat(deserialized).isNotNull() + assertThat(deserialized!!.state).isNull() + } + + @Test + fun `v1 bytes are still read with a null state`() { + val bytes = ByteArrayOutputStream() + val dos = DataOutputStream(bytes) + dos.writeShort(1) + dos.writeLong(1234567890L) + dos.writeInt(1) + dos.writeUTF("com.example.MyClass") + dos.writeUTF("method1") + dos.writeBoolean(false) + dos.writeUTF("MyClass.java") + dos.writeInt(42) + dos.flush() + + val deserialized = + AnrStackTrace.deserialize(DataInputStream(ByteArrayInputStream(bytes.toByteArray()))) + + assertThat(deserialized).isNotNull() + assertThat(deserialized!!.state).isNull() + assertThat(deserialized.timestampMs).isEqualTo(1234567890L) + assertThat(deserialized.stack) + .isEqualTo(arrayOf(StackTraceElement("com.example.MyClass", "method1", "MyClass.java", 42))) + } + + @Test + fun `unknown thread state name reads as null`() { + val bytes = ByteArrayOutputStream() + val dos = DataOutputStream(bytes) + dos.writeShort(2) + dos.writeLong(1234567890L) + dos.writeUTF("NOT_A_STATE") + dos.writeInt(0) + dos.flush() + + val deserialized = + AnrStackTrace.deserialize(DataInputStream(ByteArrayInputStream(bytes.toByteArray()))) + + assertThat(deserialized).isNotNull() + assertThat(deserialized!!.state).isNull() + } + + @Test + fun `version 3 returns null`() { + val bytes = ByteArrayOutputStream() + val dos = DataOutputStream(bytes) + dos.writeShort(3) + dos.writeLong(1234567890L) + dos.flush() + + val deserialized = + AnrStackTrace.deserialize(DataInputStream(ByteArrayInputStream(bytes.toByteArray()))) + + assertThat(deserialized).isNull() + } + + private fun roundTrip(original: AnrStackTrace): AnrStackTrace? { + val bytes = ByteArrayOutputStream() + val dos = DataOutputStream(bytes) + original.serialize(dos) + dos.flush() + return AnrStackTrace.deserialize(DataInputStream(ByteArrayInputStream(bytes.toByteArray()))) + } } From 3b2adb462e1254f53ba63d37b6cb312ab84c84f2 Mon Sep 17 00:00:00 2001 From: Markus Hintersteiner Date: Wed, 11 Nov 2026 10:00:34 +0100 Subject: [PATCH 2/3] ref(android): Mark a null ANR sample state explicitly and document the format --- .../android/core/anr/AnrStackTrace.java | 101 ++++++++++-------- .../android/core/anr/AnrStackTraceTest.kt | 1 + 2 files changed, 60 insertions(+), 42 deletions(-) diff --git a/sentry-android-core/src/main/java/io/sentry/android/core/anr/AnrStackTrace.java b/sentry-android-core/src/main/java/io/sentry/android/core/anr/AnrStackTrace.java index fc3a5ecc051..25cd2d2ac10 100644 --- a/sentry-android-core/src/main/java/io/sentry/android/core/anr/AnrStackTrace.java +++ b/sentry-android-core/src/main/java/io/sentry/android/core/anr/AnrStackTrace.java @@ -34,9 +34,32 @@ public int compareTo(final @NotNull AnrStackTrace o) { return Long.compare(timestampMs, o.timestampMs); } + /** + * Writes this sample in format version 2. All numbers are big-endian, and strings use the + * modified UTF-8 of {@link DataOutputStream#writeUTF(String)}. + * + *
+   * short   version (2)
+   * long    timestampMs
+   * boolean isStateNull
+   * UTF     state name, or "" if isStateNull
+   * int     number of frames
+   * for each frame:
+   *   UTF     className
+   *   UTF     methodName
+   *   boolean isFileNameNull
+   *   UTF     fileName, or "" if isFileNameNull
+   *   int     lineNumber
+   * 
+ * + *

Version 1 is the same without the two state fields. {@link #deserialize(DataInputStream)} + * reads both versions. + */ public void serialize(final @NotNull DataOutputStream dos) throws IOException { dos.writeShort(2); // version dos.writeLong(timestampMs); + // Write null as a special marker to preserve null vs empty string distinction + dos.writeBoolean(state == null); dos.writeUTF(state == null ? "" : state.name()); dos.writeInt(stack.length); for (final @NotNull StackTraceElement element : stack) { @@ -54,53 +77,47 @@ public void serialize(final @NotNull DataOutputStream dos) throws IOException { public static AnrStackTrace deserialize(final @NotNull DataInputStream dis) throws IOException { try { final short version = dis.readShort(); - if (version != 1 && version != 2) { + if (version == 1 || version == 2) { + final long timestampMs = dis.readLong(); + @Nullable Thread.State state = null; + if (version == 2) { + // Read the null marker to restore null vs empty string distinction + final boolean isStateNull = dis.readBoolean(); + final @NotNull String stateName = dis.readUTF(); + if (!isStateNull) { + try { + state = Thread.State.valueOf(stateName); + } catch (IllegalArgumentException e) { + // written by a runtime with a state this one does not know + } + } + } + final int stackLength = dis.readInt(); + if (stackLength < 0 || stackLength > MAX_STACK_LENGTH) { + return null; + } + final @NotNull StackTraceElement[] stack = new StackTraceElement[stackLength]; + + for (int i = 0; i < stackLength; i++) { + final @NotNull String className = dis.readUTF(); + final @NotNull String methodName = dis.readUTF(); + // Read the null marker to restore null vs empty string distinction + final boolean isFileNameNull = dis.readBoolean(); + final @NotNull String fileNameStr = dis.readUTF(); + final @Nullable String fileName = isFileNameNull ? null : fileNameStr; + final int lineNumber = dis.readInt(); + final StackTraceElement element = + new StackTraceElement(className, methodName, fileName, lineNumber); + stack[i] = element; + } + + return new AnrStackTrace(timestampMs, stack, state); + } else { // unsupported future version return null; } - final long timestampMs = dis.readLong(); - final @Nullable Thread.State state = version == 2 ? readState(dis) : null; - final @Nullable StackTraceElement[] stack = readStack(dis); - if (stack == null) { - return null; - } - return new AnrStackTrace(timestampMs, stack, state); } catch (EOFException e) { return null; } } - - private static @Nullable Thread.State readState(final @NotNull DataInputStream dis) - throws IOException { - final @NotNull String name = dis.readUTF(); - if (name.isEmpty()) { - return null; - } - try { - return Thread.State.valueOf(name); - } catch (IllegalArgumentException e) { - // written by a runtime with a state this one does not know - return null; - } - } - - private static @Nullable StackTraceElement[] readStack(final @NotNull DataInputStream dis) - throws IOException { - final int stackLength = dis.readInt(); - if (stackLength < 0 || stackLength > MAX_STACK_LENGTH) { - return null; - } - final @NotNull StackTraceElement[] stack = new StackTraceElement[stackLength]; - for (int i = 0; i < stackLength; i++) { - final @NotNull String className = dis.readUTF(); - final @NotNull String methodName = dis.readUTF(); - // Read the null marker to restore null vs empty string distinction - final boolean isFileNameNull = dis.readBoolean(); - final @NotNull String fileNameStr = dis.readUTF(); - final @Nullable String fileName = isFileNameNull ? null : fileNameStr; - final int lineNumber = dis.readInt(); - stack[i] = new StackTraceElement(className, methodName, fileName, lineNumber); - } - return stack; - } } diff --git a/sentry-android-core/src/test/java/io/sentry/android/core/anr/AnrStackTraceTest.kt b/sentry-android-core/src/test/java/io/sentry/android/core/anr/AnrStackTraceTest.kt index 091a7ba4a2c..f26cab58f78 100644 --- a/sentry-android-core/src/test/java/io/sentry/android/core/anr/AnrStackTraceTest.kt +++ b/sentry-android-core/src/test/java/io/sentry/android/core/anr/AnrStackTraceTest.kt @@ -179,6 +179,7 @@ class AnrStackTraceTest { val dos = DataOutputStream(bytes) dos.writeShort(2) dos.writeLong(1234567890L) + dos.writeBoolean(false) dos.writeUTF("NOT_A_STATE") dos.writeInt(0) dos.flush() From 9729bc7b05819a54fdc1065edff5bf547a6b6f41 Mon Sep 17 00:00:00 2001 From: Markus Hintersteiner Date: Wed, 11 Nov 2026 10:40:54 +0100 Subject: [PATCH 3/3] ref(android): Remove narrating comments from AnrStackTrace --- .../src/main/java/io/sentry/android/core/anr/AnrStackTrace.java | 2 -- 1 file changed, 2 deletions(-) diff --git a/sentry-android-core/src/main/java/io/sentry/android/core/anr/AnrStackTrace.java b/sentry-android-core/src/main/java/io/sentry/android/core/anr/AnrStackTrace.java index 25cd2d2ac10..b8dfbdeec0f 100644 --- a/sentry-android-core/src/main/java/io/sentry/android/core/anr/AnrStackTrace.java +++ b/sentry-android-core/src/main/java/io/sentry/android/core/anr/AnrStackTrace.java @@ -58,7 +58,6 @@ public int compareTo(final @NotNull AnrStackTrace o) { public void serialize(final @NotNull DataOutputStream dos) throws IOException { dos.writeShort(2); // version dos.writeLong(timestampMs); - // Write null as a special marker to preserve null vs empty string distinction dos.writeBoolean(state == null); dos.writeUTF(state == null ? "" : state.name()); dos.writeInt(stack.length); @@ -81,7 +80,6 @@ public static AnrStackTrace deserialize(final @NotNull DataInputStream dis) thro final long timestampMs = dis.readLong(); @Nullable Thread.State state = null; if (version == 2) { - // Read the null marker to restore null vs empty string distinction final boolean isStateNull = dis.readBoolean(); final @NotNull String stateName = dis.readUTF(); if (!isStateNull) {