Add the ability to filter by request type in page.on('metric')

[ankur22]

Feature Description

We have page.on('metric') which allows us to group metrics when a URL match is found. The issue arises when the website under test makes different types of requests using the same URL, for example a GET to api/cart, and a POST to api/cart. In this case it's not going to be useful to group the same request together as the behaviour of them will be different.

What would be useful is to be able to filter/group also by the request type.

Suggested Solution (optional)

A possible solution is to extend the existing API so that it can also take a type field. If the type field isn't present, it will assume that all requests are to be grouped regardless of the type. If a type field is present it will take that into account:

  page.on('metric', (metric) => {
    metric.tag({
      urls: [
        {url: /^https:\/\/test\.k6\.io\/\?q=[0-9a-z]+$/, type:'GET', name:'test'},
      ]
    });
  });

Already existing or connected issues / PRs (optional)

#371
#1434

Tasks

Beta Give feedback

1. Move the name field on the `page.on('metric') API #1489
   +0
2. Add method field on Match object for page.on('metric') #1490
   +0
3. Add to release notes: https://github.com/grafana/k6/commit/da3a11112ce4cfb2f7bc9544ae9199a40df7be53
4. Add page.on('metric') type definition k6-DefinitelyTyped#73
   +0
5. Add page.on('metric') docs k6-docs#1807
   +0

[inancgumus]

The suggested (and the current) solution is mixing the tag name and URL properties.

It was fine when there was only url and name. I believe the API would be less confusing if it'd group urls by a name instead of having name as another property. Maybe something like:

page.on('metric', metric => {
  metric.tag({
    name: 'tests',
    urls: [
      {url: /^https:\/\/test\.k6\.io\/\?q=[0-9a-z]+$/, type:'GET'},
    ]
  }, {
    name: 'other',
    urls: [
      {url: /^https:\/\/test\.k6\.io\/\?q=[0-9a-z]+$/, type:'POST'},
      {url: /^https:\/\/foo\.com/, type:'GET'},
    ]
  });
});

[ankur22]

@inancgumus I can see where you are coming from, I like this approach 👍

WDYT of calling it method instead of type?

page.on('metric', metric => {
  metric.tag({
    name: 'tests',
    urls: [
      {url: /^https:\/\/test\.k6\.io\/\?q=[0-9a-z]+$/, method:'GET'},
    ]
  }, {
    name: 'other',
    urls: [
      {url: /^https:\/\/test\.k6\.io\/\?q=[0-9a-z]+$/, method:'POST'},
      {url: /^https:\/\/foo\.com/, method:'GET'},
    ]
  });
});