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

Jump to bottom

Rename the browser web vital metrics #884

Closed
ankur22 opened this issue May 15, 2023 · 0 comments · Fixed by #885
Closed

Rename the browser web vital metrics #884

ankur22 opened this issue May 15, 2023 · 0 comments · Fixed by #885
Assignees
@ankur22
Labels
breaking PRs that need to be mentioned in the breaking changes section of the release notes refactor
Milestone
v0.10.0

Comments

@ankur22
Copy link
Collaborator

ankur22 commented May 15, 2023 •
edited
Loading

Here is an example of the web vital metrics when they're emitted: webvital_cumulative_layout_shift

There are three issues with it:

  1. It is missing the browser namespace as discussed in Add a prefix to the browser module metrics #883
  2. web vital is two words, so it should be web_vital
  3. cumulative_layout_shift says what it is, which is great, but we will assume that people who are looking to measure and improve their frontend web experience will likely have the context of what these web vital metrics are, so we want to go with the abbreviated name e.g. cls. This also helps when it comes to the display of the metrics in the summary.

So we need to rename the web vitals from webvital_xx_xx_xx to browser_web_vital_xxx.
@ankur22 ankur22 added this to the v0.10.0 milestone May 15, 2023
@ankur22 ankur22 added refactor breaking PRs that need to be mentioned in the breaking changes section of the release notes labels May 15, 2023
@ankur22 ankur22 self-assigned this May 15, 2023
ankur22 added a commit that referenced this issue May 15, 2023
@ankur22
Rename web vital metrics
b740373 
We're renaming them from webvital_xxx_xxx_xxx to browser_web_vital_xxx.
This change benefits us in three ways:
1. Browser metrics will be namespaced with browser_
2. webvital is two words, so web vital
3. We're assuming that users will have the context of web vital metrics
so that we can use the abbreviations which also helps with the display
of them at the end of the test run.

Closes: #884
@ankur22 ankur22 mentioned this issue May 15, 2023
Merged
ankur22 added a commit that referenced this issue May 15, 2023
@ankur22
Rename web vital metrics
669dd75 
We're renaming them from webvital_xxx_xxx_xxx to browser_web_vital_xxx.
This change benefits us in three ways:
1. Browser metrics will be namespaced with browser_
2. webvital is two words, so web vital
3. We're assuming that users will have the context of web vital metrics
so that we can use the abbreviations which also helps with the display
of them at the end of the test run.

Closes: #884
@ankur22 ankur22 mentioned this issue May 16, 2023
Merged
ankur22 added a commit that referenced this issue May 17, 2023
@ankur22
Rename web vital metrics
be6980d 
We're renaming them from webvital_xxx_xxx_xxx to browser_web_vital_xxx.
This change benefits us in three ways:
1. Browser metrics will be namespaced with browser_
2. webvital is two words, so web vital
3. We're assuming that users will have the context of web vital metrics
so that we can use the abbreviations which also helps with the display
of them at the end of the test run.

Closes: #884
ankur22 added a commit that referenced this issue May 18, 2023
@ankur22
Rename web vital metrics
5e77e5d 
We're renaming them from webvital_xxx_xxx_xxx to browser_web_vital_xxx.
This change benefits us in three ways:
1. Browser metrics will be namespaced with browser_
2. webvital is two words, so web vital
3. We're assuming that users will have the context of web vital metrics
so that we can use the abbreviations which also helps with the display
of them at the end of the test run.

Closes: #884
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ankur22 ankur22

Labels
breaking PRs that need to be mentioned in the breaking changes section of the release notes refactor
Projects
None yet
Milestone
v0.10.0
Development

Successfully merging a pull request may close this issue.

Rename web vital metrics grafana/xk6-browser
1 participant
@ankur22