batch( requests )

Batch multiple HTTP requests together, to issue them in parallel over multiple TCP connections.

Parameter	Type	Description
requests	array \| object	An array or object containing requests, in string or object form

When each request is specified as an array, the order of the arguments for each request is as follows:

Position	Name	Type	Description
1	method	string	Mandatory. The HTTP method of the request. One of GET, POST, PUT, PATCH, DELETE, HEAD or OPTION.
2	url	string / HTTP URL	Mandatory. The URL to request.
3	body (optional)	string / object / ArrayBuffer	The body of the request if relevant. Can be set to null if not applicable but you want to set the last params argument.
4	params (optional)	object	Params like auth, custom headers and tags.

Returns

Type	Description
object	The returned object contains Response objects. It is an array when users pass an array as requests and is an ordinary object with string keys when named requests are used (see below).

Example with request as an array

import http from 'k6/http';
import { check } from 'k6';

export default function () {
  const responses = http.batch([
    ['GET', 'https://test.k6.io', null, { tags: { ctype: 'html' } }],
    ['GET', 'https://test.k6.io/style.css', null, { tags: { ctype: 'css' } }],
    ['GET', 'https://test.k6.io/images/logo.png', null, { tags: { ctype: 'images' } }],
  ]);
  check(responses[0], {
    'main page status was 200': (res) => res.status === 200,
  });
}

Example batching three URLs for parallel fetching

import http from 'k6/http';
import { check } from 'k6';

export default function () {
  const responses = http.batch([
    ['GET', 'https://test.k6.io', null, { tags: { ctype: 'html' } }],
    ['GET', 'https://test.k6.io/style.css', null, { tags: { ctype: 'css' } }],
    ['GET', 'https://test.k6.io/images/logo.png', null, { tags: { ctype: 'images' } }],
  ]);
  check(responses[0], {
    'main page status was 200': (res) => res.status === 200,
  });
}

Example with request objects

You can also use objects to hold information about a request. Here's an example where we do that to send a POST request, also using the Params object to give the request custom headers:

import http from 'k6/http';
import { check } from 'k6';

export default function () {
  const req1 = {
    method: 'GET',
    url: 'https://httpbin.test.k6.io/get',
  };
  const req2 = {
    method: 'GET',
    url: 'https://test.k6.io',
  };
  const req3 = {
    method: 'POST',
    url: 'https://httpbin.test.k6.io/post',
    body: {
      hello: 'world!',
    },
    params: {
      headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
    },
  };
  const responses = http.batch([req1, req2, req3]);
  // httpbin.test.k6.io should return our POST data in the response body, so
  // we check the third response object to see that the POST worked.
  check(responses[2], {
    'form data OK': (res) => JSON.parse(res.body)['form']['hello'] == 'world!',
  });
}

Note that the requests in the example above may happen in any order, or simultaneously. When running requests in batches, there is no guarantee that e.g. req1 will happen before req2 or req3

Example with named requests

Finally, you can also send in named requests by using an object instead of an array as the parameter to http.batch(). In the following example we do this, and we also show that it is possible to mix string URLs and request objects

import http from 'k6/http';
import { check } from 'k6';

export default function () {
  const requests = {
    'front page': 'https://k6.io',
    'features page': {
      method: 'GET',
      url: 'https://k6.io/features',
      params: { headers: { 'User-Agent': 'k6' } },
    },
  };
  const responses = http.batch(requests);
  // when accessing results, we use the name of the request as index
  // to find the corresponding Response object
  check(responses['front page'], {
    'front page status was 200': (res) => res.status === 200,
  });
}

Init context

k6

k6/crypto

k6/data

k6/encoding

k6/execution

k6/html

k6/http

k6/metrics

k6/net/grpc

k6/ws

Error Codes

batch( requests )

Returns

Example with request as an array

Example batching three URLs for parallel fetching

Example with request objects

Example with named requests

Product

Resources

Community

About