Device Attributes

38 attributes in this category. 37 stable · 1 deprecated

Stable Attributes

`device.archs`

string[] PII: Maybe OTel: False

The CPU architectures of the device.

Example ["arm64-v8a","armeabi-v7a","armeabi"]

Changelog

v0.5.0 #303 Added device.archs attribute

Raw JSON

{
  "key": "device.archs",
  "brief": "The CPU architectures of the device.",
  "type": "string[]",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": false,
  "example": [
    "arm64-v8a",
    "armeabi-v7a",
    "armeabi"
  ],
  "changelog": [
    {
      "version": "0.5.0",
      "prs": [
        303
      ],
      "description": "Added device.archs attribute"
    }
  ]
}

`device.battery_level`

double PII: Maybe OTel: False

The battery level of the device as a percentage (0-100).

Example 100

Changelog

v0.5.0 #303 Added device.battery_level attribute

Raw JSON

{
  "key": "device.battery_level",
  "brief": "The battery level of the device as a percentage (0-100).",
  "type": "double",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": false,
  "example": 100,
  "changelog": [
    {
      "version": "0.5.0",
      "prs": [
        303
      ],
      "description": "Added device.battery_level attribute"
    }
  ]
}

`device.battery_temperature`

double PII: Maybe OTel: False

The battery temperature of the device in Celsius.

Example 25

Changelog

v0.5.0 #303 Added device.battery_temperature attribute

Raw JSON

{
  "key": "device.battery_temperature",
  "brief": "The battery temperature of the device in Celsius.",
  "type": "double",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": false,
  "example": 25,
  "changelog": [
    {
      "version": "0.5.0",
      "prs": [
        303
      ],
      "description": "Added device.battery_temperature attribute"
    }
  ]
}

`device.boot_time`

string PII: Maybe OTel: False

A formatted UTC timestamp when the system was booted.

Example 2018-02-08T12:52:12Z

Changelog

v0.5.0 #303 Added device.boot_time attribute

Raw JSON

{
  "key": "device.boot_time",
  "brief": "A formatted UTC timestamp when the system was booted.",
  "type": "string",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": false,
  "example": "2018-02-08T12:52:12Z",
  "changelog": [
    {
      "version": "0.5.0",
      "prs": [
        303
      ],
      "description": "Added device.boot_time attribute"
    }
  ]
}

`device.brand`

string PII: Maybe OTel: False

The brand of the device.

Example Apple

Changelog

v0.1.0 #116 #127

Raw JSON

{
  "key": "device.brand",
  "brief": "The brand of the device.",
  "type": "string",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": false,
  "example": "Apple",
  "changelog": [
    {
      "version": "0.1.0",
      "prs": [
        116,
        127
      ]
    }
  ]
}

`device.charging`

boolean PII: Maybe OTel: False

Whether the device was charging or not.

Example false

Changelog

v0.5.0 #303 Added device.charging attribute

Raw JSON

{
  "key": "device.charging",
  "brief": "Whether the device was charging or not.",
  "type": "boolean",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": false,
  "example": false,
  "changelog": [
    {
      "version": "0.5.0",
      "prs": [
        303
      ],
      "description": "Added device.charging attribute"
    }
  ]
}

`device.chipset`

string PII: Maybe OTel: False

The chipset of the device.

Example Qualcomm SM8550

Changelog

v0.5.0 #303 Added device.chipset attribute

Raw JSON

{
  "key": "device.chipset",
  "brief": "The chipset of the device.",
  "type": "string",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": false,
  "example": "Qualcomm SM8550",
  "changelog": [
    {
      "version": "0.5.0",
      "prs": [
        303
      ],
      "description": "Added device.chipset attribute"
    }
  ]
}

`device.class`

string PII: Maybe OTel: False

The classification of the device. For example, `low`, `medium`, or `high`. Typically inferred by Relay - SDKs generally do not need to set this directly.

Example medium

Changelog

v0.5.0 #300 Added device.class attribute

Raw JSON

{
  "key": "device.class",
  "brief": "The classification of the device. For example, `low`, `medium`, or `high`. Typically inferred by Relay - SDKs generally do not need to set this directly.",
  "type": "string",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": false,
  "example": "medium",
  "changelog": [
    {
      "version": "0.5.0",
      "prs": [
        300
      ],
      "description": "Added device.class attribute"
    }
  ]
}

`device.cpu_description`

string PII: Maybe OTel: False

A description of the CPU of the device.

Example Intel(R) Core(TM)2 Quad CPU Q6600 @ 2.40GHz

Changelog

v0.5.0 #303 Added device.cpu_description attribute

Raw JSON

{
  "key": "device.cpu_description",
  "brief": "A description of the CPU of the device.",
  "type": "string",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": false,
  "example": "Intel(R) Core(TM)2 Quad CPU Q6600 @ 2.40GHz",
  "changelog": [
    {
      "version": "0.5.0",
      "prs": [
        303
      ],
      "description": "Added device.cpu_description attribute"
    }
  ]
}

`device.external_free_storage`

integer PII: Maybe OTel: False

External storage free size in bytes.

Example 67108864000

Changelog

v0.5.0 #303 Added device.external_free_storage attribute

Raw JSON

{
  "key": "device.external_free_storage",
  "brief": "External storage free size in bytes.",
  "type": "integer",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": false,
  "example": 67108864000,
  "changelog": [
    {
      "version": "0.5.0",
      "prs": [
        303
      ],
      "description": "Added device.external_free_storage attribute"
    }
  ]
}

`device.external_storage_size`

integer PII: Maybe OTel: False

External storage total size in bytes.

Example 134217728000

Changelog

v0.5.0 #303 Added device.external_storage_size attribute

Raw JSON

{
  "key": "device.external_storage_size",
  "brief": "External storage total size in bytes.",
  "type": "integer",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": false,
  "example": 134217728000,
  "changelog": [
    {
      "version": "0.5.0",
      "prs": [
        303
      ],
      "description": "Added device.external_storage_size attribute"
    }
  ]
}

`device.family`

string PII: Maybe OTel: False

The family of the device.

Example iPhone

Changelog

v0.1.0 #116 #127

Raw JSON

{
  "key": "device.family",
  "brief": "The family of the device.",
  "type": "string",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": false,
  "example": "iPhone",
  "changelog": [
    {
      "version": "0.1.0",
      "prs": [
        116,
        127
      ]
    }
  ]
}

`device.free_memory`

integer PII: Maybe OTel: False

Free system memory in bytes.

Example 2147483648

Changelog

v0.5.0 #300 Added device.free_memory attribute

Raw JSON

{
  "key": "device.free_memory",
  "brief": "Free system memory in bytes.",
  "type": "integer",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": false,
  "example": 2147483648,
  "changelog": [
    {
      "version": "0.5.0",
      "prs": [
        300
      ],
      "description": "Added device.free_memory attribute"
    }
  ]
}

`device.free_storage`

integer PII: Maybe OTel: False

Free device storage in bytes.

Example 107374182400

Changelog

v0.5.0 #303 Added device.free_storage attribute

Raw JSON

{
  "key": "device.free_storage",
  "brief": "Free device storage in bytes.",
  "type": "integer",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": false,
  "example": 107374182400,
  "changelog": [
    {
      "version": "0.5.0",
      "prs": [
        303
      ],
      "description": "Added device.free_storage attribute"
    }
  ]
}

`device.id`

string PII: Maybe OTel: True

Unique device identifier.

Example a1b2c3d4-e5f6-7890-abcd-ef1234567890

Changelog

v0.5.0 #303 Added device.id attribute

Raw JSON

{
  "key": "device.id",
  "brief": "Unique device identifier.",
  "type": "string",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": true,
  "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "changelog": [
    {
      "version": "0.5.0",
      "prs": [
        303
      ],
      "description": "Added device.id attribute"
    }
  ]
}

`device.locale`

string PII: Maybe OTel: False

The locale of the device.

Example en-US

Changelog

v0.5.0 #303 Added device.locale attribute

Raw JSON

{
  "key": "device.locale",
  "brief": "The locale of the device.",
  "type": "string",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": false,
  "example": "en-US",
  "changelog": [
    {
      "version": "0.5.0",
      "prs": [
        303
      ],
      "description": "Added device.locale attribute"
    }
  ]
}

`device.low_memory`

boolean PII: Maybe OTel: False

Whether the device was low on memory.

Example false

Changelog

v0.5.0 #303 Added device.low_memory attribute

Raw JSON

{
  "key": "device.low_memory",
  "brief": "Whether the device was low on memory.",
  "type": "boolean",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": false,
  "example": false,
  "changelog": [
    {
      "version": "0.5.0",
      "prs": [
        303
      ],
      "description": "Added device.low_memory attribute"
    }
  ]
}

`device.low_power_mode`

boolean PII: False OTel: False

Whether the device is in Low Power Mode.

Example true

SDKs sentry.cocoa

Changelog

next #314 Added device.low_power_mode attribute

Raw JSON

{
  "key": "device.low_power_mode",
  "brief": "Whether the device is in Low Power Mode.",
  "type": "boolean",
  "pii": {
    "key": "false"
  },
  "is_in_otel": false,
  "example": true,
  "sdks": [
    "sentry.cocoa"
  ],
  "changelog": [
    {
      "version": "next",
      "prs": [
        314
      ],
      "description": "Added device.low_power_mode attribute"
    }
  ]
}

`device.manufacturer`

string PII: Maybe OTel: True

The manufacturer of the device.

Example Google

Changelog

v0.5.0 #303 Added device.manufacturer attribute

Raw JSON

{
  "key": "device.manufacturer",
  "brief": "The manufacturer of the device.",
  "type": "string",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": true,
  "example": "Google",
  "changelog": [
    {
      "version": "0.5.0",
      "prs": [
        303
      ],
      "description": "Added device.manufacturer attribute"
    }
  ]
}

`device.memory_size`

integer PII: Maybe OTel: False

Total system memory available in bytes.

Example 17179869184

Changelog

v0.5.0 #300 Added device.memory_size attribute

Raw JSON

{
  "key": "device.memory_size",
  "brief": "Total system memory available in bytes.",
  "type": "integer",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": false,
  "example": 17179869184,
  "changelog": [
    {
      "version": "0.5.0",
      "prs": [
        300
      ],
      "description": "Added device.memory_size attribute"
    }
  ]
}

`device.memory.estimated_capacity`

integer PII: Maybe OTel: False

The estimated total memory capacity of the device, only a rough estimation in gigabytes. Browsers report estimations in buckets of powers of 2, mostly capped at 8 GB

Example 8

Aliases deviceMemory

SDKs javascript-browser

Changelog

v0.5.0 #281 Added attribute device.memory.estimated_capacity to be used instead of deviceMemory

Raw JSON

{
  "key": "device.memory.estimated_capacity",
  "brief": "The estimated total memory capacity of the device, only a rough estimation in gigabytes. Browsers report estimations in buckets of powers of 2, mostly capped at 8 GB",
  "type": "integer",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": false,
  "example": 8,
  "alias": [
    "deviceMemory"
  ],
  "sdks": [
    "javascript-browser"
  ],
  "changelog": [
    {
      "version": "0.5.0",
      "prs": [
        281
      ],
      "description": "Added attribute device.memory.estimated_capacity to be used instead of deviceMemory"
    }
  ]
}

`device.model`

string PII: Maybe OTel: False

The model of the device.

Example iPhone 15 Pro Max

Changelog

v0.1.0 #116 #127

Raw JSON

{
  "key": "device.model",
  "brief": "The model of the device.",
  "type": "string",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": false,
  "example": "iPhone 15 Pro Max",
  "changelog": [
    {
      "version": "0.1.0",
      "prs": [
        116,
        127
      ]
    }
  ]
}

`device.model_id`

string PII: Maybe OTel: False

An internal hardware revision to identify the device exactly.

Example N861AP

Changelog

v0.5.0 #300 Added device.model_id attribute

Raw JSON

{
  "key": "device.model_id",
  "brief": "An internal hardware revision to identify the device exactly.",
  "type": "string",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": false,
  "example": "N861AP",
  "changelog": [
    {
      "version": "0.5.0",
      "prs": [
        300
      ],
      "description": "Added device.model_id attribute"
    }
  ]
}

`device.name`

string PII: Maybe OTel: False

The name of the device. On mobile, this is the user-assigned device name. On servers and desktops, this is typically the hostname.

Example localhost

Changelog

v0.5.0 #303 Added device.name attribute

Raw JSON

{
  "key": "device.name",
  "brief": "The name of the device. On mobile, this is the user-assigned device name. On servers and desktops, this is typically the hostname.",
  "type": "string",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": false,
  "example": "localhost",
  "changelog": [
    {
      "version": "0.5.0",
      "prs": [
        303
      ],
      "description": "Added device.name attribute"
    }
  ]
}

`device.online`

boolean PII: Maybe OTel: False

Whether the device was online or not.

Example true

Changelog

v0.5.0 #303 Added device.online attribute

Raw JSON

{
  "key": "device.online",
  "brief": "Whether the device was online or not.",
  "type": "boolean",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": false,
  "example": true,
  "changelog": [
    {
      "version": "0.5.0",
      "prs": [
        303
      ],
      "description": "Added device.online attribute"
    }
  ]
}

`device.orientation`

string PII: Maybe OTel: False

The orientation of the device, either "portrait" or "landscape".

Example portrait

Changelog

v0.5.0 #303 Added device.orientation attribute

Raw JSON

{
  "key": "device.orientation",
  "brief": "The orientation of the device, either \"portrait\" or \"landscape\".",
  "type": "string",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": false,
  "example": "portrait",
  "changelog": [
    {
      "version": "0.5.0",
      "prs": [
        303
      ],
      "description": "Added device.orientation attribute"
    }
  ]
}

`device.processor_count`

integer PII: Maybe OTel: False

Number of "logical processors".

Example 8

Aliases hardwareConcurrency

Changelog

v0.5.0 #300 Added and deprecated attribute device.processor_count in favor of device.cpu.logical_core_count

Raw JSON

{
  "key": "device.processor_count",
  "brief": "Number of \"logical processors\".",
  "type": "integer",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": false,
  "example": 8,
  "alias": [
    "hardwareConcurrency"
  ],
  "changelog": [
    {
      "version": "0.5.0",
      "prs": [
        300
      ],
      "description": "Added and deprecated attribute device.processor_count in favor of device.cpu.logical_core_count"
    }
  ]
}

`device.processor_frequency`

double PII: Maybe OTel: False

Processor frequency in MHz.

Example 2400

Changelog

v0.5.0 #303 Added device.processor_frequency attribute

Raw JSON

{
  "key": "device.processor_frequency",
  "brief": "Processor frequency in MHz.",
  "type": "double",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": false,
  "example": 2400,
  "changelog": [
    {
      "version": "0.5.0",
      "prs": [
        303
      ],
      "description": "Added device.processor_frequency attribute"
    }
  ]
}

`device.screen_density`

double PII: Maybe OTel: False

The screen density of the device.

Example 2.625

Changelog

v0.5.0 #303 Added device.screen_density attribute

Raw JSON

{
  "key": "device.screen_density",
  "brief": "The screen density of the device.",
  "type": "double",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": false,
  "example": 2.625,
  "changelog": [
    {
      "version": "0.5.0",
      "prs": [
        303
      ],
      "description": "Added device.screen_density attribute"
    }
  ]
}

`device.screen_dpi`

integer PII: Maybe OTel: False

The screen density in dots-per-inch (DPI) of the device.

Example 420

Changelog

v0.5.0 #303 Added device.screen_dpi attribute

Raw JSON

{
  "key": "device.screen_dpi",
  "brief": "The screen density in dots-per-inch (DPI) of the device.",
  "type": "integer",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": false,
  "example": 420,
  "changelog": [
    {
      "version": "0.5.0",
      "prs": [
        303
      ],
      "description": "Added device.screen_dpi attribute"
    }
  ]
}

`device.screen_height_pixels`

integer PII: Maybe OTel: False

The height of the device screen in pixels.

Example 2400

Changelog

v0.5.0 #303 Added device.screen_height_pixels attribute

Raw JSON

{
  "key": "device.screen_height_pixels",
  "brief": "The height of the device screen in pixels.",
  "type": "integer",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": false,
  "example": 2400,
  "changelog": [
    {
      "version": "0.5.0",
      "prs": [
        303
      ],
      "description": "Added device.screen_height_pixels attribute"
    }
  ]
}

`device.screen_width_pixels`

integer PII: Maybe OTel: False

The width of the device screen in pixels.

Example 1080

Changelog

v0.5.0 #303 Added device.screen_width_pixels attribute

Raw JSON

{
  "key": "device.screen_width_pixels",
  "brief": "The width of the device screen in pixels.",
  "type": "integer",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": false,
  "example": 1080,
  "changelog": [
    {
      "version": "0.5.0",
      "prs": [
        303
      ],
      "description": "Added device.screen_width_pixels attribute"
    }
  ]
}

`device.simulator`

boolean PII: False OTel: False

Whether the device is a simulator or an actual device.

Example false

Changelog

v0.5.0 #300 Added device.simulator attribute

Raw JSON

{
  "key": "device.simulator",
  "brief": "Whether the device is a simulator or an actual device.",
  "type": "boolean",
  "pii": {
    "key": "false"
  },
  "is_in_otel": false,
  "example": false,
  "changelog": [
    {
      "version": "0.5.0",
      "prs": [
        300
      ],
      "description": "Added device.simulator attribute"
    }
  ]
}

`device.storage_size`

integer PII: Maybe OTel: False

Total device storage in bytes.

Example 274877906944

Changelog

v0.5.0 #303 Added device.storage_size attribute

Raw JSON

{
  "key": "device.storage_size",
  "brief": "Total device storage in bytes.",
  "type": "integer",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": false,
  "example": 274877906944,
  "changelog": [
    {
      "version": "0.5.0",
      "prs": [
        303
      ],
      "description": "Added device.storage_size attribute"
    }
  ]
}

`device.thermal_state`

string PII: Maybe OTel: False

The thermal state of the device. Based on Apple's `ProcessInfo.ThermalState` enum: `nominal`, `fair`, `serious`, or `critical`.

Example nominal

Changelog

v0.5.0 #303 Added device.thermal_state attribute

Raw JSON

{
  "key": "device.thermal_state",
  "brief": "The thermal state of the device. Based on Apple's `ProcessInfo.ThermalState` enum: `nominal`, `fair`, `serious`, or `critical`.",
  "type": "string",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": false,
  "example": "nominal",
  "changelog": [
    {
      "version": "0.5.0",
      "prs": [
        303
      ],
      "description": "Added device.thermal_state attribute"
    }
  ]
}

`device.timezone`

string PII: Maybe OTel: False

The timezone of the device.

Example Europe/Vienna

Changelog

v0.5.0 #303 Added device.timezone attribute

Raw JSON

{
  "key": "device.timezone",
  "brief": "The timezone of the device.",
  "type": "string",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": false,
  "example": "Europe/Vienna",
  "changelog": [
    {
      "version": "0.5.0",
      "prs": [
        303
      ],
      "description": "Added device.timezone attribute"
    }
  ]
}

`device.usable_memory`

integer PII: Maybe OTel: False

Memory usable for the app in bytes.

Example 2147483648

Changelog

v0.5.0 #303 Added device.usable_memory attribute

Raw JSON

{
  "key": "device.usable_memory",
  "brief": "Memory usable for the app in bytes.",
  "type": "integer",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": false,
  "example": 2147483648,
  "changelog": [
    {
      "version": "0.5.0",
      "prs": [
        303
      ],
      "description": "Added device.usable_memory attribute"
    }
  ]
}

Deprecated Attributes

These attributes are deprecated and should not be used in new code. See each attribute for migration guidance.

`device.connection_type` Deprecated

string PII: Maybe OTel: False

The internet connection type currently being used by the device.

Example wifi

Aliases network.connection.typeconnectionType

Use network.connection.type instead.

This attribute is being deprecated in favor of network.connection.type

Status: backfill

Changelog

v0.5.0 #303 Added and deprecated device.connection_type in favor of network.connection.type

Raw JSON

{
  "key": "device.connection_type",
  "brief": "The internet connection type currently being used by the device.",
  "type": "string",
  "pii": {
    "key": "maybe"
  },
  "is_in_otel": false,
  "example": "wifi",
  "deprecation": {
    "replacement": "network.connection.type",
    "reason": "This attribute is being deprecated in favor of network.connection.type",
    "_status": "backfill"
  },
  "alias": [
    "network.connection.type",
    "connectionType"
  ],
  "changelog": [
    {
      "version": "0.5.0",
      "prs": [
        303
      ],
      "description": "Added and deprecated device.connection_type in favor of network.connection.type"
    }
  ]
}

Device Attributes

Stable Attributes

Deprecated Attributes

device.connection_type Deprecated

`device.connection_type` Deprecated