semantic-conventions/docs/registry/attributes/app.md

4.4 KiB

App

Application Attributes

Describes attributes related to client-side applications (e.g. web apps or mobile apps).

Attribute Type Description Examples Stability
app.build_id string Unique identifier for a particular build or compilation of the application. 6cff0a7e-cefc-4668-96f5-1273d8b334d0; 9f2b833506aa6973a92fde9733e6271f; my-app-1.0.0-code-123 Development
app.installation.id string A unique identifier representing the installation of an application on a specific device [1] 2ab2916d-a51f-4ac8-80ee-45ac31a28092 Development
app.jank.frame_count int A number of frame renders that experienced jank. [2] 9; 42 Development
app.jank.period double The time period, in seconds, for which this jank is being reported. 1.0; 5.0; 10.24 Development
app.jank.threshold double The minimum rendering threshold for this jank, in seconds. 0.016; 0.7; 1.024 Development
app.screen.coordinate.x int The x (horizontal) coordinate of a screen coordinate, in screen pixels. 0; 131 Development
app.screen.coordinate.y int The y (vertical) component of a screen coordinate, in screen pixels. 12; 99 Development
app.widget.id string An identifier that uniquely differentiates this widget from other widgets in the same application. [3] f9bc787d-ff05-48ad-90e1-fca1d46130b3; submit_order_1829 Development
app.widget.name string The name of an application widget. [4] submit; attack; Clear Cart Development

[1] app.installation.id: Its value SHOULD persist across launches of the same application installation, including through application upgrades. It SHOULD change if the application is uninstalled or if all applications of the vendor are uninstalled. Additionally, users might be able to reset this value (e.g. by clearing application data). If an app is installed multiple times on the same device (e.g. in different accounts on Android), each app.installation.id SHOULD have a different value. If multiple OpenTelemetry SDKs are used within the same application, they SHOULD use the same value for app.installation.id. Hardware IDs (e.g. serial number, IMEI, MAC address) MUST NOT be used as the app.installation.id.

For iOS, this value SHOULD be equal to the vendor identifier.

For Android, examples of app.installation.id implementations include:

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

[2] app.jank.frame_count: Depending on platform limitations, the value provided MAY be approximation.

[3] app.widget.id: A widget is an application component, typically an on-screen visual GUI element.

[4] app.widget.name: A widget is an application component, typically an on-screen visual GUI element.