Menu

Technical documentation Plugin catalog

Choose a product

Viewing: v1.3.x (latest) Find another version

Troubleshooting

Configure your code editor

Set up distributed k6

Install k6 Operator

Upgrade the k6 Operator

Run k6 scripts with TestRun CRD

Use k6 Operator with k6 extensions

Use the k6 Operator with Grafana Cloud k6

Configure the TestRun CRD

Schedule k6 tests

Use the k6 Operator with Istio

Usage collection

Write your first test

Run a k6 test script

Built-in metrics

Create custom 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 a test script using the CLI

Create a test script from an OpenAPI definition file

Create tests from recordings

Using the browser recorder

Using the HAR converter

JavaScript and TypeScript mode

Using k6 browser

Write your first browser test

Running browser tests

How to write browser tests

Asynchronous operations

Interact with elements on your webpage

Migrate a Playwright script to k6

Playwright APIs in k6

Recommended practices

Handle stale or dynamic elements after navigation

Hybrid approach to performance

Page object model

Prevent cookie banners from blocking interactions

Prevent too many time series error

Select elements

Simulate user input delay

Use Page.close to clean up test resources

When to use sleep() and page.waitForTimeout()

Browser metrics

Browser options

Migrating browser scripts to k6 v0.52

Amazon CloudWatch

Grafana Cloud k6

Grafana Cloud Prometheus

Prometheus remote write

Grafana dashboards

Load test types

Average-load testing

Breakpoint testing

Automated performance testing

API load testing

Calculate concurrent users for load tests

Load testing websites

Performance testing gRPC services

Running distributed tests

Running large tests

Synthetic monitoring

Use Chai with k6

Injecting faults with xk6-disruptor

xk6-disruptor first steps

Expose your application

How xk6-disruptor works

xk6-disruptor API

Pod Termination

injectGrpcFaults()

injectHTTPFaults()

terminatePods()

ServiceDisruptor

injectGrpcFaults

injectHTTPFaults

terminatePods()

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 )

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)

fill(value, [options])

getAttribute(name)

hover([options])

inputValue([options])

press(key, [options])

screenshot([options])

scrollIntoViewIfNeeded([options])

selectOption(values, [options])

selectText(values, [options])

setChecked(checked[, options])

setInputFiles(file[, options])

type(text, [options])

uncheck([options])

waitForElementState(state[, options])

waitForSelector(selector[, options])

check(selector[, options])

click(selector[, options])

dblclick(selector[, options])

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

evaluate(pageFunction[, arg])

evaluateHandle(pageFunction[, arg])

fill(selector, value[, options])

focus(selector[, options])

getAttribute(selector, name[, options])

getByAltText(altText[, options])

getByLabel(text[, options])

getByPlaceholder(placeholder[, options])

getByRole(role[, options])

getByTestId(testId)

getByText(text[, options])

getByTitle(title[, 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[, options])

press(selector, key[, options])

selectOption(selector, values[, options])

setChecked(selector, checked[, options])

setContent(html[, options])

setInputFiles(selector, file[, options])

tap(selector[, options])

textContent(selector[, options])

type(selector, text[, options])

uncheck(selector[, options])

waitForFunction(pageFunction, arg[, options])

waitForLoadState(state[, options])

waitForNavigation([options])

waitForSelector(selector[, options])

waitForTimeout(timeout)

waitForURL(url[, options])

evaluate(pageFunction[, arg])

evaluateHandle(pageFunction[, arg])

getProperties()

insertText(text)

press(key[, options])

type(text[, options])

boundingBox([options])

check([options])

clear([options])

click([options])

dblclick([options])

dispatchEvent(type, eventInit, [options])

evaluate(pageFunction[, arg])

evaluateHandle(pageFunction[, arg])

fill(value, [options])

filter(options)

focus([options])

getAttribute(name, [options])

getByAltText(altText[, options])

getByLabel(text[, options])

getByPlaceholder(placeholder[, options])

getByRole(role[, options])

getByTestId(testId)

getByText(text[, options])

getByTitle(title[, options])

hover([options])

innerHTML([options])

innerText([options])

inputValue([options])

isChecked([options])

isDisabled([options])

isEditable([options])

isEnabled([options])

locator(selector[, options])

press(key, [options])

selectOption(values, [options])

setChecked(checked[, options])

textContent([options])

type(text, [options])

uncheck([options])

waitFor([options])

getByAltText(altText[, options])

getByLabel(text[, options])

getByPlaceholder(placeholder[, options])

getByRole(role[, options])

getByTestId(testId)

getByText(text[, options])

getByTitle(title[, options])

locator(selector[, options])

click(x, y[, options])

dblclick(x, y[, options])

down([options])

move(x, y[, 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])

getByAltText(altText[, options])

getByLabel(text[, options])

getByPlaceholder(placeholder[, options])

getByRole(role[, options])

getByTestId(testId)

getByText(text[, options])

getByTitle(title[, 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[, options])

on(event, handler)

press(selector, key[, options])

reload([options])

route(url, handler)

screenshot([options])

selectOption(selector, values[, options])

setChecked(selector, checked[, options])

setContent(html[, options])

setDefaultNavigationTimeout(timeout)

setDefaultTimeout(timeout)

setExtraHTTPHeaders(headers)

setInputFiles(selector, file[, options])

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])

waitForRequest(urlPattern[, options])

waitForResponse(urlPattern[, options])

waitForSelector(selector[, options])

waitForTimeout(timeout)

waitForURL(url[, options])

headerValue(name)

isNavigationRequest()

postDataBuffer()

headerValue(name)

headerValues(name)

securityDetails()

abort([errorCode])

continue([options])

fulfill(options)

newContext([options])

newPage([options])

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

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

parse( file, [options] )

CountQueuingStrategy

ReadableStreamDefaultReader

ReadableStreamDefaultController

parseHTML( src )

Element.selection()

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.asyncInvoke(url, request [,params])

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

Client.healthCheck()

resolve( query, recordType, nameserver )

lookup( hostname )

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)

getRandomValues

AesKeyGenParams

EcdhKeyDeriveParams

HmacKeyGenParams

RsaHashedImportParams

RSAHashedKeyGenParams

EventBridgeClient

getShardIterator

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 )

http-instrumentation-pyroscope

http-instrumentation-tempo

randomIntBetween(min, max)

randomItem(array)

randomString(length, [charset])

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

normalDistributionStages(maxVus, durationSeconds, [numberOfStages])

check( val, sets, [tags] )

expect.configure()

Non-Retrying Assertions

toBeGreaterThan()

toHaveProperty()

toBeGreaterThanOrEqual()

toBeUndefined()

toContainEqual()

toBeLessThanOrEqual()

toBeInstanceOf()

Retrying Assertions

toContainText()

toHaveAttribute()

resolve( path )

Explore extensions

Run a test with extensions

Build a k6 binary using Go

Build a k6 binary using Docker

Create an extension

Quick start guide

Create an extension with a template

JavaScript extensions

Output extensions

Secret source extensions

About the Extensions Registry

About the Go-to-JS bridge

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

Use global variables in k6

Transport Layer Security (TLS)

Generating realistic data

Bundling and transpiling

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

Archive Command

Versioning and stability guarantees

Grafana k6 Studio

Grafana Cloud k6

Scroll for more

Get started

Open source

Get started

Write your first test
Running k6
Results output
k6 resources

Was this page helpful?

Suggest an edit in GitHub

Create a GitHub issue

Email docs@grafana.com

Help and support

Is this page helpful?