docs

Getting started

Using k6

Test authoring

Results visualization

Test Types

Testing Guides

Misc

k6.ioapp.k6.io

No results for “”

Powered byAlgolia
Using k6
HTTP Requests

HTTP Requests

suggest edits

Making HTTP Requests

When creating a new load test, the first thing you'll often do is define the HTTP requests that will be used to test your system. A simple example that just performs a GET request looks like this:

http_get.js
1import http from 'k6/http';
2
3export default function () {
4  http.get('http://test.k6.io');
5}

A slightly more complex request might be e.g. a POST request to authenticate on a site/service:

http_post.js
1import http from 'k6/http';
2
3export default function () {
4  var url = 'http://test.k6.io/login';
5  var payload = JSON.stringify({
6    email: 'aaa',
7    password: 'bbb',
8  });
9
10  var params = {
11    headers: {
12      'Content-Type': 'application/json',
13    },
14  };
15
16  http.post(url, payload, params);
17}

Available methods

Use the http module to perform all kinds of HTTP requests in your load tests.

NameValue
batch()Issue multiple HTTP requests in parallel (like e.g. browsers tend to do).
del()Issue an HTTP DELETE request.
get()Issue an HTTP GET request.
options()Issue an HTTP OPTIONS request.
patch()Issue an HTTP PATCH request.
post()Issue an HTTP POST request.
put()Issue an HTTP PUT request.
request()Issue any type of HTTP request.

HTTP Request Tags

k6 will automatically apply tags to your HTTP requests. These tags allow you to filter your results during analysis.

NameDescription
expected_response (≥ v0.31)By default, response statuses between 200 and 399 are true. Change the default behavior with setResponseCallback.
groupWhen the request runs inside a group, the tag value is the group name. Default is empty.
nameDefaults to URL requested
methodRequest method (GET, POST, PUT etc.)
scenarioWhen the request runs inside a scenario, the tag value is the scenario name. Default is default.
statusresponse status
urldefaults to URL requested

Below you can see how a test result data point (the duration of an HTTP request) is logged, in JSON format, including the various tags mentioned above:

data_point.json
1{
2  "type": "Point",
3  "metric": "http_req_duration",
4  "data": {
5    "time": "2017-06-02T23:10:29.52444541+02:00",
6    "value": 586.831127,
7    "tags": {
8      "expected_response": "true",
9      "group": "",
10      "method": "GET",
11      "name": "http://test.k6.io",
12      "scenario": "default",
13      "status": "200",
14      "url": "http://test.k6.io"
15    }
16  }
17}

URL Grouping

By default, requests report the name tag with the value of the request URL. For URLs that contain dynamic parts, this might not be desirable since it can introduce a large number of unique URLs in the metrics stream. The below code shows a situation when you'll access 100 different URLs but may want them all reported using one single metric:

grouping.js
1for (var id = 1; id <= 100; id++) {
2  http.get(`http://example.com/posts/${id}`);
3}
4
5// tags.name=\"http://example.com/posts/1\",
6// tags.name=\"http://example.com/posts/2\",

You can aggregate data from dynamic URLs by explicitly setting a name tag:

explicit_tag.js
1for (var id = 1; id <= 100; id++) {
2  http.get(`http://example.com/posts/${id}`, {
3    tags: { name: 'PostsItemURL' },
4  });
5}
6
7// tags.name=\"PostsItemURL\",
8// tags.name=\"PostsItemURL\",

Which would produce JSON output like the following:

1{
2    "type":"Point",
3    "metric":"http_req_duration",
4    "data": {
5        "time":"2017-06-02T23:10:29.52444541+02:00",
6        "value":586.831127,
7        "tags": {
8            "method":"GET",
9            "name":"PostsItemURL",
10            "status":"200",
11            "url":"http://example.com/1"
12        }
13    }
14}
15
16// and
17
18{
19    "type":"Point",
20    "metric":"http_req_duration",
21    "data": {
22        "time":"2017-06-02T23:10:29.58582529+02:00",
23        "value":580.839273,
24        "tags": {
25            "method":"GET",
26            "name":"PostsItemURL",
27            "status":"200",
28            "url":"http://example.com/2"
29        }
30    }
31}

Note how the name is the same for the two data samples related to two different URLs. Filtering the results on tag name: PostsItemURL will give you a result set including all the data points from all the 100 different URLs.

Additionally, you can use the http.url wrapper to set the name tag with a string template value:

1for (var id = 1; id <= 100; id++) {
2  http.get(http.url`http://example.com/posts/${id}`);
3}
4
5// tags.name="http://example.com/posts/${}",
6// tags.name="http://example.com/posts/${}",

Inside k6 Cloud Results

k6 Cloud Results's HTTP Table will show all the requests, on an aggregated level per URL.

k6 Cloud URL table