Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://grafana.com/docs/k6/latest/javascript-api/k6-execution/ below:

execution | Grafana k6 documentation

Open source

The k6/execution module provides the capability to get information about the current test execution state inside the test script. You can read in your script the execution state during the test execution and change your script logic based on the current state.

k6/execution provides the test execution information with the following properties:

• instance
• scenario
• test
• vu

import exec from 'k6/execution';

export const options = {
  scenarios: {
    myscenario: {
      // this will be the returned name
      executor: 'shared-iterations',
      maxDuration: '30m',
    },
  },
};

export default function () {
  console.log(exec.scenario.name); // myscenario
}

ℹ️ Identifiers

All unique identifiers are sequentially generated starting from a base of zero (iterations) or one (VU IDs). In distributed/cloud test runs, the test-wide iteration numbers and VU identifiers are still going to be unique across instances, though there might be gaps in the sequences when, for example, some instances execute faster iterations than others or allocate more VUs mid-test.

The instance object provides information associated with the load generator instance. You can think of it as the current running k6 process, which will likely be a single process if you are running k6 on your local machine. When running a cloud/distributed test with multiple load generator instances, the values of the following properties can differ across instances.

Meta information and execution details about the current running scenario.

Control the test execution.

Meta information and execution details about the current vu.

Setting a Tag with the same key as a system tag is allowed, but it requires attention to avoid unexpected results. Overwriting system tags will not throw an error, but in most cases will not actually change the value of the emitted metrics as expected. For example, trying to set the url tag value will not result in a changed tag value when http.get() is called, since the tag value is determined by the HTTP request itself. However, it will add the tag url to the metric samples emitted by a check() or metric.add(), which is probably not the desired behavior. On the other hand, setting the name tag will work as expected, since that was already supported for http.* methods, for the purposes of the URL Grouping feature.

Not all the types are accepted as a tag value: k6 supports strings, numbers and boolean types. Under the hood, the tags object handles a Tag as a String key-value pair, so all the types will be implicitly converted into a string. If one of the denied types is used (e.g. Object or Array) and the throw option is set, an exception will be thrown. Otherwise, only a warning is printed and the tag value will be discarded.

This is a common use case for data parameterization, you can read the examples using scenario.iterationInTest and vu.idInTest.

The startTime property from the scenario object can be used to time operations.

import exec from 'k6/execution';

export default function () {
  // do some long operations
  // ...
  console.log(`step1: scenario ran for ${new Date() - new Date(exec.scenario.startTime)}ms`);

  // some more long operations
  //...
  console.log(`step2: scenario ran for ${new Date() - new Date(exec.scenario.startTime)}ms`);
}

The name property can be used for executing the logic based on which script is currently running.

Tip: If you need to run multiple scenarios in your script you can use exec option achieve a similar goal

import exec from 'k6/execution';

export const options = {
  scenarios: {
    'the-first': {
      // ...
    },
    'the-second': {
      // ...
    },
  },
};

export default function () {
  if (exec.scenario.name === 'the-first') {
    // do some logic during this scenario
  } else {
    // do some other logic in the others
  }
}

Aborting is possible during initialization:

import exec from 'k6/execution';
exec.test.abort();

As well as inside the default function:

import exec from 'k6/execution';

export default function () {
  // Note that you can abort with a specific message too
  exec.test.abort('this is the reason');
}

export function teardown() {
  console.log('teardown will still be called after test.abort()');
}

The execution.test.fail function enables controlled test failure reporting without interrupting the test execution. When called, this method marks the entire test run as failed while allowing all iterations to complete normally. The test will exit with code 110, making failures detectable by external systems. This provides graceful error handling for scenarios akin to functional testing.

import http from 'k6/http';
import exec from 'k6/execution';

export const options = {
  iterations: 10,
};

export default function () {
  http.get('https://quickpizza.grafana.com');

  if (exec.vu.iterationInInstance === 3) {
    exec.test.fail(`iteration ${exec.vu.iterationInInstance}: marked the test as failed`);
  }

  console.log(`iteration ${exec.vu.iterationInInstance} executed`);
}

Get the consolidated and derived options’ values

import exec from 'k6/execution';

export const options = {
  stages: [
    { duration: '5s', target: 100 },
    { duration: '5s', target: 50 },
  ],
};

export default function () {
  console.log(exec.test.options.paused); // null
  console.log(exec.test.options.scenarios.default.stages[0].target); // 100
}

The vu.metrics.tags property can be used for getting or setting VU’s tags.

import http from 'k6/http';
import exec from 'k6/execution';

export default function () {
  exec.vu.metrics.tags['mytag'] = 'value1';
  exec.vu.metrics.tags['mytag2'] = 2;

  // the metrics these HTTP requests emit will get tagged with `mytag` and `mytag2`:
  http.batch(['https://test.k6.io', 'https://quickpizza.grafana.com']);
}

vu.tags (without metrics) can also be used, but is deprecated for the more context-specific variant.

The vu.metrics.metadata property can be used for getting or setting VU’s metadata. It is similar to tags, but can be used for high cardinality data. It also can not be used in thresholds and will likely be handled differently by each output.

import http from 'k6/http';
import exec from 'k6/execution';

export default function () {
  exec.vu.metrics.metadata['trace_id'] = 'somecoolide';

  // the metrics these HTTP requests emit will get the metadata `trace_id`:
  http.batch(['https://test.k6.io', 'https://quickpizza.grafana.com']);

  delete exec.vu.metrics.metadata['trace_id']; // this will unset it
  // which will make the metrics these requests to not have the metadata `trace_id` set on them.
  http.batch(['https://test.k6.io', 'https://quickpizza.grafana.com']);
}

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4