Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.
Gauge
Gauge is an object for representing a custom metric holding only the latest value added. It is one of the four custom metrics.
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
import { Gauge } from 'k6/metrics';
const myGauge = new Gauge('my_gauge');
export default function () {
myGauge.add(3);
myGauge.add(1);
myGauge.add(2, { tag1: 'value', tag2: 'value2' });
}
import http from 'k6/http';
import { sleep } from 'k6';
import { Gauge } from 'k6/metrics';
const GaugeContentSize = new Gauge('ContentSize');
export const options = {
thresholds: {
ContentSize: ['value<4000'],
},
};
export default function () {
const res = http.get('https://test-api.k6.io/public/crocodiles/1/');
GaugeContentSize.add(res.body.length);
sleep(1);
}