53 lines
3.4 KiB
Markdown
53 lines
3.4 KiB
Markdown
<!-- NOTE: THIS FILE IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
|
|
<!-- see templates/registry/markdown/entity_namespace.md.j2 -->
|
|
<!-- markdownlint-capture -->
|
|
<!-- markdownlint-disable -->
|
|
|
|
# Device
|
|
|
|
## Device
|
|
|
|
**Status:** 
|
|
|
|
**type:** `device`
|
|
|
|
**Description:** The device on which the process represented by this resource is running.
|
|
|
|
**Other Attributes:**
|
|
|
|
> :warning: This entity definition contains attributes without a role.
|
|
> Stable Entities MUST NOT have attributes without a defined role.
|
|
|
|
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
|
|
|---|---|---|---|---|---|
|
|
| [`device.manufacturer`](/docs/registry/attributes/device.md) | string | The name of the device manufacturer [1] | `Apple`; `Samsung` | `Recommended` |  |
|
|
| [`device.model.identifier`](/docs/registry/attributes/device.md) | string | The model identifier for the device [2] | `iPhone3,4`; `SM-G920F` | `Recommended` |  |
|
|
| [`device.model.name`](/docs/registry/attributes/device.md) | string | The marketing name for the device model [3] | `iPhone 6s Plus`; `Samsung Galaxy S6` | `Recommended` |  |
|
|
| [`device.id`](/docs/registry/attributes/device.md) | string | A unique identifier representing the device [4] | `123456789012345`; `01:23:45:67:89:AB` | `Opt-In` |  |
|
|
|
|
**[1] `device.manufacturer`:** The Android OS provides this field via [Build](https://developer.android.com/reference/android/os/Build#MANUFACTURER). iOS apps SHOULD hardcode the value `Apple`.
|
|
|
|
**[2] `device.model.identifier`:** It's recommended this value represents a machine-readable version of the model identifier rather than the market or consumer-friendly name of the device.
|
|
|
|
**[3] `device.model.name`:** It's recommended this value represents a human-readable version of the device model rather than a machine-readable alternative.
|
|
|
|
**[4] `device.id`:** Its value SHOULD be identical for all apps on a device and it SHOULD NOT change if an app is uninstalled and re-installed.
|
|
However, it might be resettable by the user for all apps on a device.
|
|
Hardware IDs (e.g. vendor-specific serial number, IMEI or MAC address) MAY be used as values.
|
|
|
|
More information about Android identifier best practices can be found [here](https://developer.android.com/training/articles/user-data-ids).
|
|
|
|
> [!WARNING]
|
|
>
|
|
> This attribute may contain sensitive (PII) information. Caution should be taken when storing personal data or anything which can identify a user. GDPR and data protection laws may apply,
|
|
> ensure you do your own due diligence.
|
|
>
|
|
> Due to these reasons, this identifier is not recommended for consumer applications and will likely result in rejection from both Google Play and App Store.
|
|
> However, it may be appropriate for specific enterprise scenarios, such as kiosk devices or enterprise-managed devices, with appropriate compliance clearance.
|
|
> Any instrumentation providing this identifier MUST implement it as an opt-in feature.
|
|
>
|
|
> See [`app.installation.id`](/docs/registry/attributes/app.md#app-installation-id) for a more privacy-preserving alternative.
|
|
|
|
|
|
<!-- markdownlint-restore -->
|