k6入門：k6 の Shared iterations について

よっしー

こんにちは。よっしーです(^^)

今日は、k6 の Shared iterations についてご紹介します。

背景
shared-iterations
options
いつ使用するか
サンプル
観察
おわりに

背景

Dockerで構築したWebアプリの開発環境において、k6のExecutorsについて調査したときの内容を備忘として残しました。

開発環境のソースは下記のリポジトリにあります。

GitHub - Gate-Yossi/Ran: Ran : ラーン

Ran : ラーン. Contribute to Gate-Yossi/Ran development by creating an account on GitHub.

shared-iterations

shared-iterations エグゼキューターは、イテレーションをVUの数で共有します。k6がすべてのイテレーションを実行した時点でテストが終了します。

このエグゼキューターを簡単に使用するには、vus および iterations オプションを使用できます。

注意: このエグゼキューターではイテレーションの均等な分配が保証されていないことに注意してください。より速く実行するVUは、遅いVUよりも多くのイテレーションを完了します。

特定のVUが特定の固定数のイテレーションを完了することを保証するには、per-VU iterations エグゼキューターを使用してください。

options

shared-iterations エグゼキューターには、一般的な設定オプションに加えて、以下のオプションがあります。

vus (整数): 同時に実行するVUの数。デフォルトは1です。
iterations (整数): すべてのVUで実行するスクリプトイテレーションの合計数。デフォルトは1です。
maxDuration (文字列): シナリオが強制的に停止される前の最大シナリオの実行時間（gracefulStopを除く）。デフォルトは”10m”（10分）です。

これらのオプションを調整することで、テストの振る舞いをカスタマイズできます。

いつ使用するか

shared-iterations エグゼキューターは、特定のVUの数が固定数の合計イテレーションを完了する必要があり、VUごとのイテレーション数は重要ではない場合に適しています。テストイテレーションの数を完了するまでの時間が重要な場合、このエグゼキューターが最適です。

使用例として、開発ビルドサイクル内でのクイックパフォーマンステストが考えられます。開発者が変更を行うたびに、パフォーマンスの回帰をテストするためにテストをローカルのコードに対して実行するかもしれません。したがって、このエグゼキューターは、開発サイクルの初期段階でパフォーマンスをテストすることを重視するシフト・レフトポリシーと組み合わせてうまく機能します。この段階では、修正のコストが最も低いためです。

サンプル

以下の例では、合計200のイテレーションを10つのVUで共有し、最大テスト実行時間を30秒に設定しています。

import http from 'k6/http';
import { sleep } from 'k6';

export const options = {
  discardResponseBodies: true,
  scenarios: {
    contacts: {
      executor: 'shared-iterations',
      vus: 10,
      iterations: 200,
      maxDuration: '30s',
    },
  },
};

export default function () {
  http.get('https://test.k6.io/contacts.php');
  // Injecting sleep
  // Sleep time is 500ms. Total iteration time is sleep + time to finish request.
  sleep(0.5);
}