Add browser page view event #1910

martinkuba · 2025-02-15T19:39:47Z

Changes

This adds a new event for capturing the page view event from browser/web applications.

Related to open-telemetry/opentelemetry-browser#13

Merge requirement checklist

CONTRIBUTING.md guidelines followed.
Change log entry added, according to the guidelines in When to add a changelog entry.
- If your PR does not need a change log, start the PR title with [chore]
schema-next.yaml updated with changes to existing conventions.

github-actions · 2025-03-06T03:22:14Z

This PR was marked stale due to lack of activity. It will be closed in 7 days.

github-actions · 2025-03-13T03:22:41Z

Closed as inactive. Feel free to reopen if this PR is still being worked on.

docs/browser/events.md

github-actions · 2025-03-29T03:22:51Z

This PR was marked stale due to lack of activity. It will be closed in 7 days.

github-actions · 2025-04-05T03:23:08Z

Closed as inactive. Feel free to reopen if this PR is still being worked on.

github-actions · 2025-04-21T03:30:06Z

This PR was marked stale due to lack of activity. It will be closed in 7 days.

github-actions · 2025-05-15T03:31:02Z

This PR was marked stale due to lack of activity. It will be closed in 7 days.

github-actions · 2025-05-22T03:31:50Z

Closed as inactive. Feel free to reopen if this PR is still being worked on.

model/browser/events.yaml

Co-authored-by: Trask Stalnaker <[email protected]>

model/browser/events.yaml

martinkuba · 2025-09-01T20:30:58Z

I have made a few changes based on feedback:

switched from using body fields to attributes
all new attributes are in the browser.* namespace
for the URL field, I am now using the existing url.full attribute
renamed page_view.title to page.title , since that seems to be really a property of the page
updated the type enum to use human readable values (page_load and soft_navigation - I felt these make most sense, but open to other ideas)

There are a couple of things that still need to be resolved

per @david-luna’s comment, the page title attribute could contain PII values, which complicates the instrumentation. It is also not clear if it provides much value. I am open to removing it (at least for now). lmkwyt
I think the change_state attribute needs clarification. Is it intended to capture the mechanism of how the URL was changed or whether the new URL was added to the history stack? There are other ways of changing the URL than using the history API, so if it complicates things, I am also open to removing this for now.

model/browser/registry.yaml

thompson-tomo · 2025-09-02T07:56:06Z

model/browser/registry.yaml

+      - id: browser.page_view.type
+        type:
+          members:
+            - id: physical_page
+              value: page_load
+              stability: development
+              brief: >
+                Initial page load within the browser which will generally also
+                precede a PageNavigationTiming event.
+            - id: virtual_page
+              value: soft_navigation
+              stability: development
+              brief: >
+                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.
+        stability: development
+        brief: Type of navigation
+        examples: ["page_load", "soft_navigation"]


Similar to the other comment, I feel browser.page.view_type or browser.document.view_type might be a better fit as it is describing the page being shown in the browser.

similar here

I wouldn't go with browser.document.view_type, I think we should reserve that namespace for attributes that are coming from window.document so it's easier to understand where is that coming from. I agree that it makes sense for referrer to be browser.document.referrer

It looks like we're dealing with two namespaces here:

page

page_view

Maybe having a proper definition of what they are can help assigning the attributes. If I have to give it a go I would say:

page_view: it represents the action of navigating to a certain URL, whether is a full load (cold start) or soft navigation (like in SPAs)

page: it contains information of the current page that the user is seeing in the browser, such us URL, title, etc

Having said that I think here we're trying to describe the navigation type, so I agree that it should be in the page_view namespace

I agree with @joaquin-diaz, the intent is to describe the type of navigation. Page itself does not have a type, especially when the values are either "page_load" or "soft_navigation". Maybe rename to browser.navigation.type?

I agree the page doesn't have a type hence suggestion was view_type but I do like your suggestion of browser.navigation.type as it is clear what it is describing.

Agree, I also like browser.navigation.type

Same. There are other nav types: reload and back_forward. What about:

load soft reload back_forward

@martinkuba did we want to go with the change to browser.navigation.type especially as it would also potentially allow the additional types

We discussed this in the SIG meeting last week and decided to keep it like this. Navigation type already exists in the navigation API, so did not want to overload it.

We might want to add navigation.type attribute in the future, but it would have this other meaning (captured from navigation.activation.navigationType).

model/browser/registry.yaml

model/browser/events.yaml

…e_change

docs/browser/events.md

add browser.page_view event

c14d2d2

martinkuba requested review from a team as code owners February 15, 2025 19:39

fix yaml lint

2300335

jsuereth moved this from Untriaged to In Review in Semantic Conventions Triage Mar 4, 2025

github-actions bot added the Stale label Mar 6, 2025

github-actions bot closed this Mar 13, 2025

trask reopened this Mar 13, 2025

trask removed the Stale label Mar 13, 2025

trask reviewed Mar 13, 2025

View reviewed changes

docs/browser/events.md Outdated Show resolved Hide resolved

docs/browser/events.md Outdated Show resolved Hide resolved

github-actions bot added the Stale label Mar 29, 2025

github-actions bot closed this Apr 5, 2025

lmolkova reopened this Apr 5, 2025

lmolkova removed the Stale label Apr 5, 2025

github-actions bot added the Stale label Apr 21, 2025

trask removed the Stale label Apr 21, 2025

github-actions bot added the Stale label May 15, 2025

github-actions bot closed this May 22, 2025

david-luna reviewed Jun 17, 2025

View reviewed changes

model/browser/events.yaml Outdated Show resolved Hide resolved

david-luna reviewed Jun 17, 2025

View reviewed changes

model/browser/events.yaml Outdated Show resolved Hide resolved

david-luna reviewed Jun 17, 2025

View reviewed changes

model/browser/events.yaml Outdated Show resolved Hide resolved

martinkuba reopened this Jun 17, 2025

martinkuba requested a review from a team as a code owner June 17, 2025 15:31

github-project-automation bot moved this from Awaiting codeowners approval to Blocked in Semantic Conventions Triage Aug 6, 2025

martinkuba and others added 2 commits August 6, 2025 05:24

update change_state field name to state_change

bca0e57

Co-authored-by: Trask Stalnaker <[email protected]>

added link to referrer field

0f1ebfd

lmolkova moved this from Blocked to Awaiting codeowners approval in Semantic Conventions Triage Aug 6, 2025

thompson-tomo mentioned this pull request Aug 7, 2025

add origin_referrer_url and origin_url to the file attribute #1430

Closed

3 tasks

tedsuo reviewed Aug 7, 2025

View reviewed changes

model/browser/events.yaml Outdated Show resolved Hide resolved

martinkuba added 9 commits August 31, 2025 16:25

Merge branch 'main' into browser-page-view-event

61846b9

changed body fields to attributes

0450aa7

renamed page_view.title attribute to page.title

2bcca11

removed misplaced requirement_level

c925de1

fixed enum syntax

f0d96b2

updated attribute reference for page.title

e835d2c

updated registry md file

95154d1

updated events markdown

cc469a0

changed page_view.type enum to use human readable values

94a1025

thompson-tomo reviewed Sep 2, 2025

View reviewed changes

renamed browser.referrer to browser.page.referrer_url

8b1324d

david-luna approved these changes Sep 2, 2025

View reviewed changes

renamed event to browser.page.view and change_state attribute to stat…

5c7893d

…e_change

tedsuo moved this from Done to In Progress in Browser: Phase 1 Sep 3, 2025

tedsuo assigned martinkuba Sep 3, 2025

overbalance mentioned this pull request Sep 4, 2025

REQUEST: New membership for @overbalance open-telemetry/community#2967

Closed

6 tasks

joaquin-diaz mentioned this pull request Sep 4, 2025

REQUEST: New membership for @joaquin-diaz open-telemetry/community#2968

Closed

6 tasks

removed page title and state_change attributes

104ce9c

joaquin-diaz approved these changes Sep 5, 2025

View reviewed changes

overbalance reviewed Sep 9, 2025

View reviewed changes

docs/browser/events.md Show resolved Hide resolved

updated event name in title

0e8d64a

martinkuba mentioned this pull request Sep 13, 2025

Decide how to proceed with the Page view event/instrumentation open-telemetry/opentelemetry-browser#3

Open

BenoitZugmeyer mentioned this pull request Oct 13, 2025

Proposal: add initial proposal for browser observability model events open-telemetry/opentelemetry-browser#6

Merged

Add browser page view event #1910

Are you sure you want to change the base?

Add browser page view event #1910

Uh oh!

Conversation

martinkuba commented Feb 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Merge requirement checklist

Uh oh!

github-actions bot commented Mar 6, 2025

Uh oh!

github-actions bot commented Mar 13, 2025

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Mar 29, 2025

Uh oh!

github-actions bot commented Apr 5, 2025

Uh oh!

github-actions bot commented Apr 21, 2025

Uh oh!

github-actions bot commented May 15, 2025

Uh oh!

github-actions bot commented May 22, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

martinkuba commented Sep 1, 2025

Uh oh!

Uh oh!

thompson-tomo Sep 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

david-luna Sep 2, 2025

Choose a reason for hiding this comment

Uh oh!

joaquin-diaz Sep 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

martinkuba Sep 2, 2025

Choose a reason for hiding this comment

Uh oh!

thompson-tomo Sep 3, 2025

Choose a reason for hiding this comment

Uh oh!

joaquin-diaz Sep 3, 2025

Choose a reason for hiding this comment

Uh oh!

overbalance Sep 4, 2025

Choose a reason for hiding this comment

Uh oh!

thompson-tomo Sep 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

martinkuba Sep 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

martinkuba commented Feb 15, 2025 •

edited

Loading

thompson-tomo Sep 2, 2025 •

edited

Loading

joaquin-diaz Sep 2, 2025 •

edited

Loading

thompson-tomo Sep 11, 2025 •

edited

Loading

martinkuba Sep 11, 2025 •

edited

Loading