Semantic conventions for browser events #3286
Conversation
| | Value | Description | | ||
| |---|---| | ||
| | `0` | physical_page | | ||
| | `1` | virtual_page | |
There was a problem hiding this comment.
It might be worth calling out what is meant by virtual page so that non client readers understand a bit better.
ie.
- physical_page -> Initial page load within the browser and will generally also precede a
PageNavigationTimingevent. - virtual_page -> This is for Single Page Applications (SPA) where the framework provides the ability to perform client side only page "navigation", the exact definition of what a virtual page change is determined by the SPA and the framework it is using.
|
|
||
| **Event name**:`page_navigation_timing` | ||
|
|
||
| This event may be represented in a Span Event on the Span representing the |
There was a problem hiding this comment.
No, this is an event definition.
You have already called out above that events may be sent as a Log Event or Span Event and this event is no different.
And this document is about the definitions (semantic conventions) of events
|
|
||
| **Event name**:`http_request_timing` | ||
|
|
||
| This event may be represented using a Span Event on the Spans represening HTTP |
There was a problem hiding this comment.
Same again, please remove the "Span Event" wording.
I would prefer to have at the top level (where you mention that events may be Logs or Span events), to include wording along the lines that All Events even when passed as a Log Event may be linked to the current span to group all relevant events together.
There was a problem hiding this comment.
As all event (should) have the option to be associated with a Span
|
This PR was marked stale due to lack of activity. It will be closed in 7 days. |
|
|
||
| ### WebVital | ||
|
|
||
| **Event name**:`web_vital` |
There was a problem hiding this comment.
Where are the codesCLS, LCP, and FID defined?
There was a problem hiding this comment.
@jmacd Those are the possible values for name in the payload for the web_vital event.
|
Closed as inactive. Feel free to reopen if this PR is still being worked on. |
| |responseStart | long | || Recommended | | ||
| |responseEnd | long | || Recommended | | ||
|
|
||
| ### HttpRequestTiming |
There was a problem hiding this comment.
I think this event can be removed because HTTP requests would also be covered as ResourceTiming events.
There was a problem hiding this comment.
@martinkuba what about the fields within these 2 events - they seem to be a bit different - can you review them both and let me know what fields would be there in the consolidated event?
|
@open-telemetry/spec-approvers can someone reopen this PR? thanks. |
There was a problem hiding this comment.
Please move this to https://github.com/open-telemetry/semantic-conventions
|
This PR is moved to open-telemetry/semantic-conventions#30 |
Changes
Introduces semantic conventions for events emitted by browser instrumentations. This document serves more for the purpose as a schema for the events than the semantic conventions as supported in Otel today.
This is also added in the spec repo and not in the javascript language repo, as WASM enables the possibility of browser instrumentations in more languages than just JavaScript.
Related PRs #2926