Skip to content

Commit

Permalink
Add device.manufacturer to semantic conventions for resources (#2100)
Browse files Browse the repository at this point in the history
* 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>
  • Loading branch information
ladd and jsuereth authored Dec 16, 2021
1 parent 90c3633 commit 86b4585
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 1 deletion.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,8 @@ release.

- Prohibit usage of retired names in semantic conventions.
([#2191](https://github.com/open-telemetry/opentelemetry-specification/pull/2191))
- Add `device.manufacturer` to describe mobile device manufacturers.
([2100](https://github.com/open-telemetry/opentelemetry-specification/pull/2100))

### Compatibility

Expand Down
6 changes: 6 additions & 0 deletions semantic_conventions/resource/device.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,9 @@ groups:
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']
- 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 changes: 4 additions & 1 deletion specification/resource/semantic_conventions/device.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,13 @@
| `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.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.

**[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 -->

**[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 -->

0 comments on commit 86b4585

Please sign in to comment.