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

docs: add a few more k6 browser examples #1430

Merged
merged 3 commits into from
Nov 30, 2023
Merged

Conversation

mdcruz
Copy link
Contributor

@mdcruz mdcruz commented Nov 29, 2023

What?

This PR adds a few more examples of using k6 browser, mainly using custom metrics and hybrid performance.

Checklist

Please fill in this template:

  • I have used a meaningful title for the PR.
  • I have described the changes I've made in the "What?" section above.
  • I have performed a self-review of my changes.
  • I have run the make docs command locally and verified that the changes look good.

Select one of these and delete the others:

If updating the documentation for the most recent release of k6:

  • I have made my changes in the docs/sources/v{most_recent_release} folder of the documentation.
  • I have reflected my changes in the docs/sources/next folder of the documentation.
  • I have reflected my changes in the relevant (e.g. when correcting a documentation error) folders of the previous k6 versions of the documentation.

If updating the documentation for the next release of k6:

  • I have made my changes in the docs/sources/next folder of the documentation.

Related PR(s)/Issue(s)

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.

Looks like a great work :) I haven't looked it entirely, but one question.


# Hybrid performance with k6 browser

An alternative approach to [browser-based load testing](https://grafana.com/docs/k6/<K6_VERSION>/testing-guides/load-testing-websites/#browser-based-load-testing) that is much less resource-intensive is combining a low amount of virtual users for a browser test with a high amount of virtual users for a protocol-level test.
Copy link
Member

Choose a reason for hiding this comment

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

Is <K6 VERSION> here correct?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, I've looked at the existing examples and seems to be correct :)

Copy link
Collaborator

Choose a reason for hiding this comment

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

That's correct! It's how we handle versioned links in the Grafana docs, it'll change based on which version of the docs the user is in. So if they're seeing latest, the links on that page will replace <K6_version> with latest.

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

Copy link
Collaborator

@heitortsergent heitortsergent left a comment

Choose a reason for hiding this comment

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

Looks good overall! I made a few comments most of them are just to rewrite a few sentences to use active voice instead of passive to follow our style guide. 🤓

mdcruz and others added 2 commits November 30, 2023 09:31
Co-authored-by: Heitor Tashiro Sergent <heitortsergent@gmail.com>
@mdcruz mdcruz merged commit 8c788a4 into main Nov 30, 2023
6 checks passed
@mdcruz mdcruz deleted the update-k6-browser-examples branch November 30, 2023 11:15
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.

4 participants