Skip to content
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

feat: NR 328461 add CLS browser golden signals #1839

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
Open

feat: NR 328461 add CLS browser golden signals #1839

Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
cae7ffe
add: Add cumulative layout shift (75 percentile) metric to golden met…
shivalagisetty Jan 6, 2025
0b69d47
add: Rename cumulative layout shift metric and update summary metrics
shivalagisetty Jan 6, 2025
1adc495
add: Include "NUMBER" as a valid unit in the golden metrics schema
shivalagisetty Jan 6, 2025
a51f06f
add: Include "NUMBER" as a valid unit in the summary metrics schema
shivalagisetty Jan 6, 2025
cb58c55
fix: Rename cumulative layout shift metric for consistency in golden …
shivalagisetty Jan 6, 2025
e4b9327
add: Include "NUMBER" as a valid unit in golden and summary metrics s…
shivalagisetty Jan 6, 2025
150f48c
fix: Remove "NUMBER" as a valid unit from golden and summary metrics …
shivalagisetty Jan 7, 2025
d9eb363
fix: Update unit from COUNT to NUMBER for cumulative layout shift met…
shivalagisetty Jan 7, 2025
58fbdef
fix: Change unit from NUMBER to STRING for cumulative layout shift me…
shivalagisetty Jan 10, 2025
4c68e2a
Merge branch 'main' into NR-328461-add-cls-browser-golden-signals
shivalagisetty Jan 10, 2025
222fe85
fix: Add "STRING" as a valid unit in golden metrics schema
shivalagisetty Jan 10, 2025
9163983
fix: Change unit from STRING to COUNT for cumulative layout shift met…
shivalagisetty Jan 16, 2025
1485e05
fix: Remove "STRING" from valid units in golden metrics schema
shivalagisetty Jan 17, 2025
3aa522e
Merge branch 'main' into NR-328461-add-cls-browser-golden-signals
shivalagisetty Jan 17, 2025
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
8 changes: 8 additions & 0 deletions entity-types/browser-application/golden_metrics.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,14 @@ interactionToNextPaint75PercentileS:
from: PageViewTiming
eventId: entityGuid
eventName: appName
cumulativeLayoutShift75Percentile:
title: Cumulative layout shift (75 percentile)
unit: STRING
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think STRING is the proper unit here.

Is there any specific reason why this should be an STRING?

I totally understand that any other values in the ENUM do not fit completely your needs, but I'd not put an STRING here.

In many other places, we use just COUNT, which is the default.
The COUNT unit, is shown as no just a number in the UI.

Let me share some examples:

entity-definitions/entity-types/infra-container/summary_metrics.yml

Line 6 in 1ce56fe

cpuUsage:

entity-definitions/entity-types/infra-awslambdafunctionalias/golden_metrics.yml

Line 46 in 1ce56fe

throttles:

query:
select: percentile(cumulativeLayoutShift, 75)
from: PageViewTiming
eventId: entityGuid
eventName: appName
errors:
title: Errors
unit: COUNT
Expand Down
4 changes: 4 additions & 0 deletions entity-types/browser-application/summary_metrics.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ interactionToNextPaint75PercentileS:
goldenMetric: interactionToNextPaint75PercentileS
unit: SECONDS
title: Interaction to next paint (75 percentile) (s)
cumulativeLayoutShift75Percentile:
goldenMetric: cumulativeLayoutShift75Percentile
unit: STRING
title: Cumulative layout shift (75 percentile)
errors:
goldenMetric: errors
unit: COUNT
Expand Down
2 changes: 1 addition & 1 deletion validator/schemas/golden-metrics-schema-v1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
"$id": "#/properties/unit",
"type": "string",
"title": "The unit of the metric",
"enum": ["REQUESTS_PER_SECOND", "REQUESTS_PER_MINUTE", "PAGES_PER_SECOND", "MESSAGES_PER_SECOND", "OPERATIONS_PER_SECOND", "COUNT", "SECONDS", "MS", "PERCENTAGE", "BITS", "BYTES", "BITS_PER_SECOND", "BYTES_PER_SECOND", "HERTZ", "APDEX", "TIMESTAMP", "CELSIUS"],
"enum": ["REQUESTS_PER_SECOND", "REQUESTS_PER_MINUTE", "PAGES_PER_SECOND", "MESSAGES_PER_SECOND", "OPERATIONS_PER_SECOND", "COUNT", "SECONDS", "MS", "PERCENTAGE", "BITS", "BYTES", "BITS_PER_SECOND", "BYTES_PER_SECOND", "HERTZ", "APDEX", "TIMESTAMP", "CELSIUS", "STRING"],
"examples": [
"COUNT"
]
Expand Down
Loading