Add page.on('metric') docs #1807
Conversation
ankur22
requested review from
inancgumus and
joanlopez
and removed request for
a team
docs/sources/k6/next/javascript-api/k6-browser/metricmessage.md
Outdated
Show resolved
Hide resolved
docs/sources/k6/next/javascript-api/k6-browser/metricmessage.md
Outdated
Show resolved
Hide resolved
docs/sources/k6/next/javascript-api/k6-browser/metricmessage.md
Outdated
Show resolved
Hide resolved
| @@ -0,0 +1,60 @@ | |||
| --- | |||
| title: 'MetricMessage' | |||
| slug: 'metricmessage' | |||
There was a problem hiding this comment.
| slug: 'metricmessage' |
If the URL is going to be the same name as the filename, you don't need the slug property here. :)
There was a problem hiding this comment.
Sure, removed in 3baf386
docs/sources/k6/next/javascript-api/k6-browser/metricmessage.md
Outdated
Show resolved
Hide resolved
docs/sources/k6/next/javascript-api/k6-browser/metricmessage.md
Outdated
Show resolved
Hide resolved
docs/sources/k6/next/javascript-api/k6-browser/metricmessage.md
Outdated
Show resolved
Hide resolved
|
|
||
| | Parameter | Type | Description | | ||
| | ----------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | tagMatch | object | It is required. | |
There was a problem hiding this comment.
Can we include something more descriptive here? Maybe "The tagMatch object and its properties that are used for matching metrics. Required."
There was a problem hiding this comment.
Sure, added in d1f8377
| | Parameter | Type | Description | | ||
| | ----------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | tagMatch | object | It is required. | | ||
| | tagMatch.name | string | It is a required field and it must not be an empty string. It will replace the current metric's url and name tag values when a match is found. | |
There was a problem hiding this comment.
I'm a little bit confused by this description and the following ones as well. 🤔
What happens with the value of this property? I'm wondering if we could tweak the description for this and the following values to be something along the lines of: "The name value that replaces the current metric's URL and name tag values, if a match is found. Required, and must not be an empty string."
There was a problem hiding this comment.
I've made the change, WDYT? 152d0b3
Co-authored-by: Heitor Tashiro Sergent <[email protected]>
|
@heitortsergent i've merged this PR in for now. Any new feedback I will work on in a new PR. 🙇 |
What?
This adds the docs for
page.on('metric'), which is a new API in the browser module.Checklist
npm startcommand locally and verified that the changes look good.docs/sources/nextfolder of the documentation.Related PR(s)/Issue(s)
grafana/xk6-browser#371, grafana/xk6-browser#1487