open-telemetry
/
semantic-conventions
mirror of https://github.com/open-telemetry/semantic-conventions.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add `device.manufacturer` to semantic conventions for resources (#2100) 

* Update device.md

Proposed manufacturer field

* Update device.md

* Generate tables

* PR comments

* Remove trailing whitespace

* Update CHANGELOG.md

Make linter happy?

* Fix merge

Co-authored-by: Josh Suereth <joshuasuereth@google.com>
This commit is contained in:
ladd 2021-12-15 16:22:56 -08:00 committed by GitHub
parent fccbbba116
commit 3b50032ecc
2 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
semantic_conventions/resource/device.yaml
View File

@ -32,3 +32,9 @@ groups:
It's recommended this value represents a human readable version of the It's recommended this value represents a human readable version of the
device model rather than a machine readable alternative. device model rather than a machine readable alternative.
examples: ['iPhone 6s Plus', 'Samsung Galaxy S6'] examples: ['iPhone 6s Plus', 'Samsung Galaxy S6']
- id: manufacturer
type: string
brief: 'The name of the device manufacturer'
note: >
The Android OS provides this field via [Build](https://developer.android.com/reference/android/os/Build#MANUFACTURER). iOS apps SHOULD hardcode the value `Apple`.
examples: ['Apple', 'Samsung']

5
specification/resource/semantic_conventions/device.md
View File

@ -12,10 +12,13 @@
| `device.id` | string | A unique identifier representing the device [1] | `2ab2916d-a51f-4ac8-80ee-45ac31a28092` | No | | `device.id` | string | A unique identifier representing the device [1] | `2ab2916d-a51f-4ac8-80ee-45ac31a28092` | No |
| `device.model.identifier` | 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 | | `device.model.name` | string | The marketing name for the device model [3] | `iPhone 6s Plus`; `Samsung Galaxy S6` | No |
| `device.manufacturer` | string | The name of the device manufacturer [4] | `Apple`; `Samsung` | No |
**[1]:** The device identifier MUST only be defined using the values outlined below. This value is not an advertising identifier and MUST NOT be used as such. On iOS (Swift or Objective-C), this value MUST be equal to the [vendor identifier](https://developer.apple.com/documentation/uikit/uidevice/1620059-identifierforvendor). On Android (Java or Kotlin), this value MUST be equal to the Firebase Installation ID or a globally unique UUID which is persisted across sessions in your application. More information can be found [here](https://developer.android.com/training/articles/user-data-ids) on best practices and exact implementation details. 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. **[1]:** The device identifier MUST only be defined using the values outlined below. This value is not an advertising identifier and MUST NOT be used as such. On iOS (Swift or Objective-C), this value MUST be equal to the [vendor identifier](https://developer.apple.com/documentation/uikit/uidevice/1620059-identifierforvendor). On Android (Java or Kotlin), this value MUST be equal to the Firebase Installation ID or a globally unique UUID which is persisted across sessions in your application. More information can be found [here](https://developer.android.com/training/articles/user-data-ids) on best practices and exact implementation details. 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. **[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. **[3]:** It's recommended this value represents a human readable version of the device model rather than a machine readable alternative.
<!-- endsemconv -->
**[4]:** The Android OS provides this field via [Build](https://developer.android.com/reference/android/os/Build#MANUFACTURER). iOS apps SHOULD hardcode the value `Apple`.
<!-- endsemconv -->