View Source OpenTelemetry.SemConv.Incubating.DeviceAttributes (OpenTelemetry.SemConv v1.27.0)

OpenTelemetry Semantic Conventions for Device attributes.

Summary

Functions

A unique identifier representing the device

The name of the device manufacturer

The model identifier for the device

The marketing name for the device model

Functions

@spec device_id() :: :"device.id"

A unique identifier representing the device

Value type

Value must be of type atom() | String.t().

Notes

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. 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 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.

Examples

["2ab2916d-a51f-4ac8-80ee-45ac31a28092"]
iex> OpenTelemetry.SemConv.Incubating.DeviceAttributes.device_id()
:"device.id"
@spec device_manufacturer() :: :"device.manufacturer"

The name of the device manufacturer

Value type

Value must be of type atom() | String.t().

Notes

The Android OS provides this field via Build. iOS apps SHOULD hardcode the value Apple.

Examples

["Apple", "Samsung"]
iex> OpenTelemetry.SemConv.Incubating.DeviceAttributes.device_manufacturer()
:"device.manufacturer"
Link to this function

device_model_identifier()

View Source
@spec device_model_identifier() :: :"device.model.identifier"

The model identifier for the device

Value type

Value must be of type atom() | String.t().

Notes

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"]
iex> OpenTelemetry.SemConv.Incubating.DeviceAttributes.device_model_identifier()
:"device.model.identifier"
@spec device_model_name() :: :"device.model.name"

The marketing name for the device model

Value type

Value must be of type atom() | String.t().

Notes

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"]
iex> OpenTelemetry.SemConv.Incubating.DeviceAttributes.device_model_name()
:"device.model.name"