Separate model.name and model.identifier, add GDPR notice

open-telemetry · Apr 7, 2021 · ade0407 · ade0407
1 parent ca04459
commit ade0407
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 6 deletions.
diff --git a/semantic_conventions/resource/device.yaml b/semantic_conventions/resource/device.yaml
@@ -8,13 +8,24 @@ groups:
         type: string
         brief: 'A unique identifier representing the device'
         note: >
-          For example, in an iOS application this might be the 
+          For example, in an iOS application this might be the
           [vendor identifier](https://developer.apple.com/documentation/uikit/uidevice/1620059-identifierforvendor).
+          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.
         examples: ['2ab2916d-a51f-4ac8-80ee-45ac31a28092']
-      - id: model
+      - id: model.identifier
         type: string
         brief: 'The model identifier for the device'
         note: >
-          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.
+          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.
         examples: ['iPhone3,4', 'SM-G920F']
+      - id: model.name
+        type: string
+        brief: 'The marketing name for the device model'
+        note: >
+          It's recommended this value represents a human readable version of the
+          device model rather than a machine readable alternative.
+        examples: ['iPhone 6s Plus', 'Samsung Galaxy S6']
diff --git a/specification/resource/semantic_conventions/device.md b/specification/resource/semantic_conventions/device.md
@@ -10,9 +10,12 @@
 | Attribute  | Type | Description  | Examples  | Required |
 |---|---|---|---|---|
 | `device.id` | string | A unique identifier representing the device [1] | `2ab2916d-a51f-4ac8-80ee-45ac31a28092` | No |
-| `device.model` | string | The model identifier for the device [2] | `iPhone3,4`; `SM-G920F` | No |
+| `device.model.identifier` | string | The model identifier for the device [2] | `iPhone3,4`; `SM-G920F` | No |
+| `device.model.name` | string | The marketing name for the device model [3] | `iPhone 6s Plus`; `Samsung Galaxy S6` | No |
 
-**[1]:** For example, in an iOS application this might be the  [vendor identifier](https://developer.apple.com/documentation/uikit/uidevice/1620059-identifierforvendor).
+**[1]:** For example, in an iOS application this might be the [vendor identifier](https://developer.apple.com/documentation/uikit/uidevice/1620059-identifierforvendor). 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.
 
 **[2]:** 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]:** It's recommended this value represents a human readable version of the device model rather than a machine readable alternative.
 <!-- endsemconv -->