-
Notifications
You must be signed in to change notification settings - Fork 224
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
Restructure metrics #1151
Restructure metrics #1151
Conversation
There's a version of the docs published here: https://mdr-ci.staging.k6.io/docs/refs/pull/1151/merge It will be deleted automatically in 30 days. |
@MattDodsonEnglish Something to consider as part of these changes:
|
@ppcano Perhaps those can happen in a separate PR? I'd like to merge this, then iterate on top. As it stands, I think even merging today is an improvement, so I'd rather do it incrementally. Also, some comments
It looks like the docs for redis and maybe browser don't have metrics yet. Need to investigate what they are. I agree, I'm not sure what strategy is better:
|
src/data/markdown/translated-guides/en/02 Using k6/02 Metrics/100 Create custom metrics.md
Outdated
Show resolved
Hide resolved
src/data/markdown/translated-guides/en/02 Using k6/02 Metrics/100 Create custom metrics.md
Show resolved
Hide resolved
src/data/markdown/translated-guides/en/02 Using k6/02 Metrics/100 Create custom metrics.md
Outdated
Show resolved
Hide resolved
If you need help constructing a custom metric, read the following sections of this document. | ||
They document the procedure and provide examples. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why are we adding examples for each type in this page? Isn't it better to have them in the dedicated doc for each type?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We do also have examples in the metrics reference docs. It is indeed redundant, but I'm trying to think of how someone who's looking to make a custom metric may arrive in one of two places (here or the reference).
It's also at the end, so the most important information is at the top.
Not sure though, maybe it'd be better to just delete and remove the duplication... 🤔
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe one could be a link to the other?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it's better, more efficient.
Here's a nice red diff: 7de40f7
src/data/markdown/translated-guides/en/02 Using k6/02 Metrics/100 Create custom metrics.md
Outdated
Show resolved
Hide resolved
src/data/markdown/translated-guides/en/02 Using k6/02 Metrics/100 Create custom metrics.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Ivan <2103732+codebien@users.noreply.github.com>
Co-authored-by: Ivan <2103732+codebien@users.noreply.github.com>
src/data/markdown/translated-guides/en/02 Using k6/02 Metrics/100 Create custom metrics.md
Outdated
Show resolved
Hide resolved
It applies really to thresholds
Possible improvements: