Skip to content

Add browser events and describe their payload #838

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.

Sign up for GitHub

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

Closed
scheler wants to merge 19 commits into from
Closed

Add browser events and describe their payload #838

Changes from 1 commit
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
ef0c007
Browser events with payload fields in log record body
scheler Mar 23, 2024
fd82961
Removed old content not relevant now
scheler Mar 26, 2024
4f7477e
Merge branch 'main' into browser-events-v2
scheler Mar 26, 2024
3d18160
Add changelog entry
scheler Mar 26, 2024
005942b
Merge branch 'open-telemetry:main' into browser-events-v2
scheler Apr 9, 2024
6683c0f
Updates based on review comments
scheler Apr 20, 2024
1ea8734
Add session.id as attribute to all events
scheler Apr 22, 2024
6a4c119
Adding browser.page.instance_id to all events
scheler Apr 23, 2024
3da4d9c
Use template format for user_action tags
scheler Apr 23, 2024
dc8e3e9
Merge branch 'main' into browser-events-v2
scheler May 20, 2024
876dcec
Remove Exception from TOC
scheler May 20, 2024
5923d1e
Merge branch 'open-telemetry:main' into browser-events-v2
scheler Jun 5, 2024
87bb7d9
Merge branch 'main' into browser-events-v2
scheler Jul 18, 2024
4b4ffed
Merge branch 'main' into browser-events-v2
scheler Jul 18, 2024
76ccb33
Updated resource timing fields
scheler Jul 18, 2024
1dad85a
Removing incorrected added fields to resource timing events
scheler Jul 18, 2024
26e551b
Updating the fields for web_vital event.
scheler Jul 19, 2024
1a81fdc
Removing the browser.page.instance_id field
scheler Jul 26, 2024
f7ee8db
Merge branch 'main' into browser-events-v2
scheler Jul 26, 2024
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
Prev Previous commit
Next Next commit
Adding browser.page.instance_id to all events
  • Loading branch information
@scheler
scheler committed Apr 23, 2024
commit 6a4c1191084d917df7df72de0275ee3b94d01dbe
5 changes: 5 additions & 0 deletions docs/browser/events.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ The following table describes the payload fields that MUST be used to describe t
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
| [`session.id`](../attributes-registry/session.md) | string | A unique id to identify a session. | `00112233-4455-6677-8899-aabbccddeeff` | `Opt-In` |
| `browser.page.instance_id` | string | A unique id that identifies the instance of the page where the event is emitted. | `e611e02f-c9d2-47b3-a678-df1465e0f401` | `Opt-In` |

**[1]:** Alias for [`http.url`](../../../trace/semantic_conventions/http.md)
**[2]:** The URL fragment may be included for virtual pages
Expand Down Expand Up @@ -78,6 +79,7 @@ The following table describes the payload fields that MUST be used to describe t
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
| [`session.id`](../attributes-registry/session.md) | string | A unique id to identify a session. | `00112233-4455-6677-8899-aabbccddeeff` | `Opt-In` |
| `browser.page.instance_id` | string | A unique id that identifies the instance of the page where the event is emitted. | `e611e02f-c9d2-47b3-a678-df1465e0f401` | `Opt-In` |

## ResourceTiming

Expand Down Expand Up @@ -105,6 +107,7 @@ The following table describes the payload fields that MUST be used to describe t
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
| [`session.id`](../attributes-registry/session.md) | string | A unique id to identify a session. | `00112233-4455-6677-8899-aabbccddeeff` | `Opt-In` |
| `browser.page.instance_id` | string | A unique id that identifies the instance of the page where the event is emitted. | `e611e02f-c9d2-47b3-a678-df1465e0f401` | `Opt-In` |

## UserAction

Expand All @@ -125,6 +128,7 @@ The following table describes the payload fields that MUST be used to describe t
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
| [`session.id`](../attributes-registry/session.md) | string | A unique id to identify a session. | `00112233-4455-6677-8899-aabbccddeeff` | `Opt-In` |
| `browser.page.instance_id` | string | A unique id that identifies the instance of the page where the event is emitted. | `e611e02f-c9d2-47b3-a678-df1465e0f401` | `Opt-In` |

`user_action_type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.:

Expand All @@ -150,6 +154,7 @@ The following table describes the payload fields that MUST be used to describe t
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
| [`session.id`](../attributes-registry/session.md) | string | A unique id to identify a session. | `00112233-4455-6677-8899-aabbccddeeff` | `Opt-In` |
| `browser.page.instance_id` | string | A unique id that identifies the instance of the page where the event is emitted. | `e611e02f-c9d2-47b3-a678-df1465e0f401` | `Opt-In` |

`name` has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.

Expand Down