DEV: Add X-Discourse-BrowserPageView response header #33598
Merged
+73
−24
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When we are tracking requests in the `Middleware::RequestTracker`, we have historically added an `X-Discourse-TrackView` response header for implicitly tracked requests, which are HTML requests. Within the past couple of years, we introduced the concept of Browser Page Views (BPVs), which are also known as explicitly tracked requests, which are recorded when requests are made via AJAX. These also add the `X-Discourse-TrackView` header to the response, so it is hard to differentiate the two in logs. This commit adds a new response header, `X-Discourse-BrowserPageView`, that acts in a similar way to the existing `X-Discourse-TrackView` header, but is specifically for requests that are tracked as BPVs.
6b455e6 to
9f95dec
Compare
SamSaffron
approved these changes
Jul 14, 2025
nbianca
approved these changes
Jul 14, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When we are tracking requests in the
Middleware::RequestTracker, wehave historically added an
X-Discourse-TrackViewresponse headerfor implicitly tracked requests HTML requests, and also explicitly
tracked page view requests when navigating the Ember app.
Within the past couple of years, we introduced the concept of
Browser Page Views (BPVs), which are recorded when requests are made
via AJAX when navigating the app with Ember, and also piggybacked
onto the first MessageBus request on page load. The former is known
as an explicitly tracked request, the latter is a deferred tracked request.
The explicitly tracked browser page views also add the
X-Discourse-TrackViewheader to the response, so it is hard to differentiate which requests are purely
browser page view requests in the logs.
This commit adds a new response header,
X-Discourse-BrowserPageView,that acts in a similar way to the existing
X-Discourse-TrackViewheader, but is specifically for requests that are tracked as BPVs (both explicit
and deferred).
AJAX call:
HTML page load: