Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Folder structure and placeholders for defining event schemas (for RUM events as a start) #2933

Closed
wants to merge 7 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions specification/logs/semantic_conventions/browser/common.md
Original file line number Diff line number Diff line change
@@ -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 |
19 changes: 19 additions & 0 deletions specification/logs/semantic_conventions/browser/exception.md
Original file line number Diff line number Diff line change
@@ -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 <anonymous>:1:1` | Required |
| `type` | string | `sendAppErrorEvent` | Required |
18 changes: 18 additions & 0 deletions specification/logs/semantic_conventions/browser/fetchtiming.md
Original file line number Diff line number Diff line change
@@ -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 |
20 changes: 20 additions & 0 deletions specification/logs/semantic_conventions/browser/pageview.md
Original file line number Diff line number Diff line change
@@ -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 |
10 changes: 10 additions & 0 deletions specification/logs/semantic_conventions/browser/readme.md
Original file line number Diff line number Diff line change
@@ -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.|
18 changes: 18 additions & 0 deletions specification/logs/semantic_conventions/browser/useraction.md
Original file line number Diff line number Diff line change
@@ -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 |