|
| 1 | +# Browser Events |
| 2 | + |
| 3 | +This document defines browser events for observability and telemetry. |
| 4 | + |
| 5 | +It focuses on the **purpose and description of each event**, rather than defining their individual attributes (which are specified in their respective semantic convention documents). |
| 6 | + |
| 7 | +--- |
| 8 | + |
| 9 | +## Goals |
| 10 | + |
| 11 | +The purpose of this document is to: |
| 12 | + |
| 13 | +- Provide a **comprehensive list of browser events** for telemetry. |
| 14 | +- Define **the purpose and behavior of each event**. |
| 15 | +- Help instrumentation authors and data consumers **understand available browser observability signals**. |
| 16 | +- Clarify the **purpose of events without defining their individual attributes**, which are specified in their respective semantic convention documents. |
| 17 | + |
| 18 | +This structure ensures that browser-related events can be consistently interpreted across implementations. |
| 19 | + |
| 20 | +--- |
| 21 | + |
| 22 | +## Browser Events |
| 23 | + |
| 24 | +| Event | Description | Semantic Conventions Status | Instrumentation Status | |
| 25 | +|----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |
| 26 | +| `browser.navigation` | Captures a page page navigation event (both hard navigations and soft SPA navigations). | In review [PR1910](https://github.com/open-telemetry/semantic-conventions/pull/1910) | In review [PR2386](https://github.com/open-telemetry/opentelemetry-js-contrib/pull/2386) | |
| 27 | +| `browser.navigation_timing` | Captures detailed technical milestones from the [PerformanceNavigationTiming](https://developer.mozilla.org/docs/Web/API/PerformanceNavigationTiming) API. | In review [PR1919](https://github.com/open-telemetry/semantic-conventions/pull/1919) | Not created | |
| 28 | +| `browser.resource_timing` | Captures information about individual resources loaded by the page, from the [PerformanceResourceTiming](https://developer.mozilla.org/docs/Web/API/PerformanceResourceTiming) API. | In review [PR1943](https://github.com/open-telemetry/semantic-conventions/pull/1943) | Merged (similar, as spans) [instrumentation-document-load](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-document-load) | |
| 29 | +| `browser.web_vital` | Captures Web Vitals metrics such as CLS, INP, LCP, and FID. | Merged [WebVitals](https://opentelemetry.io/docs/specs/semconv/browser/events/#webvital-event) | Not created | |
| 30 | +| `exception` | Captures unhandled JavaScript exceptions. | Not created | In review [PR2715](https://github.com/open-telemetry/opentelemetry-js-contrib/pull/2751/files) | |
| 31 | +| `browser.console` | Captures browser console messages such as warnings and logs. | Issue Created [I1560](https://github.com/open-telemetry/opentelemetry-js-contrib/issues/1560) | Not created | |
| 32 | +| `browser.user_action` | Captures user input events (clicks, scrolls, keypresses). | In review [PR1941](https://github.com/open-telemetry/semantic-conventions/pull/1941) | Not created | |
0 commit comments