Device Attributes

{
  "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
      ]
    }
  ]
}

{
  "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": "next",
      "prs": [
        300
      ],
      "description": "Added device.class attribute"
    }
  ]
}

{
  "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
      ]
    }
  ]
}

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

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

{
  "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": "next",
      "prs": [
        281
      ],
      "description": "Added attribute device.memory.estimated_capacity to be used instead of deviceMemory"
    }
  ]
}

{
  "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
      ]
    }
  ]
}

{
  "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": "next",
      "prs": [
        300
      ],
      "description": "Added device.model_id attribute"
    }
  ]
}

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

{
  "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": "next",
      "prs": [
        300
      ],
      "description": "Added device.simulator attribute"
    }
  ]
}