diff --git a/specification/logs/semantic_conventions/browser/common.md b/specification/logs/semantic_conventions/browser/common.md new file mode 100644 index 00000000000..9950f3fc0c9 --- /dev/null +++ b/specification/logs/semantic_conventions/browser/common.md @@ -0,0 +1,24 @@ +# common + +**Status**: [Experimental](../../../../document-status.md) + +**type:** `common` + +**Description**: Represents the set of common attributes that will be present for all Browser events. + +**Note**: This event will be sent as a log event and will follow the semantic convention for a log. The below attributes will be present as nested attributes in the event.data attribute of the log event. + +> Below is a sample representation of the common browser attributes to get the folder structure approved, as a first step. + +## Fixed attributes + +| Attribute | Type | Value | Requirement Level | +|------------|------|--------|-------------------| +| `browser.platform` | string | `windows`, `linux`, `iOS` | Required | + +## Varying attributes + +| Attribute | Type | Value | Requirement Level | +|------------|------|--------|-------------------| +| `screen_width` | integer | `1337` | Required | +| `screen_height` | integer | `1013` | Required | diff --git a/specification/logs/semantic_conventions/browser/exception.md b/specification/logs/semantic_conventions/browser/exception.md new file mode 100644 index 00000000000..02bc7ebf60c --- /dev/null +++ b/specification/logs/semantic_conventions/browser/exception.md @@ -0,0 +1,19 @@ +# exception + +**Status**: [Experimental](../../../../document-status.md) + +**type:** `exception` + +**Description**: Represents the exception event. + +**Note**: This event will be sent as a log event and will follow the semantic convention for a log. The below attributes will be present as nested attributes in the event.data attribute of the log event. + +> Below is a sample representation attributes to get the folder structure approved, as a first step. + +## data + +[common attributes](.\common.md) +| Attribute | Type | Value | Requirement Level | +|---|---|---|---| +| `message` | string | `VM516:1 Uncaught ReferenceError: a is not defined at :1:1` | Required | +| `type` | string | `sendAppErrorEvent` | Required | diff --git a/specification/logs/semantic_conventions/browser/fetchtiming.md b/specification/logs/semantic_conventions/browser/fetchtiming.md new file mode 100644 index 00000000000..183aabf6114 --- /dev/null +++ b/specification/logs/semantic_conventions/browser/fetchtiming.md @@ -0,0 +1,18 @@ +# fetchtiming + +**Status**: [Experimental](../../../../document-status.md) + +**type:** `fetchtiming` + +**Description**: Represents the fetchtiming event that has page fetch timing details. + +**Note**: This event will be sent as a log event and will follow the semantic convention for a log. The below attributes will be present as nested attributes in the event.data attribute of the log event. + +> Below is a sample representation attributes to get the folder structure approved, as a first step. + +## data + +[common attributes](.\common.md) +| Attribute | Type | Value | Requirement Level | +|---|---|---|---| +| `browser.requesttype` | string | `fetch`, `XHR`| Required | diff --git a/specification/logs/semantic_conventions/browser/pageview.md b/specification/logs/semantic_conventions/browser/pageview.md new file mode 100644 index 00000000000..d103ec8c8fc --- /dev/null +++ b/specification/logs/semantic_conventions/browser/pageview.md @@ -0,0 +1,20 @@ +# pageview + +**Status**: [Experimental](../../../../document-status.md) + +**type:** `pageview` + +**Description**: Represents a page impression event. + +**Note**: This event will be sent as a log event and will follow the semantic convention for a log. The below attributes will be present as nested attributes in the event.data attribute of the log event. + +> Below is a sample representation attributes to get the folder structure approved, as a first step. + +## data + +[common attributes](.\common.md) +| Attribute | Type | Value | Requirement Level | +|---|---|---|---| +| `referrer` | string | "https://www.sitexyz.com/homepage.html" | Optional | +| `type` | integer | 0 - Physical page, 1 - Virtual page | Required | +| `userconsent` | boolean | true - consented, false - not consented | Required | diff --git a/specification/logs/semantic_conventions/browser/readme.md b/specification/logs/semantic_conventions/browser/readme.md new file mode 100644 index 00000000000..0c4586c87ef --- /dev/null +++ b/specification/logs/semantic_conventions/browser/readme.md @@ -0,0 +1,10 @@ +# Browser events semantic conventions + +All browser events MUST have the `event.domain` attribute set to `browser`. + +| Event name | Description | +|---|---| +| [`pageview`](./pageview.md) | Represents a page impression event. | +| [`useraction`](./useraction.md) | Represents an interaction event like click, scroll, etc. | +| [`fetchtiming`](./fetchtiming.md) | Represents the fetchtiming event that has page fetch timing details. | +| [`exception`](./exception.md) | Represents the exception event.| \ No newline at end of file diff --git a/specification/logs/semantic_conventions/browser/useraction.md b/specification/logs/semantic_conventions/browser/useraction.md new file mode 100644 index 00000000000..497a4e9af24 --- /dev/null +++ b/specification/logs/semantic_conventions/browser/useraction.md @@ -0,0 +1,18 @@ +# useraction + +**Status**: [Experimental](../../../../document-status.md) + +**type:** `useraction` + +**Description**: Represents an interaction event like click, scroll, etc. + +**Note**: This event will be sent as a log event and will follow the semantic convention for a log. The below attributes will be present as nested attributes in the event.data attribute of the log event. + +> Below is a sample representation of the common browser attributes to get the folder structure approved, as a first step. + +## data + +[common attributes](.\common.md) +| Attribute | Type | Value | Requirement Level | +|---|---|---|---| +| `element.xpath` | string | `/bookstore/book/title` | Required |