Skip to content

Commit

Permalink
Update the field descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
@ankur22
ankur22 committed Nov 11, 2024
1 parent 21138e6 commit ae09e53
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions docs/sources/k6/next/javascript-api/k6-browser/metricmessage.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ Doing this helps group metrics with different URL and name tags, which are, in f

<TableWithNestedRows>

| Parameter | Type | Description |
| ----------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| tagMatch | object | It is required. The tagMatch object and its properties that are used for matching metrics. |
| 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. |
| tagMatch.matches | object[] | It is a required field. It is an array of objects containing the regular expression and optional method to match against the current metric's url and name tags. It will iterate over all the objects in `matches` until a match is found, or to the end of the array if no match is found. |
| tagMatch.matches.url | RegExp | It is a required field. It is used to match against the current metric url and name tags. |
| tagMatch.matches.method | string | It is optional. When it is not set, a match will occur on all method types. When it is set, it will match on the one method that is set. Valid values are `'GET'`, `'POST'`, `'PUT'`, `'DELETE'`, `'PATCH'`, `'OPTIONS'`, `'HEAD'`, `'TRACE'` and `'CONNECT'` |
| Parameter | Type | Description |
| ----------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| tagMatch | object | The tagMatch object and its properties that are used for matching metrics. Required. |
| tagMatch.name | string | 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. |
| tagMatch.matches | object[] | An array of objects containing the matchers which will be used to match against the current metric's URL and name tags. Required. |
| tagMatch.matches.url | RegExp | The regular expression used to find matches in the current metric's URL and name tags. Required. |
| tagMatch.matches.method | string? | Used to match the metric's method tag. Valid values are `'GET'`, `'POST'`, `'PUT'`, `'DELETE'`, `'PATCH'`, `'OPTIONS'`, `'HEAD'`, `'TRACE'` and `'CONNECT'`. It's optional, and when it's not set it will group all metrics regardless of the method tag. |

</TableWithNestedRows>

Expand Down

0 comments on commit ae09e53

Please sign in to comment.