Menu

Technical documentation Plugin catalog

Choose a product

Viewing: v0.48.x Find another version

Troubleshooting

Create custom metrics

Built-in metrics

How to use options

Options reference

Tags and Groups

Online Certificate Status Protocol (OCSP)

SSL/TLS client certificates

SSL/TLS version and ciphers

Environment variables

Execution context variables

Arrival-rate VU allocation

Dropped iterations

Open and closed models

Shared iterations

Per VU iterations

Constant arrival rate

Ramping arrival rate

Externally controlled

Advanced Examples

Create tests from recordings

Using the browser recorder

Using the HAR converter

Using k6 browser

Running browser tests

Browser metrics

Migrating to k6 v0.46

Recommended practices

Hybrid approach to performance

Page object model

Selecting elements

Amazon CloudWatch

Grafana Cloud k6

Grafana Cloud Prometheus

Prometheus remote write

Grafana dashboards

Load test types

Average-load testing

Breakpoint testing

API load testing

Automated performance testing

Load testing websites

Running large tests

Running distributed tests

Injecting faults with xk6-disruptor

xk6-disruptor first steps

Expose your application

How xk6-disruptor works

xk6-disruptor examples

Inject gRPC faults into Service

Inject HTTP faults into Pod

Interactive demo

open( filePath, [mode] )

check( val, sets, [tags] )

group( name, fn )

randomSeed( int )

createHash( algorithm )

createHMAC( algorithm, secret )

hmac( algorithm, secret, data, outputEncoding )

md4( input, outputEncoding )

md5( input, outputEncoding )

randomBytes( int )

ripemd160( input, outputEncoding )

sha1( input, outputEncoding )

sha256( input, outputEncoding )

sha384( input, outputEncoding )

sha512( input, outputEncoding )

sha512_256( input, outputEncoding )

sha512_224( input, outputEncoding )

b64decode( input, [encoding], [format] )

b64encode( input, [encoding] )

k6/experimental

addInitScript()

clearPermissions()

cookies([urls])

grantPermissions(permissions[, options])

setDefaultNavigationTimeout(timeout)

setDefaultTimeout(timeout)

setGeolocation(geolocation)

setOffline(offline)

waitForEvent(event[, optionsOrPredicate])

check([options])

click([options])

dblclick([options])

dispatchEvent(type, eventInit, [options])

fill(value, [options])

focus([options])

getAttribute(name, [options])

hover([options])

innerHTML([options])

innerText([options])

inputValue([options])

isChecked([options])

isDisabled([options])

isEditable([options])

isEnabled([options])

isHidden([options])

isVisible([options])

press(key, [options])

selectOption(values, [options])

textContent([options])

type(text, [options])

uncheck([options])

waitFor([options])

check(selector[, options])

click(selector[, options])

dblclick(selector[, options])

dispatchEvent(selector, type, eventInit[, options])

emulateMedia([options])

emulateVisionDeficiency(type)

evaluate(pageFunction[, arg])

evaluateHandle(pageFunction[, arg])

fill(selector, value[, options])

focus(selector[, options])

getAttribute(selector, name[, options])

goto(url[, options])

hover(selector[, options])

innerHTML(selector[, options])

innerText(selector[, options])

inputValue(selector[, options])

isChecked(selector[, options])

isDisabled(selector[, options])

isEditable(selector[, options])

isEnabled(selector[, options])

isHidden(selector[, options])

isVisible(selector[, options])

locator(selector)

on(event, handler)

press(selector, key[, options])

reload([options])

screenshot([options])

selectOption(selector, values[, options])

setContent(html[, options])

setDefaultNavigationTimeout(timeout)

setDefaultTimeout(timeout)

setExtraHTTPHeaders(headers)

setViewportSize(viewportSize)

tap(selector[, options])

textContent(selector[, options])

throttleCPU(cpuProfile)

throttleNetwork(networkProfile)

type(selector, text[, options])

uncheck(selector[, options])

waitForFunction(pageFunction, arg[, options])

waitForLoadState(state[, options])

waitForNavigation([options])

waitForSelector(selector[, options])

waitForTimeout(timeout)

newContext([options])

newPage([options])

Client.load(importPaths, ...protoFiles)

Client.loadProtoset(protosetPath)

Client.connect(address [,params])

Client.invoke(url, request [,params])

Client.decr(key)

Client.decrBy(key, decrement)

Client.del(keys)

Client.exists(keys)

Client.expire(key, seconds)

Client.get(key)

Client.getDel(key)

Client.getSet(key, value)

Client.hdel(key, fields)

Client.hget(key, field)

Client.hgetall(key)

Client.hincrby(key, field, increment)

Client.hkeys(key)

Client.hlen(key)

Client.hset(key, field, value)

Client.hsetnx(key, field, value)

Client.hvals(key)

Client.incr(key)

Client.incrBy(key, increment)

Client.lindex(key)

Client.llen(key)

Client.lpop(key)

Client.lpush(key, values)

Client.lrange(key, start, stop)

Client.lrem(key, count, value)

Client.lset(key, index, element)

Client.mget(keys)

Client.persist(key)

Client.randomKey()

Client.rpop(key)

Client.rpush(key, values)

Client.sadd(key, members)

Client.sendCommand(command, args)

Client.set(key, value, expiration)

Client.sismember(key, member)

Client.smembers(key)

Client.spop(key)

Client.srandmember(key)

Client.srem(key, members)

Client.ttl(key)

WebSocket.addEventListener(event, handler)

WebSocket.send(data)

WebSocket.close([code])

WebSocket.ping()

WebSocket.onclose

WebSocket.onerror

WebSocket.onmessage

WebSocket.onopen

WebSocket.onping

WebSocket.onpong

getRandomValues

AesKeyGenParams

HmacKeyGenParams

parseHTML( src )

Selection.attr(name)

Selection.children([selector])

Selection.closest(selector)

Selection.contents()

Selection.data([key])

Selection.each(fn)

Selection.eq(index)

Selection.filter(selector)

Selection.find(selector)

Selection.first()

Selection.get(index)

Selection.has(selector)

Selection.html()

Selection.is(selector)

Selection.last()

Selection.map(fn)

Selection.next([selector])

Selection.nextAll([selector])

Selection.nextUntil([selector], [filter])

Selection.not(selector)

Selection.parent([selector])

Selection.parents([selector])

Selection.parentsUntil([selector], [filter])

Selection.prev([selector])

Selection.prevAll([selector])

Selection.prevUntil([selector], [filter])

Selection.serialize()

Selection.serializeArray()

Selection.serializeObject()

Selection.size()

Selection.slice(start [, end])

Selection.text()

Selection.toArray()

Selection.val()

asyncRequest( method, url, [body], [params] )

batch( requests )

del( url, [body], [params] )

file( data, [filename], [contentType] )

get( url, [params] )

head( url, [params] )

options( url, [body], [params] )

patch( url, [body], [params] )

post( url, [body], [params] )

put( url, [body], [params] )

request( method, url, [body], [params] )

setResponseCallback( callback )

expectedStatuses( statuses )

CookieJar.clear(url)

CookieJar.cookiesForURL(url)

CookieJar.delete(url, name)

CookieJar.set(url, name, value, [options])

Response.clickLink( [params] )

Response.html()

Response.json( [selector] )

Response.submitForm( [params] )

Counter.add(value, [tags])

Gauge.add(value, [tags])

Rate.add(value, [tags])

Trend.add(value, [tags])

Client.load(importPaths, ...protoFiles)

Client.loadProtoset(protosetPath)

Client.connect(address [,params])

Client.invoke(url, request [,params])

connect( url, params, callback )

Socket.close([code])

Socket.on(event, callback)

Socket.send(data)

Socket.sendBinary(data)

Socket.setInterval(callback, interval)

Socket.setTimeout(callback, delay)

xk6-disruptor API

Pod Termination

injectGrpcFaults()

injectHTTPFaults()

terminatePods()

ServiceDisruptor

injectGrpcFaults

injectHTTPFaults

terminatePods()

EventBridgeClient

generateDataKey

abortMultipartUpload

completeMultipartUpload

createMultipartUpload

S3MultipartUpload

S3UploadedObject

SecretsManagerClient

receiveMessages

sendMessageBatch

SystemsManagerClient

SystemsManagerParameter

asyncRequest(method, url, [body], [params])

request(method, url, [body], [params])

get(url, [body], [params])

post(url, [body], [params])

put(url, [body], [params])

patch(url, [body], [params])

delete(url, [body], [params])

options(url, [body], [params])

head(url, [body], [params])

trace(url, [body], [params])

batch( requests )

setBaseUrl( url )

addHeader( key, value )

addHeaders( object )

clearHeader( name )

addTag( key, value )

addTags( object )

clearTag( name )

describe( name, function )

randomIntBetween(min, max)

randomItem(array)

randomString(length, [charset])

findBetween(content, left, right, [repeat])

normalDistributionStages(maxVus, durationSeconds, [numberOfStages])

Explore extensions

Build a k6 binary using Go

Build a k6 binary using Docker

Create an extension

JavaScript Extensions

Output Extensions

About the Extensions Registry

About the Go-to-JS bridge

Extension Graduation

Get started with k6

Test for functional behavior

Test for performance

Analyze results

Reuse and re-run tests

HTTP Authentication

OAuth Authentication

Correlation and Dynamic Data

Data parameterization

Cookies Example

API CRUD Operations

Generating UUIDs

Transport Layer Security (TLS)

Generating realistic data

Crawl a web page

Bundling and transpilation

Functional testing

Track transmitted data per URL

URLs with query parameters

Instant load increase

Get timings for an HTTP metric

Distribute workloads across VUs

Integrations & Tools

Usage collection

Archive Command

Scroll for more

Tutorials

Open source

Tutorials

Get started with k6
8 basic tasks to learn k6
k6 Learn
Swagger/OpenAPI integration
Schedule k6 tests with cron
Load test a GraphQL service
Use TypeScript in k6 scripts
Debug using a Web Proxy
Distributed k6 tests on K8s
Create a k6 extension

Was this page helpful?

Create a GitHub issue

Email docs@grafana.com

Help and support

Is this page helpful?