feat: add config options for reportAll CLS and LCP #619
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
|
Looks like integ test failed |
williazz
changed the title
ps863
reviewed
Mar 26, 2025
docs/configuration.md
Outdated
| @@ -187,6 +187,10 @@ const awsRum: AwsRum = new AwsRum( | |||
| | --- | --- | --- | --- | | |||
| | eventLimit | Number | `10` | The maximum number of resources to record load timing. <br/><br/>There may be many similar resources on a page (e.g., images) and recording all resources may add expense without adding value. The web client records all HTML files and JavaScript files, while recording a sample of stylesheets, images and fonts. Increasing the event limit increases the maximum number of sampled resources. | | |||
| | ignore | Function(event: PerformanceEntry) : any | `(entry: PerformanceEntry) => entry.entryType === 'resource' && !/^https?:/.test(entry.name)` | A function which accepts a [PerformanceEntry](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceEntry) and returns a value that coerces to true when the PerformanceEntry should be ignored.</br></br> By default, [PerformanceResourceTiming](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceResourceTiming) entries with URLs that do not have http(s) schemes are ignored. This causes resources loaded by browser extensions to be ignored. | | |||
| | recordAllTypes | String[] | ['document', 'script', 'stylesheet', 'font'] | A list of resource types that are always recorded, no matter if the resource event limit has been reached. | | |||
| | sampleTypes | String[] | ['image', 'other'] | A list of resource types that are only recorded if the resource event limit has not been reached. | | |||
There was a problem hiding this comment.
nit: should we link to any docs to show what users can specify here?
There was a problem hiding this comment.
Added in next revision
ps863
approved these changes
Mar 26, 2025
limhjgrace
approved these changes
Mar 27, 2025
williazz
force-pushed
the
web-vitals-4.x
branch
from
8c509e8 to
af5d752
Compare
williazz
force-pushed
the
web-vitals-4.x
branch
from
af5d752 to
42cff21
Compare
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.
Revision 2
In web-vitals 4.x, CLS (along with INP) is only reported by default when visibility-change event fires. Previously, CLS was reported after first input. That means there is no way to make the integ test work unless we flip the
reportAlChangesflag.We want to release
reportAllChangesflag for web vitals anyways. Since that feature unblocks the integ test in this pull request, then we can group them together for CLS+LCP and fast-forward merge to preserve the commit history.Revision 1
The web-vitals library has upgraded to 4.x, and we need to keep pace. This is also necessary for INP.
One breaking change is that they renamed the incorrectly named LCP attribution
resourceLoadTimetoresourceLoadDuration. GoogleChrome/web-vitals#450We will not rename this field yet unless we upgrade to another major version. So in the meantime we will keep the old name but take the same value.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.