Releases: grafana/k6
v0.31.0
k6 v0.31.0 is here! 🎉 It's a smaller release with some significant performance improvements, a new http_req_failed metric and changes to the output subsystem that enable output extensions with xk6!
New features
Output cleanup and extensions (#1874)
The state of k6's output packages has been a development pain point for a long time, which made it difficult to add new outputs in a consistent way. In the refactor done in v0.31.0, this has been mostly addressed and outputs now implement a simpler and cleaner Output interface.
In addition to this, it is now possible to implement custom k6 output extensions in Go with xk6! This is very useful if you use a system that's currently not supported by the built-in outputs, or need some custom handling of the metrics k6 produces.
Writing output extensions is done very similarly to how JS module extensions are currently written, though instead of calling js/modules.Register(), you should implement the new Output interface and call output.RegisterExtension() with your constructor.
We are working on the proper documentation for this, as well as the overdue xk6 documentation about JS extensions, so keep a lookout for those on k6.io/docs.
Marking requests as failed (#1856)
It's now possible to declare expected HTTP response statuses for either the entire test or for individual HTTP requests, and k6 will emit a new http_req_failed metric as well as tag HTTP metrics with expected_response: <bool>. By default, k6 will now fail requests that return HTTP 4xx/5xx response codes.
For example:
import http from 'k6/http';
// Set expected statuses globally for all requests.
http.setResponseCallback(http.expectedStatuses({min: 200, max: 399}, 418));
export default function () {
// This request will be marked as failed.
http.get('https://httpbin.test.k6.io/status/400');
// This request will be considered as "passed" because of the responseCallback override.
http.get('https://httpbin.test.k6.io/status/400', { responseCallback: http.expectedStatuses(400) });
}Running this script will produce a summary like:
http_req_duration..............: avg=204.57ms min=203.31ms med=204.57ms max=205.82ms p(90)=205.57ms p(95)=205.7ms
{ expected_response:true }...: avg=203.31ms min=203.31ms med=203.31ms max=203.31ms p(90)=203.31ms p(95)=203.31ms
http_req_failed................: 50.00% ✓ 1 ✗ 1
Note the new http_req_duration sub-metric for expected responses only, and the new http_req_failed Rate metric. This new metric and metric tag have many potential use cases, and one of the most important ones is the ability to set better thresholds. For example:
'http_req_failed': ['rate<0.1'], i.e. fail the test if more than 10% of requests fail.'http_req_duration{expected_response:true}': ['p(95)<300', 'p(99.9)<500']- fail the test if the the 95th percentile HTTP request duration is above 300ms or the 99.9th percentile is above 500ms; specifyingexpected_response:truehere may be important, because a lot of times failed requests may return more quickly than normal ones, thus skewing the results and wrongly satisfying the threshold.
If the response callback is not specified, the default expected statuses will be {min: 200, max: 399}. The previous behavior of not emitting anything can be achieved by setting the callback to null, i.e. http.setResponseCallback(null). Additionally, the expected_response tag can be disabled by removing it from the default list of system tags, e.g. k6 run --system-tags 'proto,subproto,status,method,url,name,group,check,error,error_code,tls_version,scenario,service'.
The http.setResponseCallback() is planned to allow arbitrary JS functions to process responses in the future, but for now only the http.expectedStatuses() callback is supported.
Other enhancements and UX improvements
- JS: Because of the awesome improvements to goja, the JS runtime k6 uses, it's no longer necessary for k6 to load core.js to polyfill missing JS features when using the default
--compatibility-mode=extended. So in v0.31.0 core.js has been dropped entirely, yielding some significant CPU and memory usage improvements. The actual numbers will depend on the use case, but for simple tests users can expect a memory drop of about 2MB per VU (from ~2.7MB to ~600KB), and a slight CPU decrease of about 5-10%. For more complex tests with a lot of JS code this benefit won't be as pronounced. Another benefit of this change is that initializing VUs and starting a test is substantially faster than before! (#1824) - JS: Also because of goja improvements, some unused Babel plugins were disabled which should have minor performance benefits as well. (#1822)
- JS: Expanded
ArrayBuffersupport in most internal modules, so now you can passArrayBuffertohttp.file(), ink6/encodingandk6/cryptofunctions. This makes working with binary files more efficient as it doesn't require string translations. In upcoming versions we plan to expand this to the WebSocket module, as well as make some potentially breaking changes for APIs that currently return an array of integers or string (see the details in the Breaking Changes announcement below). (#1800) - The Docker image base was updated to Alpine 3.13. Thanks @andriisoldatenko! (#1821)
- The Debian package now includes
ca-certificatesas a dependency. Thanks @Bablzz! (#1854)
Bugs fixed!
- Execution: Aborting a test during VU initialization (e.g. with
^C) will now properly propagate to any used outputs. (#1869) - Execution: A race condition between the Engine and the outputs' finalization code was fixed, ensuring that all metrics are properly emitted before exiting. (#1869)
- Execution: Another race condition in the Engine was fixed, which may have resulted in the end-of-test summary missing some of the last test metric data. (#1888)
- Cloud: the test name is now properly validated and will raise an error if not set via the
ext.loadimpact.nameJS option or config, or theK6_CLOUD_NAMEenvironment variable. (#1870) - JS: Babel is now also run on compilation errors, which improves support of some obscure language features. (#1861)
- JS:
SharedArrayintroduced in v0.30.0 can now be iterated withforEach. (#1848)
Internals
- JS:
SharedArraywas rewritten usinggoja.DynamicArraymaking it more performant and easier to reason about. (#1848) - JS: Some TC39 tests for unsupported features were disabled, improving the runtime of the test suite. (#1816)
- CI: Some more tests were enabled on Windows. (#1855)
Breaking changes
- JS: While we don't expect the core.js removal and Babel changes to impact the vast majority of users, those were substantial changes in how k6 interprets JS and a minority of users might experience issues with their tests. Please report any unexpected JavaScript errors by creating a GitHub issue. In particular
Promiseis nowundefined, and some unused Babel plugins liketransform-es2015-for-ofandtransform-regeneratorwere also removed. This means that some workarounds like the ones mentioned here and here also won't work as is and will need additional polyfills and plugins to work properly.
Planned future breaking changes
The following are not breaking changes in this release, but we'd like to announce them so users can prepare for them in upcoming releases (likely k6 v0.32.0).
- JS: The
ArrayBufferchanges in this release are backwards compatible and shouldn't cause any issues, but in v0.32.0 some JS APIs that currently return an array of integers or string for binary data will returnArrayBufferinstead. This is the case foropen()when used with the'b'argument, response bodies for requests that specifyresponseType: 'binary',crypto.randomBytes(),hasher.digest('binary'), andencoding.b64decode().Response.json()andResponse.html()will also probably stop working when used with requests that specifyresponseType: 'binary'. These changes shouldn't be a problem for most users that were simply using these values to pass them to other internal modules (e.g. opening a binary file and passing it tohttp.post()), but if the scripts modified the binary data or depended on the current array of integers or string values they will need to be adapted to use [typed arrays](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Typed_...
v0.30.0
k6 v0.30.0 is here! 🎉 It was a bit of a slow after-holiday release, but it still packs a few major new features and improvements that users have been requesting for a long time!
New features
Share memory between VUs using read-only arrays (#1739)
k6 has long had an issue with the handling of big data files with test fixtures. For example, if you have a huge users.json file with test users for your application:
[
{"username": "user1", "password": "password1", "other": "some-long-data-....-1"},
{"username": "user2", "password": "password2", "other": "some-long-data-....-2"},
// ... ~1 million more users or more... :D
{"username": "user999999", "password": "password999999", "other": "some-long-data-....-999999"}
]If you just use JSON.parse(open('users.json')) in your script, then every VU will have a copy of the whole huge data set. Every VU in k6 is a separate JavaScript runtime, so there wasn't a thread-safe way to share data between them. Until now, that is!
We've added a new built-in SharedArray object in the new k6/data module that allows VUs to share read-only data:
import { SharedArray } from 'k6/data';
import { sleep } from 'k6';
import http from 'k6/http';
let users = new SharedArray('someName', function () {
// This function will be called only once, in the first init context
// execution. Every other VU will just get a memory-safe read-only reference
// to the already loaded data.
console.log('Loading users.json, this happens only once...');
// You are not restricted to JSON, you can do anything - parse a CSV or XML
// file, generate random data, etc. - as long as you return an array.
return JSON.parse(open('users.json'));
});
export let options = { vus: 10, duration: '30s' };
export default function () {
let randomUserID = Math.floor(Math.random() * users.length);
let user = users[randomUserID]; // alternatively, we can also use __VU and/or __ITER
console.log(`VU ${__VU} is running iteration ${__ITER} with user ${user.username}...`);
http.post('https://httpbin.test.k6.io/post', JSON.stringify(user));
sleep(Math.random() * 2); // or, better yet, use arrival-rate
}Notice how Loading users.json is logged only once, but each VU uses the users variable like a normal JS array. The data is read only once and we have just a single copy of the huge array in memory! Behind the scenes, k6 uses a JS Proxy to transparently copy only the row each VU requests in users[randomUserID] to it. This on-demand copying is a bit inefficient, but it's still leagues better than having a copy of the huge array in every VU! And you can avoid the copying in every iteration by pinning the data used by every VU and having let user = users[randomUserID] in the init context!
And yes, you can have multiple SharedArray objects in the same script, just make sure to give them unique names - this is what someName in the script above was for. Because VUs are independent JS runtimes, we need some way to differentiate between the different shared memory objects, so we require them to have unique names. These names are also the IDs that any xk6 extensions would need to use to access them.
This works both locally and in the cloud. We advise everyone who deals with large data files to wrap them in a SharedArray and give this new feature a try. The required script changes should be minimal, while the memory usage should be significantly lower. Hopefully, we can finally consider one of the biggest blockers k6 users have had for a long time solved! 🎉
Support a handleSummary() callback at the end of the test (#1768)
You can now export a function called handleSummary() and k6 will call it at the end of the test run, after even teardown(). handleSummary() will be called with a JS object containing the same information that is used to generate the end-of-test summary and --summary-export, and allows users to completely customize how the end-of-test summary looks like.
Besides customizing the end-of-test CLI summary (if handleSummary() is exported, k6 will not print the default), you can also transform the summary data to various machine or human-readable formats and save it to files. This allows the creation of JS helper functions that generate JSON, CSV, XML (JUnit/xUnit/etc.), HTML, etc. files from the summary data. Even binary formats like PDF are not out of reach, potentially, with an appropriate JS library that works in k6! You can also send the generated reports to a remote server by making an HTTP request with them (or using any of the other protocols k6 already supports)! Here's a simple example:
import http from 'k6/http';
import k6example from 'https://raw.githubusercontent.com/loadimpact/k6/master/samples/thresholds_readme_example.js';
export default k6example; // use some predefined example to generate some data
export const options = { vus: 5, iterations: 10 };
// These are still very much WIP and untested, but you can use them as is or write your own!
import { jUnit, textSummary } from 'https://jslib.k6.io/k6-summary/0.0.1/index.js';
export function handleSummary(data) {
console.log('Preparing the end-of-test summary...');
// Send the results to some remote server or trigger a hook
let resp = http.post('https://httpbin.test.k6.io/anything', JSON.stringify(data));
if (resp.status != 200) {
console.error('Could not send summary, got status ' + resp.status);
}
return {
'stdout': textSummary(data, { indent: ' ', enableColors: true}), // Show the text summary to stdout...
'junit.xml': jUnit(data), // but also transform it and save it as a JUnit XML...
'summary.json': JSON.stringify(data), // and a JSON with all the details...
// And any other JS transformation of the data you can think of,
// you can write your own JS helpers to transform the summary data however you like!
}
}k6 expects handleSummary() to return a {key1: value1, key2: value2, ...} map. The values can be string or ArrayBuffer and represent the generated summary report contents. The keys should be strings and determine where the contents will be displayed or saved: stdout for standard output, stderr for standard error, or a path to a file on the system (which will be overwritten).
The format of the data parameter is similar but not identical to the data format of --summary-export. The format of --summary-export remains unchanged, for backwards compatibility, but the data format for this new k6 feature was made more extensible and had some of the ambiguities and issues from the previous format fixed. We can't cover the new format in the release notes, though you can easily see what it contains by using return { 'stdout': JSON.stringify(data)}; in handleSummary()! 😄
This feature is only available for local k6 run tests for now, though we plan to support k6 cloud tests eventually. And, as mentioned in the snippet above, the JS helper functions that transform the summary in various formats are far from final, so keep an eye on jslib.k6.io for updates. Or, better yet, submit PRs with improvements and more transformations at https://github.com/loadimpact/jslib.k6.io 😄
Other enhancements and UX improvements
- CI: k6 releases for Windows will now be digitally signed, which should reduce the number and severity of warnings Windows users see; the warnings would hopefully disappear altogether once Microsoft sees enough usage of the signed k6 releases to trust us (#1746). The installer and binary were also enhanced with more metadata and had their look updated with the new k6 logo and styling (#1727).
- JS: goja, the JS runtime k6 uses, was updated to its latest
masterversion. This includes a few bugfixes and support for several new features, so--compatibility-mode=baseis even more feature-rich at no additional runtime cost. We are contributing patches to goja in an effort to completely drop core.js and have the benefit of lower CPU and memory usage per VU even with--compatibility-mode=extendedin the next k6 version! 🎉 - Config: integer values for
durationand similar time values in the exported scriptoptionsand environment variables are now treated as milliseconds. Similarly, thetimeoutoption inhttp.Paramscan now be "stringy", e.g."30s","1m10s", etc. (#1738). - HTTP: k6 now accepts
ArrayBuffervalues for the HTTP request body (#1776). This is a prelude/MVP for us gradually adoptingArrayBufferfor all binary data in k6 (#1020). - Docker: We've added
WORKDIR /home/k6to our officialDockerfile(#1794).
Bugs fixed!
- HTTP: updated the
golang.org/x/cryptoandgolang.org/x/netdependencies, which should have resolved some corner case issues with HTTP/2 connections, since k6 depends ongolang.org/x/net/http2(#1734). - HTTP: fixed a couple of issues with
blockHostnamesthat prevented zero-length matches for wildcards, as well as the ex...
v0.29.0
k6 v0.29.0 is here! 🎉 It's a feature-packed release with tons of much-requested changes and additions, a lot of them implemented by awesome external contributors! ❤️
As promised in the previous release notes, we're trying to stick to a roughly 8-week release cycle, so you can expect the next k6 version at the start of January 2021, barring any bugfix releases before that.
New features
Initial support for gRPC (#1623)
k6 now supports unary gRPC calls via the new k6/net/grpc built-in module. Streaming RPCs are not yet supported and the JS API is in beta, so there might be slight breaking changes to the API in future k6 versions, but it's a good start on the road to fully supporting this much-requested protocol!
This is a simple example of how the new module can be used with grpcb.in:
import grpc from "k6/net/grpc";
let client = new grpc.Client();
// Download addsvc.proto for https://grpcb.in/, located at:
// https://raw.githubusercontent.com/moul/pb/master/addsvc/addsvc.proto
// and put it in the same folder as this script.
client.load(null, "addsvc.proto");
export default () => {
client.connect("grpcb.in:9001", { timeout: "5s" });
let response = client.invoke("addsvc.Add/Sum", {
a: 1,
b: 2
});
console.log(response.message.v); // should print 3
client.close();
}You can find more information and examples how to use k6's new gRPC testing capabilities in our documentation.
Huge thanks to @rogchap for adding this feature!
New options for configuring DNS resolution (#1612)
You can now control some aspects of how k6 performs DNS resolution! Previously, k6 would have cached DNS responses indefinitely (#726) and always picked the first resolved IP (#738) for all connections. This caused issues, especially when load testing services that relied on DNS for load-balancing or auto-scaling.
For technical reasons explored in (#726), k6 v0.29.0 still doesn't respect the actual TTL value of resolved IPs, that will be fixed in a future k6 version. For now, it simply allows users to specify a global static DNS TTL value and resolution strategy manually. It also has better defaults! Now, by default, the global DNS TTL value is 5 minutes and, if the DNS resolution returned multiple IPs, k6 will pick a random (preferably IPv4) one for each connection.
You can also configure this behavior with the new --dns CLI flag, the K6_DNS environment variable, or the dns script/JSON option. Three DNS resolution options are exposed in this k6 version: ttl, select, and policy.
Possible ttl values are :
0: no caching at all - each request will trigger a new DNS lookup.inf: cache any resolved IPs for the duration of the test run (the old k6 behavior).- any time duration like
60s,5m30s,10m,2h, etc.; if no unit is specified (e.g.ttl=3000), k6 assumes milliseconds. The new default value is5m.
Possible select values are:
first- always pick the first resolved IP (the old k6 behavior).random- pick a random IP for every new connection (the new default value).roundRobin- iterate sequentially over the resolved IPs.
Possible policy values are:
preferIPv4: use IPv4 addresses, if available, otherwise fall back to IPv6 (the new default value).preferIPv6: use IPv6 addresses, if available, otherwise fall back to IPv4.onlyIPv4: only use IPv4 addresses, ignore any IPv6 ones.onlyIPv6: only use IPv6 addresses, ignore any IPv4 ones.any: no preference, use all addresses (the old k6 behavior).
Here are some configuration examples:
k6 run --dns "ttl=inf,select=first,policy=any" script.js # this is the old k6 behavior
K6_DNS="select=random,ttl=5m,policy=preferIPv4" k6 cloud script.js # new default behavior
# syntax for the JSON config file or for the exported script `options`:
echo '{"dns": {"select": "roundRobin", "ttl": "1h33m7s", "policy": "onlyIPv6"}}' > config.json
k6 run --config "config.json" script.jsSupport for Go extensions (#1688)
After some discussions (#1353) and exploration of different approaches for Go-based k6 extensions, we've settled on adopting something very similar to caddy's extensions. In short, xk6 (modeled after xcaddy) is a small stand-alone tool that will be able to build custom k6 binaries with 3rd party extensions bundled in. The extensions can be simple Git repositories (no central infrastructure needed!) with Go modules. They will be fully compiled, not interpreted, a part of the final custom k6 binary users will be able to build with k6.
xk6 is not yet stable or documented, so any extension authors will struggle until we stabilize and document everything in the coming weeks. The important part is that the k6 changes that would allow xk6 to work were implemented in #1688, so k6 v0.29.0 is the first version compatible with xk6!
Expect more information soon, but for a brief example, xk6 will work somewhat like this:
xk6 build v0.29.0 --with github.com/k6io/xk6-k8s --with github.com/k6io/[email protected]
./k6 run some-script-with-sql-and-k8s.jsThanks, @andremedeiros, for pushing us to add plugins in k6 and for making a valiant attempt to harness Go's poor plugin API! Thank you, @mardukbp, for pointing us towards the xcaddy approach and explaining its benefits!
Support for setting local IPs, potentially from multiple NICs (#1682)
You can now specify a list of source IPs, IP ranges and CIDRs for k6 run, from which VUs will make requests via the new --local-ips CLI flag or K6_LOCAL_IPS environment variable. The IPs will be sequentially given out to VUs, allowing you to distribute load between different local addresses. This option doesn't change anything on the OS level, so the IPs need to already be configured on the OS level in order for k6 to be able to use them.
The biggest use case for this feature is splitting the network traffic from k6 between multiple network adapters, thus potentially greatly increasing the available network throughput. For example, if you have 2 NICs, you can run k6 with --local-ips="<IP-from-first-NIC>,<IP-from-second-NIC>" to balance the traffic equally between them - half of the VUs will use the first IP and the other half will use the second. This can scale to any number of NICs, and you can repeat some local IPs to give them more traffic. For example, --local-ips="<IP1>,<IP2>,<IP3>,<IP3>" will split VUs between 3 different source IPs in a 25%:25%:50% ratio.
Thanks to @ofauchon, @srguglielmo, and @divfor for working on previous iterations of this!
New option for blocking hostnames (#1666)
You can now block network traffic by hostnames with the new --block-hostnames CLI flag / K6_BLOCK_HOSTNAMES environment variable / blockHostnames JS/JSON option. Wildcards are also supported at the beginning, allowing you to easily block a domain and all of its subdomains. For example, this will make sure k6 never attempts to connect to any k6.io subdomain (test.k6.io, test-api.k6.io, etc.) and www.example.com:
export let options = {
blockHostnames: ["*.k6.io" , "www.example.com"],
};Thanks to @krashanoff for implementing this feature!
UX and enhancements
- HTTP: The gjson library k6 uses for handling the HTTP
Response.json(selector)behavior was updated, so we now support more modifiers like@flattenand multipaths (#1626). Thanks, @sondnm! - HTTP: The status text returned by the server can now be accessed from the new
Response.status_textfield (#1649). Thanks, @lcd1232! - HTTP:
--http-debugnow emits extra UUID values that can be used to match HTTP requests and their responses (#1644). Thanks, @repl-david-winiarski! - Logging: A new
allowedLabelssub-option is added to the Loki configuration (#1639). - Cloud: when aborting a
k6 cloudtest withCtrl+C, k6 will now wait for the cloud service to fully abort the test run before returning. A secondCtrl+Cwill cause it to immediately exit (#1647), (#1705). Thanks, @theerapatcha! - JS: k6 will now attempt to recover from Go panics that occur in VU code, so they will be treated similarly to JS exceptions (#1697). This is just a precaution that should never be needed. panics should not happen and if one occurs, please report it in our issue tracker, since it's most likely a bug in k6.
Bugs fixed!
- JS: goja, the JS runtime k6 uses, was updated to its latest version, to fix some issues with regular expressions after its previous update (#1707).
- JS: Prevent loops with
--compatibility-mode=extendedwhen Babel can transpile the code but goja can't parse it (#1651). - JS: Fixed a bug that rarely caused a
context cancelederror message to be shown ([#1677](https://github.com/loadimpact/k6/pull...
v0.28.0
k6 v0.28.0 is here! 🎉 It's a small release that adds some much requested features and a few important bugfixes!
Starting with this release, we'll be trying to stick to a new 8-week fixed release schedule for new k6 versions. This release comes ~8 weeks after v0.27.0 was released, and k6 v0.29.0 should be released in mid-November.
New features and enhancements!
Cloud execution logs (#1599)
Logs from distributed k6 cloud test runs will now be shown in the terminal that executed the k6 cloud command, as well as in the k6 cloud web app on app.k6.io! 🎉 This means that, if your script contains console.log() / console.warn() / etc. calls, or some of your requests or iterations fail, you'd be able to see that and debug them much more easily! Even --http-debug data should be proxied, up to 10000 bytes per message. To prevent abuse and not to overwhelm any user terminals, cloud logs are rate-limited at 10 messages per second per instance, for now, but that should be more than enough to debug most issues!
This feature is enabled by default, though you can disable it with k6 cloud --show-logs=false script.js.
Pushing k6 logs to loki (#1576)
k6 can now push its execution logs to a loki server! This can be done via the new --log-output CLI flag or the K6_LOG_OUTPUT environment variable option. For example, k6 run --log-output "loki=https://my-loki-server/loki/api/v1/push,limit=100,level=info,msgMaxSize=10000" will push up to 100 k6 log messages per second, of severity INFO and up, truncated to 10000 bytes, to https://my-loki-server.
Optional port to host mappings (#1489)
@calavera added an extension for the host mapping feature. Now you can specify different port numbers via the hosts option, like this:
import http from 'k6/http';
export let options = {
hosts: {
'test.k6.io': '127.0.0.1:8080',
},
};Support for specifying data types to InfluxDB fields (#1395)
@TamiTakamiya added support for specifying the data type (int/float/bool/string) of fields that are emitted to InfluxDB outputs.
In order to specify the data type, you should:
- Use the environment variable
K6_INFLUXDB_TAGS_AS_FIELDS, which is used to specify which k6 metric tag values should be sent as nonindexable fields (instead of tags) to an InfluxDB output. This is specified as a comma-separated string, and is now extended to optionally allow specifying a data type to each name. - Each pair of field name and its data type is represented in the format
(name):(data_type), for example,event_processing_time:int. - One of four data types (
int,float,boolandstring) can be specified to one field name. - When the colon and a
data_typeare omitted, for exampletransaction_id, it is interpreted as a string field.
A complete example can look like this: export K6_INFLUXDB_TAGS_AS_FIELDS="vu:int,iter:int,url:string,boolField:bool,floatField:float"
Note: If you have existing InfluxDB databases that contain fields whose data types are different from the ones that you want to save in future k6 test executions, you may want to create a new database or change field names as the current InfluxDB offers limited support for changing fields' data type. See the InfluxDB documentation for more details.
Support for automatic gzip-ing of the CSV output result (#1566)
@thejasbabu added support to gzip archiving the file emitted by the CSV output on the fly. To use it, simply append .gz at the end of the file name, like this: k6 run --out csv=test.csv.gz test.js
UX
- Various spacing and progress bar rendering issues were improved (#1580).
- The k6 ASCII logo was made a bit more proportional (#1615). Thanks, @rawtaz!
- The docker-compose example setup from the k6 repo now contains a built-in simple dashboard (#1610). Thanks, @jeevananthank!
- Some logs now have a
sourcefield specifying if a log comes fromconsole,http-debugorstacktrace(when an exception has bubbled to the top of the iteration).
Bugs fixed!
- Network: IPv6 support was fixed as a part of the new
hostsport mapping (#1489). Thanks, @calavera! - Metrics: Fixed the wrong
namemetric tag for redirected requests (#1474). - UI: Fixed a
divide by zeropanic caused by some unusual execution environments that present a TTY, but return0for the terminal size (#1581). - Config: Fixed the parsing of
K6_DATADOG_TAG_BLACKLIST(#1602). - Config: Fixed marshaling of
tlsCipherSuitesandtlsVersion(#1603). Thanks, @berndhartzer! - WebSockets: Fixed a
ws.SetTimeout()andws.SetInterval()panic when float values were passed (#1608).
Internals
- goja, the JavaScript runtime k6 uses, was updated to the latest version. This means that k6 with
--compatibility-mode=basenow supports some standard library features from ES6 (goja's PR), though no new syntax yet. In future versions we plan to drop some current core.js modules that are no longer needed, which should greatly reduce memory usage per VU (#1588). - Go modules are now used to manage the k6 dependencies instead of
dep(#1584).
Breaking changes
-
k6 cloudwill now proxy execution logs back to the client machine. To disable this behavior, usek6 cloud --show-logs=false. -
--http-debugrequest and response dumps are now emitted through the logging sub-system, to facilitate the cloud log proxying (#1577).
v0.27.1
k6 v0.27.1 is a minor release with a few bugfixes and almost no functional changes compared to v0.27.0.
The biggest fix was resolving a panic (and some k6 login errors) when k6 was ran through git bash / Mintty on Windows (#1559).
k6 will now work in those terminals, however, if you're using git bash or Mintty as your terminal on Windows, you might not get the best user experience out of k6. Consider using a different terminal like Windows Terminal, PowerShell or Cmder. Alternatively, to work around the issues with the incompatible terminals, you can try running k6 through winpty, which should already be preinstalled in your git bash environment: winpty k6 run script.js.
If you're using the Windows Subsystem for Linux (WSL), you are probably going to get better experience by using the official Linux k6 binary or .deb package. For all other cases of running k6 on Windows, the normal k6 Windows binary / .msi package should work well.
Other minor fixes and changes:
- The Go version that k6 is compiled with was updated to 1.14.6, to incorporate the latest Go fixes (#1563).
- If the
throwoption is enabled, warnings for failed HTTP requests will no longer be logged to the console (#1199). - Metric sample packets sent to the cloud with
k6 run --out cloudcan now be sent in parallel via the newK6_CLOUD_METRIC_PUSH_CONCURRENCYoption, with a default value of1(#1569). - The
gracefulRampDownVU requirement calculations for theramping-vusexecutor were greatly optimized for large test runs (#1567). - Fixed a rare bug where
dropped_iterationswouldn't be emitted by theper-vu-iterationsexecutor on time due to a race (#1357). - Metrics, including checks, from
setup()andteardown(), were not correctly shown in local k6 runs (#949).
v0.27.0
k6 v0.27.0 is here! 🎉
This is a milestone release containing a major overhaul to the execution subsystem of k6, along with many improvements and bug fixes.
New features and enhancements!
New execution engine (#1007)
After 1.5 years in the making, the k6 team is proud to release the first public version of the new execution engine, offering users new ways of modeling advanced load testing scenarios that can more closely represent real-world traffic patterns.
These new scenarios are entirely optional, and the vast majority of existing k6 scripts and options should continue to work the same as before. There are several minor breaking changes and fixes of previously undefined behavior, but please create a new issue if you find some issue we haven't explicitly noted as a breaking change.
See the documentation for details and examples, or keep reading for the summary.
New executors
Some of the currently possible script execution patterns were formalized into standalone executors:
shared-iterations: a fixed number of iterations are "shared" by all VUs, and the test ends once all iterations are executed. This executor is equivalent to the globalvusanditerations(plus optionalduration) options.constant-vus: a fixed number of VUs execute as many iterations as possible for a specified amount of time. This executor is equivalent to the globalvusanddurationoptions.ramping-vus: a variable number of VUs execute as many iterations as possible for a specified amount of time. This executor is equivalent to the globalstagesoption.externally-controlled: control and scale execution at runtime via k6's REST API or the CLI.
You'd still be able to use the global vus, iterations, duration, and stages options, they are not deprecated! They are just transparently converted to one of the above executors underneath the hood. And if your test run needs just a single, simple scenario, you may never need to use more than these shortcut options. For more complicated use cases however, you can now fine-tune any of these executors with additional options, and use multiple different executors in the same test run, via the new scenarios option, described below.
Additionally, besides the 4 "old" executor types, there are 3 new executors, added to support some of the most frequently requested load testing scenarios that were previously difficult or impossible to model in k6:
per-vu-iterations: each VU executes a fixed number of iterations (#381).constant-arrival-rate: iterations are started at a specified fixed rate, for a specified duration. This allows k6 to dynamically change the amount of active VUs during a test run, to achieve the specified amount of iterations per period. This can be very useful for a more accurate representation of RPS (requests per second), for example. See #550 for details.ramping-arrival-rate: a variable number of iterations are executed in a specified period of time. This is similar to the ramping VUs executor, but instead of specifying how many VUs should loop through the script at any given point in time, the iterations per second k6 should execute at that point in time can be specified.
It's important to also note that all of these executors, except the externally-controlled one, can be used both in local k6 execution with k6 run, and in the distributed cloud execution with k6 cloud. This even includes "old" executors that were previously unavailable in the cloud, like the shared-iterations one. Now, you can execute something like k6 cloud --iterations 10000 --vus 100 script.js without any issues.
Execution scenarios and executor options
Multiple execution scenarios can now be configured in a single test run via the new scenarios option. These scenarios can run both sequentially and in parallel, and can independently execute different script functions, have different executor types and execution options, and have custom environment variables and metrics tags.
An example using 3 scenarios:
import http from 'k6/http';
import { sleep } from 'k6';
export let options = {
scenarios: {
my_web_test: { // some arbitrary scenario name
executor: 'constant-vus',
vus: 50,
duration: '5m',
gracefulStop: '0s', // do not wait for iterations to finish in the end
tags: { test_type: 'website' }, // extra tags for the metrics generated by this scenario
exec: 'webtest', // the function this scenario will execute
},
my_api_test_1: {
executor: 'constant-arrival-rate',
rate: 90, timeUnit: '1m', // 90 iterations per minute, i.e. 1.5 RPS
duration: '5m',
preAllocatedVUs: 10, // the size of the VU (i.e. worker) pool for this scenario
maxVUs: 10, // we don't want to allocate more VUs mid-test in this scenario
tags: { test_type: 'api' }, // different extra metric tags for this scenario
env: { MY_CROC_ID: '1' }, // and we can specify extra environment variables as well!
exec: 'apitest', // this scenario is executing different code than the one above!
},
my_api_test_2: {
executor: 'ramping-arrival-rate',
startTime: '30s', // the ramping API test starts a little later
startRate: 50, timeUnit: '1s', // we start at 50 iterations per second
stages: [
{ target: 200, duration: '30s' }, // go from 50 to 200 iters/s in the first 30 seconds
{ target: 200, duration: '3m30s' }, // hold at 200 iters/s for 3.5 minutes
{ target: 0, duration: '30s' }, // ramp down back to 0 iters/s over the last 30 second
],
preAllocatedVUs: 50, // how large the initial pool of VUs would be
maxVUs: 100, // if the preAllocatedVUs are not enough, we can initialize more
tags: { test_type: 'api' }, // different extra metric tags for this scenario
env: { MY_CROC_ID: '2' }, // same function, different environment variables
exec: 'apitest', // same function as the scenario above, but with different env vars
},
},
discardResponseBodies: true,
thresholds: {
// we can set different thresholds for the different scenarios because
// of the extra metric tags we set!
'http_req_duration{test_type:api}': ['p(95)<250', 'p(99)<350'],
'http_req_duration{test_type:website}': ['p(99)<500'],
// we can reference the scenario names as well
'http_req_duration{scenario:my_api_test_2}': ['p(99)<300'],
}
};
export function webtest() {
http.get('https://test.k6.io/contacts.php');
sleep(Math.random() * 2);
}
export function apitest() {
http.get(`https://test-api.k6.io/public/crocodiles/${__ENV.MY_CROC_ID}/`);
// no need for sleep() here, the iteration pacing will be controlled by the
// arrival-rate executors above!
}As shown in the example above and the documentation, all executors have some additional options that improve their flexibility and facilitate code reuse, especially in multi-scenario test runs:
- Each executor has a
startTimeproperty, which defines at what time, relative to the beginning of the whole test run, the scenario will start being executed. - Executors have a new
gracefulStopproperty that allows for iterations to complete gracefully for some amount of time after the normal executor duration is over (#879, #1033). Theramping-vusexecutor additionally also hasgracefulRampDown, to give iterations time to finish when VUs are ramped down. The default value for both options is30s, so it's a slight breaking change, but the old behavior of immediately interrupting iterations can easily be restored by setting these options to0s. - Different executors can execute different functions other than the
defaultexported one. This can be specified by theexecoption in eachscenariosconfig, and allows for more flexibility in organizing your tests, easier code reuse, building test suites, etc. - To allow for even greater script flexibility and code reuse, you can specify different environment variables and tags in each scenario, via the new
envandtagsexecutor options respectively. - k6 may now emit a new
dropped_iterationsmetric in theshared-iterations,per-vu-iterations,constant-arrival-rateandramping-arrival-rateexecutors; this is done if it can't run an iteration on time, depending on the configured rates (for the arrival-rate executors) or scenariomaxDuration(for the iteration-based executors), so it's generally a sign of a poor config or an overloaded system under test (#1529).
We've also introduced new --execution-segment and --execution-segment-sequence options, which allow for relatively easy partitioning of test runs across multiple k6 instances. Initially this applies to the test execution (all new executor types are supported!), but opens the door to test data partitioning, an often requested feature. See #997 for more details.
UX
- CLI: There are separate descriptions and real-time thread-safe progress bars for each individual executor.
- CLI: Improve module import error message ([#1439](https://github.com/loadimpact/...
v0.26.2
k6 v0.26.2 is a minor release that updates the used Go version for the Windows builds to Go 1.13.8. Due to an oversight, previous v0.26 k6 builds for Windows used an old Go version, while builds of other OSes used the correct one. This is meant to address an issue in the Go net/http package: golang/go#34285 .
There are no functional changes compared to v0.26.1.
v0.26.1
k6 v0.26.1 is here! This is a minor release that supports the rebranding of LoadImpact to k6, the new k6.io website, and the new k6 cloud service! 🎉
In practical terms, all that it means for k6 is that the URLs for cloud tests will point to https://app.k6.io, instead of https://app.loadimpact.com. The old URLs (and old k6 versions) will still continue to work - for the next 3 months the old app and the new one would work in parallel, and after that period the old app will redirect to the new one. Nothing changes in regards to the k6 open source project and our commitment to it!
You can find more information about the rebranding in our blog post about it: https://k6.io/blog/load-impact-rebranding-to-k6
Changes in this release compared to v0.26.0:
- Fix how HTTP request timeouts are specified internally. This is not a bug in current k6 releases, it only affects k6 if it is compiled with Go 1.14, which at this time is still not officially released. (#1261)
- Improve the official docker image to use an unprivileged user. Thanks, @funkypenguin! (#1314)
- Fix the unintentional sharing of
__ENVbetween VUs, which could result in data races and crashes of k6. (#1329) - Update cloud URLs to point to https://app.k6.io instead of https://app.loadimpact.com. (#1335)
v0.26.0
k6 v0.26.0 is here! 🎉
This release contains mostly bug fixes, though it also has several new features and enhancements! They include a new JS compatibility mode option, exporting the end-of-test summary to a JSON report file, speedups to the InfluxDB and JSON outputs, http.batch() improvements, a brand new CSV output, multiple layered HTTP response body decompression, being able to use console in the init context, a new optional column in the summary, and Docker improvements!
Thanks to @Sirozha1337, @openmohan, @MMartyn, @KajdeMunter, @dmitrytokarev and @dimatock for contributing to this release!
New features and enhancements!
A new JavaScript compatibility mode option (#1206)
This adds a way to disable the automatic script transformation by Babel (v6.4.2) and loading of core-js (v2) polyfills, bundled in k6. With the new base compatibility mode, k6 will instead rely only on the goja runtime and what is built into k6.
This can be configured through the new --compatibility-mode CLI flag and the K6_COMPATIBILITY_MODE environment variable. The possible values currently are:
extended: this is the default and current compatibility mode, which uses Babel and core.js to achieve ES6+ compatibility.base: an optional mode that disables loading of Babel and core.js, running scripts with only goja's native ES5.1+ compatibility. If the test scripts don't require ES6 compatibility (e.g. they were previously transformed by Babel), this option can be used to reduce RAM usage during test runs.
More info what this means can be found in the documentation.
Our benchmarks show a considerable drop in memory usage - around 80% for simple scripts, and around 50% in the case of 2MB script with a lot of static data in it. The CPU usage is mostly unchanged, except that k6 initializes test runs a lot faster. All of those benefits will be most noticeable if k6 is used with big number of VUs (1k+). More performance comparisons can be found in #1167.
JSON export of the end-of-test summary report (#1168)
This returns (from the very early days of k6) the ability to output the data from the end of test summary in a machine-readable JSON file.
This report can be enabled by the --summary-export <file_path> CLI flag or the K6_SUMMARY_EXPORT environment variable. The resulting JSON file will include data for all test metrics, checks and thresholds.
New CSV output (#1067)
There is an entirely new csv output that can be enabled by using the --out csv CLI flag. There are two things that can be configured: the output file with K6_CSV_FILENAME (by default it's file.csv), and the interval of pushing metrics to disk, which is configured with K6_CSV_SAVE_INTERVAL (1 second by default). Both of those can be configured by the CLI as well: --out csv=somefile.csv will output to somefile.csv and --out file_name=somefile.csv,save_interval=2s will output again to somefile.csv, but will flush the data every 2 seconds instead of every second.
The first line of the output is the names of columns and looks like:
metric_name,timestamp,metric_value,check,error,error_code,group,method,name,proto,status,subproto,tls_version,url,extra_tags
http_reqs,1573131887,1.000000,,,,,GET,http://httpbin.org/,HTTP/1.1,200,,,http://httpbin.org/,
http_req_duration,1573131887,116.774321,,,,,GET,http://httpbin.org/,HTTP/1.1,200,,,http://httpbin.org/,
http_req_blocked,1573131887,148.691247,,,,,GET,http://httpbin.org/,HTTP/1.1,200,,,http://httpbin.org/,
http_req_connecting,1573131887,112.593448,,,,,GET,http://httpbin.org/,HTTP/1.1,200,,,http://httpbin.org/,
All thanks to @Sirozha1337!
JSON output optimizations (#1114)
The JSON output no longer blocks the goroutine sending samples to the file, but instead (like all other outputs) buffers the samples and writes them at regular intervals (100ms and is currently not configurable). It also uses a slightly faster way of encoding the data, which should decrease the memory usage by a small amount.
Another improvement is the ability to compress the generated JSON file by simply adding .gz to the end of the file name. Compressed files are typically 30x smaller.
InfluxDB output improvements (#1113)
The InfluxDB output has been updated to use less memory and try to send smaller and consistent chunks of data to InfluxDB, in order to not drop packets and be more efficient. This is primarily done by sending data in parallel, as this seems to be better from a performance perspective, and more importantly, queuing data in separate packets, so that we don't send the data for a big time period all at once. Also, the used library was updated, which also decreased the memory usage.
Two new options were added:
K6_INFLUXDB_PUSH_INTERVAL- configures at what interval the collected data is queued to be sent to InfluxDB. By default this is "1s".K6_INFLUXDB_CONCURRENT_WRITES- configures the number of concurrent write calls to InfluxDB. If this limit is reached the next writes will be queued and made when a slot is freed. By default this is 10.
console is now available in the init context (#982):
This wasn't supported for the longest time, which made debugging things outside of VU code much harder, but now it's here! 🎉
In order to get this feature shipped in a timely manner, it currently has a known bug. The output of console calls in the init context will always be written to the stderr, even if the --console-output option is specified. This bug is tracked in #1131
HTTP response body decompression with multiple layered algorithms (#1125)
In v0.25.0 compressing bodies was added and it had support for multiple layered algorithms. Now this is also true for decompressing bodies when k6 gets them as responses.
New optional count column in the end-of-test summary (#1143)
The --summary-trend-stats now also recognizes count as a valid column and will output the count of samples in all Trend metrics. This could be especially useful for custom Trend metrics, since with them you no longer need to specify a separate accompanying Counter metric.
Docker Compose refactor (#1183)
The example docker-compose that enabled easy running of InfluxDB+Grafana+k6 was refactored and all the images were updated to use the latest stable versions.
Thanks, @KajdeMunter!
Also the k6 Dockerfile Alpine version was bumped to 3.10. Thanks @dmitrytokarev!
http.batch() improvements and optimizations (#1259)
We made several small improvements to the mechanism for executing multiple HTTP requests simultaneously from a single VU:
- Calling
http.batch()should now be more efficient, especially for many requests, because of reduced locking, type conversions, and goroutine spawning. - The default value for
batchPerHosthas been reduced from0(unlimited) to6, to more closely match browser behavior. The default value for thebatchoption remains unchanged at20. - Calling
http.batch(arg), whereargis an array, would now return an array. Previously, this would have returned an object with integer keys, as explained in #767... Nowhttp.batch()will return an array when you pass it an array, and return an object when you pass an object.
UX
- Better timeout messages for
setupandteardowntimeouts, including hints on how to fix them. (#1173) - When a folder is passed to
open(), the resulting error message will now include the path to the specified folder. (#1238) - The
k6 versionoutput will now include more information - the git commit it was built from (in most cases), as well as the used Go version and architecture. (#1235)
Bugs fixed!
- Cloud: Stop sending metrics to the cloud output when the cloud returns that you have reached the limit. (#1130)
- JS: Fail a
checkif an uncaught error is thrown inside of it. (#1137) - HTTP: Replace any user credentials in the metric sample tags with
*when emitting HTTP metrics. (#1132) - WS: Many fixes:
- JSON: Better error messages when parsing JSON fails. Now telling you at which line and row the error is instead of just the offset. Thanks, @openmohan! (#905)
- HTTP: Use Request's
GetBodyin order to be able to get the body multiple times for a single request as needed in 308 redirects of posts and if the server sends GOAWAY with no error. (#1093) - JS: Don't export internal go struct fields of script options.(#1151)
- JS: Ignore
minIterationDurationforsetupandteardown. (#1175) - HTTP: Return error on any request that returns 101 status code as k6 currently doesn't support any protocol upgrade behavior. (#1172)
- HTTP: Correctly capture TCP reset by peer and broken pipe errors and give them the appropriate
error_codemetric tag values. (#1164) - Config: Don't interpret non-
K6_prefixed environment variables as k6 configuration, most notablyDURATIONandITERATIONS. (#1215) - JS/html:
Selection.mapwas not wrapping the nodes it was outputting, which lead to wrongly using the internalGoquery.Selectioninstead of k6'sSelection. Thanks to @MMartyn for reporting this! (#1198) - HTTP: When there are redirects, k6 will now correctly set the cookie for the current URL, instead of for the one the current response is redirecting to. Thanks @dimatock! (#1201)
- Cloud: Add token to make calls to the cloud API idempotent. (#120...
v0.25.1
A minor release that fixes some of the issues in the v0.25.0 release.
Bugs fixed!
- Config: Properly handle the
systemTagsJS/JSON option and theK6_SYSTEM_TAGSenvironment variable. Thanks, @cuonglm! (#1092) - HTTP: Fix how request bodies are internally specified so we can properly handle redirects and can retry some HTTP/2 requests. (#1093)
- HTTP: Fix the handling of response decoding errors and slightly improve the
digestauth and--http-debugcode. (#1102) - HTTP: Always set the correct
Content-Lengthheader for all requests. (#1106) - JS: Fix a panic when executing archive bundles for scripts with unsuccessfull
import/require()calls. (#1097) - JS: Fix some issues related to the handling of
exportscorner cases. (#1099)