throttleCPU(cpuProfile)

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.

Documentationbreadcrumb arrow Grafana k6breadcrumb arrow JavaScript APIbreadcrumb arrow k6/browserbreadcrumb arrow Pagebreadcrumb arrow throttleCPU(cpuProfile)
Open source

throttleCPU(cpuProfile)

Throttles the CPU in Chrome/Chromium to slow it down by the specified rate in cpuProfile.

ParameterTypeDefaultDescription
cpuProfileCPUProfilenullThis is a mandatory parameter.
cpuProfile.ratenumber1rate as a slowdown factor (1 is no throttle, 2 is 2x slowdown, etc).

Returns

TypeDescription
Promise<void>A Promise that fulfills when the CPU has been throttled to the specified rate.

Example

JavaScript 
import { browser } from 'k6/browser';

export const options = {
  scenarios: {
    browser: {
      executor: 'shared-iterations',
      options: {
        browser: {
          type: 'chromium',
        },
      },
    },
  },
};

export default async function () {
  const context = await browser.newContext();
  const page = await context.newPage();

  try {
    await page.throttleCPU({ rate: 4 });

    await page.goto('https://test.k6.io/', { waitUntil: 'networkidle' });
  } finally {
    await page.close();
  }
}