Semantic conventions for browser events #30
Conversation
…entations. This document serves more for the purpose as a schema for the events than the semantic conventions as supported in Otel today. Related PRs open-telemetry/opentelemetry-specification#2926
|
Also, the conventions need to be introduced in a |
| |---|---| | ||
| | `0` | physical_page - Initial page load within the browser and will generally also precede a PageNavigationTiming event.| | ||
| | `1` | 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.| | ||
|
|
There was a problem hiding this comment.
Should we have an attribute to show the change in state that happened on soft navigation (virtual pages) like pushState and replaceState. Name can be changeState
|
|
||
| ### ResourceTiming | ||
|
|
||
| **Event name**:`resource_timing` |
There was a problem hiding this comment.
Shouldn't this include an attribute denoting the resource that was fetched?
There was a problem hiding this comment.
Added name property that denotes the URL of the resource fetched. This is as per https://developer.mozilla.org/en-US/docs/Web/API/PerformanceEntry/name
| **Event name**:`page_navigation_timing` | ||
|
|
||
| This event describes the timing metrics of a page navigation as provided by | ||
| `PerformanceNavigationTiming` Performance API. |
There was a problem hiding this comment.
Does this include the page that is loading somewhere?
There was a problem hiding this comment.
Added name property that denotes the URL of the page loaded. This is as per https://developer.mozilla.org/en-US/docs/Web/API/PerformanceEntry/name
|
|
||
| ### Exception | ||
|
|
||
| **Event name**:`exception` |
There was a problem hiding this comment.
Why is this redefined? Shouldn't this just leverage existing exception specification, e.g. https://github.com/open-telemetry/semantic-conventions/blob/main/specification/logs/semantic_conventions/exceptions.md
|
|
||
| ### WebVital | ||
|
|
||
| **Event name**:`web_vital` |
There was a problem hiding this comment.
Can you outline in more detail what this is?
There was a problem hiding this comment.
Added a short description for this event type.
|
|
||
| ### UserAction | ||
|
|
||
| **Event name**:`user_action` |
There was a problem hiding this comment.
Can you outline in more detail what user actions should be captured?
There was a problem hiding this comment.
Added a few user actions captured using this Event.
| @@ -0,0 +1,205 @@ | |||
| # Semantic conventions for browser events | |||
There was a problem hiding this comment.
This should make use of semantic conventions YAML definitions for attributes, where possible.
|
Can you please reopen this against the current main branch, including using |
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.
Related PRs open-telemetry/opentelemetry-specification#2926