Skip to content

feat(contexts): Add chipset to device context #4512

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jun 24, 2025
Merged
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
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

## Unreleased

### Features

- Add chipset to device context ([#4512](https://github.com/getsentry/sentry-java/pull/4512))

### Fixes

- No longer send out empty log envelopes ([#4497](https://github.com/getsentry/sentry-java/pull/4497))
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,7 @@ public static void resetInstance() {

// we can get some inspiration here
// https://github.com/flutter/plugins/blob/master/packages/device_info/android/src/main/java/io/flutter/plugins/deviceinfo/DeviceInfoPlugin.java
@SuppressLint("NewApi")
@NotNull
public Device collectDeviceInformation(
final boolean collectDeviceIO, final boolean collectDynamicData) {
Expand All @@ -107,6 +108,9 @@ public Device collectDeviceInformation(
device.setModel(Build.MODEL);
device.setModelId(Build.ID);
device.setArchs(ContextUtils.getArchitectures());
if (buildInfoProvider.getSdkInfoVersion() >= Build.VERSION_CODES.S) {
device.setChipset(Build.SOC_MANUFACTURER + " " + Build.SOC_MODEL);
}

device.setOrientation(getOrientation());
if (isEmulator != null) {
Expand Down
3 changes: 3 additions & 0 deletions sentry/api/sentry.api
Original file line number Diff line number Diff line change
Expand Up @@ -5155,6 +5155,7 @@ public final class io/sentry/protocol/Device : io/sentry/JsonSerializable, io/se
public fun getBatteryTemperature ()Ljava/lang/Float;
public fun getBootTime ()Ljava/util/Date;
public fun getBrand ()Ljava/lang/String;
public fun getChipset ()Ljava/lang/String;
public fun getConnectionType ()Ljava/lang/String;
public fun getCpuDescription ()Ljava/lang/String;
public fun getExternalFreeStorage ()Ljava/lang/Long;
Expand Down Expand Up @@ -5192,6 +5193,7 @@ public final class io/sentry/protocol/Device : io/sentry/JsonSerializable, io/se
public fun setBootTime (Ljava/util/Date;)V
public fun setBrand (Ljava/lang/String;)V
public fun setCharging (Ljava/lang/Boolean;)V
public fun setChipset (Ljava/lang/String;)V
public fun setConnectionType (Ljava/lang/String;)V
public fun setCpuDescription (Ljava/lang/String;)V
public fun setExternalFreeStorage (Ljava/lang/Long;)V
Expand Down Expand Up @@ -5249,6 +5251,7 @@ public final class io/sentry/protocol/Device$JsonKeys {
public static final field BOOT_TIME Ljava/lang/String;
public static final field BRAND Ljava/lang/String;
public static final field CHARGING Ljava/lang/String;
public static final field CHIPSET Ljava/lang/String;
public static final field CONNECTION_TYPE Ljava/lang/String;
public static final field CPU_DESCRIPTION Ljava/lang/String;
public static final field EXTERNAL_FREE_STORAGE Ljava/lang/String;
Expand Down
24 changes: 22 additions & 2 deletions sentry/src/main/java/io/sentry/protocol/Device.java
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,8 @@ public final class Device implements JsonUnknown, JsonSerializable {
/** Optional. CPU description. For example, Intel(R) Core(TM)2 Quad CPU Q6600 @ 2.40GHz. */
private @Nullable String cpuDescription;

private @Nullable String chipset;

@SuppressWarnings("unused")
private @Nullable Map<String, @NotNull Object> unknown;

Expand Down Expand Up @@ -189,6 +191,7 @@ public Device() {}
this.processorCount = device.processorCount;
this.processorFrequency = device.processorFrequency;
this.cpuDescription = device.cpuDescription;
this.chipset = device.chipset;

this.unknown = CollectionUtils.newConcurrentHashMap(device.unknown);
}
Expand Down Expand Up @@ -451,6 +454,14 @@ public void setCpuDescription(@Nullable final String cpuDescription) {
this.cpuDescription = cpuDescription;
}

public @Nullable String getChipset() {
return chipset;
}

public void setChipset(final @Nullable String chipset) {
this.chipset = chipset;
}

@Override
public boolean equals(Object o) {
if (this == o) return true;
Expand Down Expand Up @@ -487,7 +498,8 @@ public boolean equals(Object o) {
&& Objects.equals(batteryTemperature, device.batteryTemperature)
&& Objects.equals(processorCount, device.processorCount)
&& Objects.equals(processorFrequency, device.processorFrequency)
&& Objects.equals(cpuDescription, device.cpuDescription);
&& Objects.equals(cpuDescription, device.cpuDescription)
&& Objects.equals(chipset, device.chipset);
}

@Override
Expand Down Expand Up @@ -525,7 +537,8 @@ public int hashCode() {
batteryTemperature,
processorCount,
processorFrequency,
cpuDescription);
cpuDescription,
chipset);
result = 31 * result + Arrays.hashCode(archs);
return result;
}
Expand Down Expand Up @@ -589,6 +602,7 @@ public static final class JsonKeys {
public static final String PROCESSOR_COUNT = "processor_count";
public static final String CPU_DESCRIPTION = "cpu_description";
public static final String PROCESSOR_FREQUENCY = "processor_frequency";
public static final String CHIPSET = "chipset";
}

@Override
Expand Down Expand Up @@ -694,6 +708,9 @@ public void serialize(final @NotNull ObjectWriter writer, final @NotNull ILogger
if (cpuDescription != null) {
writer.name(JsonKeys.CPU_DESCRIPTION).value(cpuDescription);
}
if (chipset != null) {
writer.name(JsonKeys.CHIPSET).value(chipset);
}
if (unknown != null) {
for (String key : unknown.keySet()) {
Object value = unknown.get(key);
Expand Down Expand Up @@ -839,6 +856,9 @@ public static final class Deserializer implements JsonDeserializer<Device> {
case JsonKeys.CPU_DESCRIPTION:
device.cpuDescription = reader.nextStringOrNull();
break;
case JsonKeys.CHIPSET:
device.chipset = reader.nextStringOrNull();
break;
default:
if (unknown == null) {
unknown = new ConcurrentHashMap<>();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import org.junit.Test
import org.mockito.kotlin.mock

class DeviceSerializationTest {

class Fixture {
val logger = mock<ILogger>()

Expand Down Expand Up @@ -57,6 +58,7 @@ class DeviceSerializationTest {
connectionType = "9ceb3a6c-5292-4ed9-8665-5732495e8ed4"
batteryTemperature = 0.14775127f
cpuDescription = "cpu0"
chipset = "unisoc"
processorCount = 4
processorFrequency = 800.0
}
Expand Down
3 changes: 3 additions & 0 deletions sentry/src/test/java/io/sentry/protocol/DeviceTest.kt
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import kotlin.test.assertNotNull
import kotlin.test.assertNotSame

class DeviceTest {

@Test
fun `copying device wont have the same references`() {
val device = Device()
Expand Down Expand Up @@ -61,6 +62,7 @@ class DeviceTest {
device.batteryTemperature = 30f
device.locale = "en-US"
device.cpuDescription = "cpu0"
device.chipset = "unisoc t606"
device.processorCount = 4
device.processorFrequency = 800.0
val unknown = mapOf(Pair("unknown", "unknown"))
Expand Down Expand Up @@ -100,6 +102,7 @@ class DeviceTest {
assertEquals("connection type", clone.connectionType)
assertEquals(30f, clone.batteryTemperature)
assertEquals("cpu0", clone.cpuDescription)
assertEquals("unisoc t606", clone.chipset)
assertEquals(4, clone.processorCount)
assertEquals(800.0, clone.processorFrequency)
device.processorFrequency = 800.0
Expand Down
3 changes: 2 additions & 1 deletion sentry/src/test/resources/json/contexts.json
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,8 @@
"battery_temperature": 0.14775127,
"processor_count": 4,
"processor_frequency": 800.0,
"cpu_description": "cpu0"
"cpu_description": "cpu0",
"chipset": "unisoc"
},
"feedback":
{
Expand Down
3 changes: 2 additions & 1 deletion sentry/src/test/resources/json/device.json
Original file line number Diff line number Diff line change
Expand Up @@ -38,5 +38,6 @@
"battery_temperature": 0.14775127,
"processor_count": 4,
"processor_frequency": 800.0,
"cpu_description": "cpu0"
"cpu_description": "cpu0",
"chipset": "unisoc"
}
3 changes: 2 additions & 1 deletion sentry/src/test/resources/json/sentry_base_event.json
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,8 @@
"battery_temperature": 0.14775127,
"processor_count": 4,
"processor_frequency": 800.0,
"cpu_description": "cpu0"
"cpu_description": "cpu0",
"chipset": "unisoc"
},
"gpu":
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,8 @@
"battery_temperature": 0.14775127,
"processor_count": 4,
"processor_frequency": 800.0,
"cpu_description": "cpu0"
"cpu_description": "cpu0",
"chipset": "unisoc"
},
"gpu":
{
Expand Down
3 changes: 2 additions & 1 deletion sentry/src/test/resources/json/sentry_event.json
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,8 @@
"battery_temperature": 0.14775127,
"processor_count": 4,
"processor_frequency": 800.0,
"cpu_description": "cpu0"
"cpu_description": "cpu0",
"chipset": "unisoc"
},
"gpu":
{
Expand Down
3 changes: 2 additions & 1 deletion sentry/src/test/resources/json/sentry_replay_event.json
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,8 @@
"battery_temperature": 0.14775127,
"processor_count": 4,
"processor_frequency": 800.0,
"cpu_description": "cpu0"
"cpu_description": "cpu0",
"chipset": "unisoc"
},
"gpu":
{
Expand Down
3 changes: 2 additions & 1 deletion sentry/src/test/resources/json/sentry_transaction.json
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,8 @@
"battery_temperature": 0.14775127,
"processor_count": 4,
"processor_frequency": 800.0,
"cpu_description": "cpu0"
"cpu_description": "cpu0",
"chipset": "unisoc"
},
"gpu":
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,8 @@
"battery_temperature": 0.14775127,
"processor_count": 4,
"processor_frequency": 800.0,
"cpu_description": "cpu0"
"cpu_description": "cpu0",
"chipset": "unisoc"
},
"gpu":
{
Expand Down
Loading