Package io.opentelemetry.semconv.incubating

Class DeviceIncubatingAttributes

java.lang.Object
io.opentelemetry.semconv.incubating.DeviceIncubatingAttributes
public final class DeviceIncubatingAttributes extends Object

  • Field Details

    • DEVICE_ID

      public static final io.opentelemetry.api.common.AttributeKey<String> DEVICE_ID
      A unique identifier representing the device

      Notes:

      Its value SHOULD be identical for all apps on a device and it SHOULD NOT change if an app is uninstalled and re-installed. However, it might be resettable by the user for all apps on a device. Hardware IDs (e.g. vendor-specific serial number, IMEI or MAC address) MAY be used as values.

      More information about Android identifier best practices can be found in the Android user data IDs guide.

      [!WARNING]

      This attribute may contain sensitive (PII) information. 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.

      Due to these reasons, this identifier is not recommended for consumer applications and will likely result in rejection from both Google Play and App Store. However, it may be appropriate for specific enterprise scenarios, such as kiosk devices or enterprise-managed devices, with appropriate compliance clearance. Any instrumentation providing this identifier MUST implement it as an opt-in feature.

      See app.installation.id for a more privacy-preserving alternative.

    • DEVICE_MANUFACTURER

      public static final io.opentelemetry.api.common.AttributeKey<String> DEVICE_MANUFACTURER
      The name of the device manufacturer

      Notes:

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

    • DEVICE_MODEL_IDENTIFIER

      public static final io.opentelemetry.api.common.AttributeKey<String> DEVICE_MODEL_IDENTIFIER
      The model identifier for the device

      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.

    • DEVICE_MODEL_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> DEVICE_MODEL_NAME
      The marketing name for the device model

      Notes:

      It's recommended this value represents a human-readable version of the device model rather than a machine-readable alternative.