App

Status: Development

This document defines events related to client-side applications (e.g. web apps or mobile apps).

Click Events

Event: app.screen.click

Status:

The event name MUST be app.screen.click.

This event represents an instantaneous click on the screen of an application.

The app.screen.click event can be used to indicate that a user has clicked or tapped on the screen portion of an application. Clicks outside of an application’s active area SHOULD NOT generate this event. This event does not differentiate between touch/mouse down and touch/mouse up. Implementations SHOULD give preference to generating this event at the time the click is complete, typically on touch release or mouse up. The location of the click event MUST be provided in absolute screen pixels.

Attribute	Type	Description	Examples	Requirement Level	Stability
app.screen.coordinate.x	int	The x (horizontal) coordinate of a screen coordinate, in screen pixels.	0; 131	Required
app.screen.coordinate.y	int	The y (vertical) component of a screen coordinate, in screen pixels.	12; 99	Required

Event: app.widget.click

Status:

The event name MUST be app.widget.click.

This event indicates that an application widget has been clicked.

Use this event to indicate that visual application component has been clicked, typically through a user’s manual interaction.

Attribute	Type	Description	Examples	Requirement Level	Stability
app.widget.id	string	An identifier that uniquely differentiates this widget from other widgets in the same application. [1]	f9bc787d-ff05-48ad-90e1-fca1d46130b3; submit_order_1829	Required
app.screen.coordinate.x	int	The x (horizontal) coordinate of a screen coordinate, in screen pixels.	0; 131	Opt-In
app.screen.coordinate.y	int	The y (vertical) component of a screen coordinate, in screen pixels.	12; 99	Opt-In
app.widget.name	string	The name of an application widget. [2]	submit; attack; Clear Cart	Opt-In

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

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

Jank Event

Event: app.jank

Jank is a disruption in UI rendering, resulting in a display that can feel sluggish or even unresponsive/frozen. Applications that are able to detect jank can report it with the following events:

Status:

The event name MUST be app.jank.

This event indicates that the application has detected substandard UI rendering performance.

Jank happens when the UI is rendered slowly enough for the user to experience some disruption or sluggishness.

Attribute	Type	Description	Examples	Requirement Level	Stability
app.jank.frame_count	int	A number of frame renders that experienced jank. [1]	9; 42	Recommended
app.jank.period	double	The time period, in seconds, for which this jank is being reported.	1.0; 5.0; 10.24	Recommended
app.jank.threshold	double	The minimum rendering threshold for this jank, in seconds.	0.016; 0.7; 1.024	Recommended

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

Attributes

See the app attributes registry for all application-related attributes that may appear on telemetry items.