Semantic conventions for browser events

Status: Development

This document defines semantic conventions for browser (web) instrumentations that emit events.

WebVital Event

Status: Development

The event name MUST be browser.web_vital.

This event describes the website performance metrics introduced by Google, See web vitals.

Body fields:

:warning: Body fields will be moved to complex attributes once the semantic convention tooling supports complex attributes (see #1870).

Body FieldTypeDescriptionExamplesRequirement LevelStability
deltadoubleThe delta between the current value and the last-reported value. See delta.0.2RequiredDevelopment
idstringA unique ID representing this particular metric instance.v3-1677874579383-6381583661209RequiredDevelopment
nameenumName of the web vital.clsRequiredDevelopment
valuedoubleValue of the web vital.1.0RequiredDevelopment

name has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

ValueDescriptionStability
clsCumulative Layout Shift. See cls.Development
fidFirst Input Delay. See fid.Development
inpInteration to Next Paint. See inp.Development
lcpLargest Contentful Paint. See lcp.Development