k6-docs

Grafana k6 ドキュメントへのアクセス

概要

このスキルを使用すると、負荷テストスクリプトの作成とデバッグに役立つ、Grafana k6 の最新の公式ドキュメントにアクセスできます。k6 は、API、マイクロサービス、ウェブサイトのパフォーマンステスト向けに構築された最新の負荷テストツールです。

このスキルを使用する場面

次のような場合にこのスキルを使用してください。

• 新しい k6 負荷テストスクリプトを作成する
• 既存の k6 テストコードをデバッグする
• k6 API メソッドとそのパラメーターを調べる
• k6 テストのライフサイクルフックを理解する
• k6 のメトリクスとしきい値について学ぶ
• k6 のチェックとカスタムメトリクスを実装する
• k6 の拡張機能やモジュールを使用する
• k6 テストの実行に関する問題をトラブルシューティングする

主な機能

1. ドキュメントへのアクセス

WebFetch ツールを使用して、k6 の最新ドキュメントにアクセスします。

主なドキュメント URL：

• メインドキュメント：https://grafana.com/docs/k6/latest/
• JavaScript API：https://grafana.com/docs/k6/latest/javascript-api/
• 例：https://grafana.com/docs/k6/latest/examples/
• k6 の使用：https://grafana.com/docs/k6/latest/using-k6/

よく使う API リファレンスの URL：

• HTTP リクエスト：https://grafana.com/docs/k6/latest/javascript-api/k6-http/
• チェック：https://grafana.com/docs/k6/latest/javascript-api/k6/check/
• メトリクス：https://grafana.com/docs/k6/latest/javascript-api/k6-metrics/
• しきい値：https://grafana.com/docs/k6/latest/using-k6/thresholds/
• オプション：https://grafana.com/docs/k6/latest/using-k6/k6-options/
• 実行コンテキスト：https://grafana.com/docs/k6/latest/using-k6/test-lifecycle/

使用パターン：

Use WebFetch with the appropriate documentation URL and a focused prompt like:
- "Show me the API reference for http.post method"
- "Explain how to use checks in k6"
- "Show examples of custom metrics"

2. k6 の一般的なパターン

基本的な HTTP GET テスト：

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

export const options = {
  vus: 10,
  duration: '30s',
};

export default function () {
  const res = http.get('https://test.k6.io');
  check(res, {
    'status is 200': (r) => r.status === 200,
  });
  sleep(1);
}

JSON を使用した HTTP POST：

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

export default function () {
  const url = 'https://httpbin.test.k6.io/post';
  const payload = JSON.stringify({
    name: 'test',
  });
  const params = {
    headers: {
      'Content-Type': 'application/json',
    },
  };

  const res = http.post(url, payload, params);
  check(res, {
    'status is 200': (r) => r.status === 200,
  });
}

しきい値を設定した段階的な負荷の増加、維持、低下：

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

export const options = {
  stages: [
    { duration: '1m', target: 100 }, // ramp up to 100 VUs
    { duration: '3m', target: 100 }, // steady at 100 VUs
    { duration: '1m', target: 0 },   // ramp down to 0
  ],
  thresholds: {
    http_req_duration: ['p(95)<500'], // p95 latency < 500ms
    http_req_failed: ['rate<0.01'],   // error rate < 1%
    checks: ['rate>0.99'],            // 99%+ checks pass
  },
};

export default function () {
  const res = http.get(`${__ENV.BASE_URL || 'https://test.k6.io'}/api/users`);
  check(res, { 'status is 200': (r) => r.status === 200 });
  sleep(1);
}

しきい値の構文チートシート（最もよく使われるメトリクス）：

• http_req_duration: ['p(95)<500'] — 95 パーセンタイルが 500ms 未満
• http_req_failed: ['rate<0.01'] — 失敗率が 1% 未満
• checks: ['rate>0.99'] — check() 呼び出しの少なくとも 99% が成功
• iteration_duration: ['avg<1000'] — イテレーションの平均時間が 1 秒未満

check() の失敗は http_req_failed を増加させません。このメトリクスが追跡するのは HTTP レベルの失敗（ネットワークエラー、5xx）のみです。アサーションの成功率を保証するには、checks のしきい値を使用してください。

3. ドキュメントの検索方法

特定の k6 機能を検索するときは、次の手順に従ってください。

1. 広く検索する：WebSearch を使用して関連するドキュメントページを見つけます

   • 例：「k6 load testing custom metrics documentation」

2. 次に絞り込む：最も関連性の高いドキュメント URL に WebFetch を使用します

   • 例：WebFetch https://grafana.com/docs/k6/latest/javascript-api/k6-metrics/

3. API メソッドの場合：JavaScript API セクションに移動します

   • ベース URL：https://grafana.com/docs/k6/latest/javascript-api/
   • モジュール固有の URL：https://grafana.com/docs/k6/latest/javascript-api/k6-http/

4. ハウツーガイドの場合：「Using k6」セクションを確認します

   • ベース URL：https://grafana.com/docs/k6/latest/using-k6/

4. k6 の主な概念

テストのライフサイクル：

• init コンテキスト：読み込み時のコード（インポート、オプション）
• setup()：テストの前に 1 回実行
• default function()：VU のコード。繰り返し実行
• teardown()：テストの後に 1 回実行

負荷オプション：

• vus：仮想ユーザーの数
• duration：テストの実行時間
• iterations：すべての VU におけるイテレーションの合計数
• stages：段階的な負荷パターン
• thresholds：合否の基準

HTTP メソッド：

• http.get()、http.post()、http.put()、http.delete()
• 並列リクエストには http.batch()

チェックとしきい値の違い：

• check()：条件を検証しますが、テストは停止しません
• thresholds：合否の基準を定義します。テストを中断できます

ワークフロー

1. 必要な機能を特定する：必要な k6 機能を判断します
2. ドキュメントを検索する：WebSearch を使用するか、既知のドキュメント URL に直接アクセスします
3. 該当するページを取得する：WebFetch を使用して詳細情報を取得します
4. コードを実装する：ドキュメントに基づいて k6 のテストコードを作成します
5. 検証する：ドキュメントの例やベストプラクティスと照らし合わせて確認します

ベストプラクティス

• 最新のドキュメントの URL 構造（grafana.com/docs/k6/latest/）を必ず確認してください
• 複雑なシナリオでは、「Examples」セクションで例を探してください
• トラブルシューティングでは、API リファレンスと「Using k6」ガイドの両方を確認してください
• どのドキュメントページを取得すべきかわからない場合は、まず WebSearch を使用してください
• 複雑な機能を実装する場合は、複数のドキュメントページを参照してください

よくあるドキュメントのセクション

トピック	URL パターン
メインドキュメント	https://grafana.com/docs/k6/latest/
JavaScript API	https://grafana.com/docs/k6/latest/javascript-api/{module}/
HTTP モジュール	https://grafana.com/docs/k6/latest/javascript-api/k6-http/
例	https://grafana.com/docs/k6/latest/examples/
テストのライフサイクル	https://grafana.com/docs/k6/latest/using-k6/test-lifecycle/
閾値	https://grafana.com/docs/k6/latest/using-k6/thresholds/
オプション	https://grafana.com/docs/k6/latest/using-k6/k6-options/
メトリクス	https://grafana.com/docs/k6/latest/using-k6/metrics/
チェック	https://grafana.com/docs/k6/latest/javascript-api/k6/check/

注意事項

• このスキルには k6 ドキュメントがローカルに含まれていないため、最新バージョンをオンラインで取得します
• 取得したドキュメントが最新であることを確認するため、URL に /latest/ が含まれていることを必ず確認してください
• 特定のバージョンのドキュメントを参照する場合は、/latest/ を特定のバージョン番号に置き換えてください
• k6 ドキュメントは包括的でよく整理されています。目次を使ってナビゲートしてください