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.

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

Add browser tracing release notes #3522

Merged
merged 5 commits into from
Jan 15, 2024

Conversation

ka3de
Copy link
Contributor

@ka3de ka3de commented Jan 8, 2024

What?

Adds release notes for tracing instrumentation implemented in k6 browser module.

Why?

Required step towards v0.49.0 release.

Checklist

  • I have performed a self-review of my code.
  • I have added tests for my changes.
  • I have run linter locally (make lint) and all checks pass.
  • I have run tests locally (make tests) and all tests pass.
  • I have commented on my code, particularly in hard-to-understand areas.

Related PR(s)/Issue(s)

grafana/xk6-browser#1100
grafana/xk6-browser#1104

@ka3de ka3de self-assigned this Jan 8, 2024
@codecov-commenter
Copy link

codecov-commenter commented Jan 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

❗ No coverage uploaded for pull request base (release-v0.49.0@9a0db12). Click here to learn what that means.

❗ Current head ceda076 differs from pull request most recent head c7d30fa. Consider uploading reports for the commit c7d30fa to get more accurate results

Additional details and impacted files
@@                Coverage Diff                 @@
##             release-v0.49.0    #3522   +/-   ##
==================================================
  Coverage                   ?   73.18%           
==================================================
  Files                      ?      267           
  Lines                      ?    20076           
  Branches                   ?        0           
==================================================
  Hits                       ?    14692           
  Misses                     ?     4470           
  Partials                   ?      914           
Flag Coverage Δ
ubuntu 73.12% <0.00%> (?)
windows 73.04% <0.00%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.


_what, why, and what this means for the user_
The browser module now generates traces that provide a representation of its inner workings, such as API methods executed (for example `browser.newPage` and `page.goto`), page navigations, and [Web Vitals](https://grafana.com/docs/k6/latest/using-k6-browser/metrics/#googles-core-web-vitals) measurements.

Copy link
Contributor Author

@ka3de ka3de Jan 8, 2024

Choose a reason for hiding this comment

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

I was thinking on adding an image here of how a browser trace is visualized in Tempo, but I see it is not a common practice in release notes to add images. Should we add a folder under release notes/ for resources that are referenced in the release notes? Or is the text description good enough?

Copy link
Contributor

Choose a reason for hiding this comment

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

Agreed, a visual representation of this would be useful. Maybe best for the release email that goes out after the release instead of here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

What are your thoughts on this @mstoykov ?

@ka3de ka3de marked this pull request as ready for review January 8, 2024 11:12
@ka3de ka3de requested review from inancgumus, ankur22 and mstoykov and removed request for codebien and joanlopez January 8, 2024 11:13
Copy link
Contributor

@ankur22 ankur22 left a comment

Choose a reason for hiding this comment

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

LGTM. I left some minor things to ponder over, but happy as it is too.


_what, why, and what this means for the user_
The browser module now generates traces that provide a representation of its inner workings, such as API methods executed (for example `browser.newPage` and `page.goto`), page navigations, and [Web Vitals](https://grafana.com/docs/k6/latest/using-k6-browser/metrics/#googles-core-web-vitals) measurements.

Copy link
Contributor

Choose a reason for hiding this comment

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

Agreed, a visual representation of this would be useful. Maybe best for the release email that goes out after the release instead of here?

release notes/v0.49.0.md Outdated Show resolved Hide resolved
release notes/v0.49.0.md Show resolved Hide resolved
Copy link
Member

@inancgumus inancgumus left a comment

Choose a reason for hiding this comment

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

LGTM 👍

release notes/v0.49.0.md Outdated Show resolved Hide resolved
release notes/v0.49.0.md Outdated Show resolved Hide resolved
Co-authored-by: İnanç Gümüş <inanc.gumus@grafana.com>
@ka3de ka3de merged commit 4e0640d into release-v0.49.0 Jan 15, 2024
19 of 21 checks passed
@ka3de ka3de deleted the add/browser-tracing-release-notes branch January 15, 2024 09:14
@ka3de
Copy link
Contributor Author

ka3de commented Jan 15, 2024

Merging this, we can review it once again with the full content from the v0.49.0 release notes.

@mstoykov mstoykov added this to the v0.49.0 milestone Jan 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants