From 2790052c2f7edfc564e37e3fea30d9e4cffc062b Mon Sep 17 00:00:00 2001 From: ladd Date: Thu, 4 Nov 2021 13:59:43 -0700 Subject: [PATCH 1/7] Update device.md Proposed manufacturer field --- specification/resource/semantic_conventions/device.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/specification/resource/semantic_conventions/device.md b/specification/resource/semantic_conventions/device.md index c0f936959b6..bc8d88415f0 100644 --- a/specification/resource/semantic_conventions/device.md +++ b/specification/resource/semantic_conventions/device.md @@ -12,10 +12,14 @@ | `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.name` | 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. - \ No newline at end of file + +**[4]:** Android devices provide this field via [Build](https://developer.android.com/reference/android/os/Build#MANUFACTURER) + + From f5837208da144dca77bb974a0bfb682ebb226c06 Mon Sep 17 00:00:00 2001 From: ladd Date: Fri, 5 Nov 2021 11:56:02 -0700 Subject: [PATCH 2/7] Update device.md --- specification/resource/semantic_conventions/device.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/resource/semantic_conventions/device.md b/specification/resource/semantic_conventions/device.md index bc8d88415f0..46b20cb2c04 100644 --- a/specification/resource/semantic_conventions/device.md +++ b/specification/resource/semantic_conventions/device.md @@ -12,7 +12,7 @@ | `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.name` | string | The name of the device manufacturer [4] | `Apple`; `Samsung` | 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. From c2e467033fac945bf253e352dbbb78bcd4543ef3 Mon Sep 17 00:00:00 2001 From: Ladd Van Tol Date: Tue, 16 Nov 2021 09:50:23 -0800 Subject: [PATCH 3/7] Generate tables --- semantic_conventions/resource/device.yaml | 6 ++++++ specification/resource/semantic_conventions/device.md | 1 - 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/semantic_conventions/resource/device.yaml b/semantic_conventions/resource/device.yaml index 6035a4b2da9..f627eed9b53 100644 --- a/semantic_conventions/resource/device.yaml +++ b/semantic_conventions/resource/device.yaml @@ -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: > + Android devices provide this field via [Build](https://developer.android.com/reference/android/os/Build#MANUFACTURER) + examples: ['Apple', 'Samsung'] diff --git a/specification/resource/semantic_conventions/device.md b/specification/resource/semantic_conventions/device.md index 46b20cb2c04..5aa7b4b22d8 100644 --- a/specification/resource/semantic_conventions/device.md +++ b/specification/resource/semantic_conventions/device.md @@ -21,5 +21,4 @@ **[3]:** It's recommended this value represents a human readable version of the device model rather than a machine readable alternative. **[4]:** Android devices provide this field via [Build](https://developer.android.com/reference/android/os/Build#MANUFACTURER) - From c7a7ac09c92f255496b77d7fdd189dd98608696e Mon Sep 17 00:00:00 2001 From: Ladd Van Tol Date: Thu, 2 Dec 2021 14:55:38 -0800 Subject: [PATCH 4/7] PR comments --- CHANGELOG.md | 4 +++- semantic_conventions/resource/device.yaml | 2 +- specification/resource/semantic_conventions/device.md | 2 +- 3 files changed, 5 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a7adb0efdc2..1d9f60c0430 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -68,7 +68,9 @@ release. - Add `none` as a possible value for `OTEL_PROPAGATORS` to disable context propagation. ([#2052](https://github.com/open-telemetry/opentelemetry-specification/pull/2052)) - +- Add `device.manufacturer` to describe mobile device manufacturers + ([2100](https://github.com/open-telemetry/opentelemetry-specification/pull/2100)) + ### Traces - No changes. diff --git a/semantic_conventions/resource/device.yaml b/semantic_conventions/resource/device.yaml index f627eed9b53..05238c9a844 100644 --- a/semantic_conventions/resource/device.yaml +++ b/semantic_conventions/resource/device.yaml @@ -36,5 +36,5 @@ groups: type: string brief: 'The name of the device manufacturer' note: > - Android devices provide this field via [Build](https://developer.android.com/reference/android/os/Build#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`. examples: ['Apple', 'Samsung'] diff --git a/specification/resource/semantic_conventions/device.md b/specification/resource/semantic_conventions/device.md index 5aa7b4b22d8..26fe7fb5cd0 100644 --- a/specification/resource/semantic_conventions/device.md +++ b/specification/resource/semantic_conventions/device.md @@ -20,5 +20,5 @@ **[3]:** It's recommended this value represents a human readable version of the device model rather than a machine readable alternative. -**[4]:** Android devices provide this field via [Build](https://developer.android.com/reference/android/os/Build#MANUFACTURER) +**[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`. From 06180757c30634e6d7013a4067c13c76be48045c Mon Sep 17 00:00:00 2001 From: Ladd Van Tol Date: Tue, 14 Dec 2021 16:05:44 -0800 Subject: [PATCH 5/7] Remove trailing whitespace --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1d9f60c0430..a4baafc4b63 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -70,7 +70,7 @@ release. ([#2052](https://github.com/open-telemetry/opentelemetry-specification/pull/2052)) - Add `device.manufacturer` to describe mobile device manufacturers ([2100](https://github.com/open-telemetry/opentelemetry-specification/pull/2100)) - + ### Traces - No changes. From 43bc0e12c6825ebbaa7d36dc2d9c2c434a809029 Mon Sep 17 00:00:00 2001 From: ladd Date: Wed, 15 Dec 2021 09:57:04 -0800 Subject: [PATCH 6/7] Update CHANGELOG.md Make linter happy? --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a4baafc4b63..beda3370792 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -68,7 +68,7 @@ release. - Add `none` as a possible value for `OTEL_PROPAGATORS` to disable context propagation. ([#2052](https://github.com/open-telemetry/opentelemetry-specification/pull/2052)) -- Add `device.manufacturer` to describe mobile device manufacturers +- Add `device.manufacturer` to describe mobile device manufacturers. ([2100](https://github.com/open-telemetry/opentelemetry-specification/pull/2100)) ### Traces From cd01699149f279d0f31a1dd94bbae79239195ec9 Mon Sep 17 00:00:00 2001 From: Ladd Van Tol Date: Wed, 15 Dec 2021 13:38:48 -0800 Subject: [PATCH 7/7] Fix merge --- CHANGELOG.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index beda3370792..1f8230c7184 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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 @@ -68,8 +70,6 @@ release. - Add `none` as a possible value for `OTEL_PROPAGATORS` to disable context propagation. ([#2052](https://github.com/open-telemetry/opentelemetry-specification/pull/2052)) -- Add `device.manufacturer` to describe mobile device manufacturers. - ([2100](https://github.com/open-telemetry/opentelemetry-specification/pull/2100)) ### Traces