docs

Init context

open( filePath, [mode] )

k6

check( val, sets, [tags] )
fail( [err] )
group( name, fn )
randomSeed( int )
sleep( t )

k6/crypto

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

k6/data

SharedArray

k6/encoding

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

k6/execution

k6/experimental

browser
grpc
redis
timers
tracing
websockets
webcrypto

k6/html

parseHTML( src )
Element
Selection

k6/http

asyncRequest( method, url, [body], [params] )
batch( requests )
cookieJar()
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 )
url`url`
expectedStatuses( statuses )
CookieJar
FileData
Params
Response

k6/metrics

Counter
Gauge
Rate
Trend

k6/net/grpc

Client
Params
Response
Constants

k6/ws

connect( url, params, callback )
Params
Socket

Error Codes

k6.ioapp.k6.io

No results for “”

Powered byAlgolia
⚠️ This documentation is outdated. Please visit grafana.com for the latest k6 documentation.📚

Gauge

suggest edits

Gauge is an object for representing a custom metric holding only the latest value added. It is one of the four custom metrics.

ParameterTypeDescription
namestringThe name of the custom metric.
isTimebooleanA boolean indicating whether the values added to the metric are time values or just untyped values.
MethodDescription
Gauge.add(value, [tags])Add a value to the gauge metric. Only the latest value added will be kept.

Gauge usage in Thresholds

When gauge is used in a threshold expression, the variable must be called value (lower case). For example:

  • value < 200
  • value > 1

Examples

gauge-metric.js
1import { Gauge } from 'k6/metrics';
2

3const myGauge = new Gauge('my_gauge');
4

5export default function () {
6  myGauge.add(3);
7  myGauge.add(1);
8  myGauge.add(2, { tag1: 'value', tag2: 'value2' });
9}
gauge-threshold.js
1import http from 'k6/http';
2import { sleep } from 'k6';
3import { Gauge } from 'k6/metrics';
4

5const GaugeContentSize = new Gauge('ContentSize');
6

7export const options = {
8  thresholds: {
9    ContentSize: ['value<4000'],
10  },
11};
12

13export default function () {
14  const res = http.get('https://test-api.k6.io/public/crocodiles/1/');
15  GaugeContentSize.add(res.body.length);
16  sleep(1);
17}