Repository navigation
docs(js): Document bfcacheMetricsIntegration for v11 - #18936
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
logaretm
force-pushed
the
awad/bfcache-metrics-integration
branch
from
September 17, 2026 18:52
407df91 to
00e5831
Compare
logaretm
changed the title
bfcacheMetricsIntegration
logaretm
changed the title
bfcacheMetricsIntegrationbfcacheMetricsIntegration for v11
msonnb
reviewed
Sep 18, 2026
msonnb
approved these changes
Sep 21, 2026
andreiborza
marked this pull request as ready for review
September 22, 2026 13:17
github-actions
Bot
added
the
Priority: Needs Triage
Contributor
|
Please update the IS YOUR CHANGE URGENT? section of the PR description:
This information helps the Docs team prioritize your review. |
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
Comment on lines
+12
to
+22
| - javascript.express | ||
| - javascript.fastify | ||
| - javascript.gcp-functions | ||
| - javascript.hapi | ||
| - javascript.hono | ||
| - javascript.koa | ||
| - javascript.nitro | ||
| - javascript.nestjs | ||
| - javascript.deno | ||
| - javascript.cloudflare | ||
| - javascript.bun |
Contributor
There was a problem hiding this comment.
Bug: The bfcache.mdx frontmatter is missing javascript.eve in its notSupported list, incorrectly suggesting this browser-only integration is supported on a backend platform.
Severity: LOW
Suggested Fix
Add javascript.eve to the notSupported list in the frontmatter of bfcache.mdx. This will align it with other browser-only integrations and prevent the documentation from being shown to users of the Eve platform.
Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's
not valid.
Location: docs/platforms/javascript/common/configuration/integrations/bfcache.mdx#L5-L22
Potential issue: The `bfcache.mdx` file, which documents a browser-only integration, is
missing `javascript.eve` from its `notSupported` frontmatter list. Since
`javascript.eve` is a backend Node.js environment, this integration should not be shown
as supported. This inconsistency with other browser-only integrations
(`elementtiming.mdx`, `browserprofiling.mdx`, etc.) will cause the documentation to be
incorrectly rendered for Eve users who navigate directly to the page, misleading them
into thinking the feature is available in their environment.
Did we get this right? 👍 / 👎 to inform future reviews.
…cache.mdx Co-authored-by: Martin Sonnberger <martin.sonnberger@sentry.io>
…cache.mdx Co-authored-by: Martin Sonnberger <martin.sonnberger@sentry.io>
Review feedback asked for a brand guidelines pass over the page, which flagged several passive constructions. Rewrite them so the browser or the SDK is the subject, and match the "Sentry Application Metrics" capitalization used on the other pages.
logaretm
force-pushed
the
awad/bfcache-metrics-integration
branch
from
September 22, 2026 14:23
09a52d4 to
e8d4cd3
Compare
Comment on lines
+12
to
+22
| - javascript.express | ||
| - javascript.fastify | ||
| - javascript.gcp-functions | ||
| - javascript.hapi | ||
| - javascript.hono | ||
| - javascript.koa | ||
| - javascript.nitro | ||
| - javascript.nestjs | ||
| - javascript.deno | ||
| - javascript.cloudflare | ||
| - javascript.bun |
Contributor
There was a problem hiding this comment.
Bug: The notSupported list in bfcache.mdx is incomplete, causing this browser-only integration documentation to be shown for unsupported server-side or non-browser platforms.
Severity: LOW
Suggested Fix
Either add the missing platforms (javascript.effect, javascript.elysia, javascript.firebase, javascript.mastra, javascript.wasm, javascript.electron) to the notSupported list. Alternatively, for a more maintainable solution, use notSupportedCategories: server-only as is done in elementtiming.mdx.
Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's
not valid.
Location: docs/platforms/javascript/common/configuration/integrations/bfcache.mdx#L5-L22
Potential issue: The `notSupported` list in the `bfcache.mdx` documentation file is
incomplete. It is missing several non-browser or server-side JavaScript platforms,
including `javascript.effect`, `javascript.elysia`, `javascript.firebase`,
`javascript.mastra`, `javascript.wasm`, and `javascript.electron`. Because these
platforms are not excluded, the documentation for the browser-only `bfcache` integration
is incorrectly displayed to users of these unsupported platforms. This can be misleading
and cause developers to attempt to configure a feature that is not available in their
environment. Other similar integration documents, like `webvitals.mdx`, correctly
exclude these platforms.
This branch was successfully deployed
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
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.
Adds documentation for the new
bfcacheMetricsIntegrationin the browser SDK, which tracks back/forward cache hit/miss rate and not-restored reasons as application metrics.Depends on the SDK integration landing in a release getsentry/sentry-javascript#22397