k6を使ったAPI負荷試験入門｜スクリプト構成から結果の見方まで

loadtest/
└── services/
    └── api/                 # 対象 API ごとの試験
        ├── smoke.js         # 対象APIを1回ずつ呼び出して疎通確認
        ├── scenario.js      # 負荷試験本体
        └── lib/
            ├── config.js    # 環境変数・試験条件
            ├── endpoints.js # 叩く API の一覧
            └── request.js   # 実際の HTTP リクエスト

// scenario.js
import { VUS, DURATION } from './lib/config.js';
import { buildEndpoints } from './lib/endpoints.js';
import { callEndpoint } from './lib/request.js';

const endpoints = buildEndpoints(); // 各VUの初期化時にAPI一覧を取得

export const options = {
  scenarios: {
    api_load: {
      executor: 'constant-vus', // 一定数の VU を維持する
      vus: VUS,                 // 同時仮想ユーザー数
      duration: DURATION,       // 試験時間
    },
  },
  thresholds: {
    http_req_failed: ['rate==0'], // エラー率 0%
    checks: ['rate==1'],          // チェック合格率 100%
  },
};

export default function () {
  const endpoint = endpoints[Math.floor(Math.random() * endpoints.length)];
  callEndpoint(endpoint);
}

export const options = {
  scenarios: {
    api_load: {
      executor: 'constant-vus', // 一定数の VU を維持する
      vus: VUS,                 // 同時仮想ユーザー数
      duration: DURATION,       // 試験時間
    },
  },
  thresholds: {
    http_req_failed: ['rate==0'], // エラー率 0%
    checks: ['rate==1'],          // チェック合格率 100%
  },
};

export default function () {
  const endpoint = endpoints[Math.floor(Math.random() * endpoints.length)];
  callEndpoint(endpoint);
}

// lib/config.js

// 対象APIのURL
export const BASE_URL = __ENV.BASE_URL || 'https://your-api.example';

// GET または POST（デフォルトは GET）
export const METHOD = (__ENV.METHOD || 'GET').toUpperCase();

// 同時ユーザー数
export const VUS = __ENV.VUS ? Number(__ENV.VUS) : 1;

// 試験時間
export const DURATION = __ENV.DURATION || '10s';

// リクエストヘッダー
export const HEADERS = {
  Accept: 'application/json',
};

# GET（METHODは省略可）
BASE_URL=https://your-api.example METHOD=GET VUS=600 DURATION=5m k6 run services/api/scenario.js

# POST
BASE_URL=https://your-api.example METHOD=POST VUS=600 DURATION=5m k6 run services/api/scenario.js

// lib/endpoints.js
import { BASE_URL, METHOD } from './config.js';

function buildGetEndpoints() {
  return [
    {
      name: 'list_users',
      baseUrl: BASE_URL,
      path: '/api/users',
      query: 'page=1&limit=20',
    },
    {
      name: 'daily_report',
      baseUrl: BASE_URL,
      path: '/api/reports/daily',
      query: 'date=20250101',
    },
  ];
}

function buildPostEndpoints() {
  return [
    {
      name: 'search',
      baseUrl: BASE_URL,
      path: '/api/search',
      body: JSON.stringify({
        keyword: 'test',
        start_date: '20250101',
        end_date: '20250107',
      }),
    },
  ];
}

export function buildEndpoints() {
  return METHOD === 'POST' ? buildPostEndpoints() : buildGetEndpoints();
}

// lib/request.js
import http from 'k6/http';
import { check } from 'k6';
import { METHOD, HEADERS } from './config.js';

export function callEndpoint(endpoint) {
  const url = `${endpoint.baseUrl}${endpoint.path}`;

  const response =
    METHOD === 'POST'
      ? http.post(url, endpoint.body, {
          headers: { ...HEADERS, 'Content-Type': 'application/json' },
        })
      : http.get(`${url}?${endpoint.query || ''}`, { headers: HEADERS });

  // 2xx かどうかをチェック
  check(response, {
    [`${endpoint.name} status 2xx`]: (r) => r.status >= 200 && r.status < 300,
  });
}

// smoke.js
import { buildEndpoints } from './lib/endpoints.js';
import { callEndpoint } from './lib/request.js';

const endpoints = buildEndpoints();

export const options = {
  vus: 1, // ユーザー1人
  iterations: 1, // 1回だけ実行
};

export default function () {
  for (const endpoint of endpoints) {
    callEndpoint(endpoint);
  }
}

# 1. 疎通確認（1 VU・各エンドポイントを1回ずつ）
BASE_URL=https://your-api.example METHOD=GET k6 run services/api/smoke.js

# 本試験
BASE_URL=https://your-api.example METHOD=GET VUS=600 DURATION=5m k6 run services/api/scenario.js

BASE_URL=http://localhost:8080 METHOD=GET k6 run services/api/scenario.js

█ TOTAL RESULTS

    checks_total.......: 100     9.98/s
    checks_succeeded...: 100.00% 100 out of 100
    checks_failed......: 0.00%   0 out of 100

    ✓ daily_report status 2xx
    ✓ list_users status 2xx

    HTTP
    http_req_duration..............: avg=92.3ms min=41.8ms med=84.7ms max=248.6ms p(90)=132.4ms p(95)=158.7ms
      { expected_response:true }...: avg=92.3ms min=41.8ms med=84.7ms max=248.6ms p(90)=132.4ms p(95)=158.7ms
    http_req_failed................: 0.00%  0 out of 100
    http_reqs......................: 100    9.98/s

    EXECUTION
    iteration_duration.............: avg=100.1ms min=49.2ms med=92.1ms max=255.3ms p(90)=140.2ms p(95)=166.4ms
    iterations.....................: 100     9.98/s
    vus............................: 1       min=1        max=1
    vus_max........................: 1       min=1        max=1

    NETWORK
    data_received..................: 220 kB  22 kB/s
    data_sent......................: 55 kB   5.5 kB/s