alicloud-observability-pts

Category: サービス

Alibaba Cloud Performance Testing Service (PTS)

目的

Alibaba Cloud PTS OpenAPI を使用して、以下を実現します。

• テストシーンの一覧取得と確認
• 負荷テストの計画とライフサイクルの自動化
• 検証とトラブルシューティングのためのレポートとメトリクスの取得

前提条件

• 最小権限の Alibaba Cloud 認証情報を設定します。
• Python SDK をインストールします（仮想環境の使用を推奨します）。

python3 -m venv .venv
. .venv/bin/activate
python -m pip install -U alibabacloud_pts20201020 alibabacloud_tea_openapi

• 環境変数の使用を推奨します。
  • ALICLOUD_ACCESS_KEY_ID
  • ALICLOUD_ACCESS_KEY_SECRET
  • 任意の ALICLOUD_REGION_ID
• 変更を伴う操作の前に、読み取り専用の API 探索と現在の状態の確認を実行します。

AccessKey の優先順位

1. 環境変数：ALICLOUD_ACCESS_KEY_ID / ALICLOUD_ACCESS_KEY_SECRET / ALICLOUD_REGION_ID
2. 共有認証情報ファイル：~/.alibabacloud/credentials

リージョンや環境が不明な場合は、変更を伴う操作の前にユーザーに確認してください。

ワークフロー

1. 対象のリージョン、テストシーン識別子、操作範囲を特定します。
2. API 探索を実行し、API 名と必須パラメーターを確認します。
3. まず読み取り専用 API（List* / Get* / Describe*）を実行します。
4. ロールバックと変更時間帯を確認してから、変更を伴う操作を実行します。
5. 出力と証跡を output/alicloud-observability-pts/ に保存します。

API 探索

• プロダクトコード：PTS
• デフォルトの API バージョン：2020-10-20
• メタデータソース：https://api.aliyun.com/meta/v1/products/PTS/versions/2020-10-20/api-docs.json

最小限の実行可能なクイックスタート

python skills/observability/pts/alicloud-observability-pts/scripts/list_openapi_meta_apis.py

任意の引数：

python skills/observability/pts/alicloud-observability-pts/scripts/list_openapi_meta_apis.py \
  --product-code PTS \
  --version 2020-10-20 \
  --output-dir output/alicloud-observability-pts

シーンの一覧表示（読み取り専用）：

python skills/observability/pts/alicloud-observability-pts/scripts/list_pts_scenes.py \
  --region cn-hangzhou \
  --page-number 1 \
  --page-size 10 \
  --output output/alicloud-observability-pts/scenes.txt

シーンを 1 つ開始（変更を伴う操作）：

python skills/observability/pts/alicloud-observability-pts/scripts/start_pts_scene.py \
  --region cn-hangzhou \
  --scene-id <scene-id> \
  --wait \
  --output output/alicloud-observability-pts/start-result.json

シーンを 1 つ停止（変更を伴う操作）：

python skills/observability/pts/alicloud-observability-pts/scripts/stop_pts_scene.py \
  --region cn-hangzhou \
  --scene-id <scene-id> \
  --wait \
  --output output/alicloud-observability-pts/stop-result.json

一般的な操作一覧

• シーンの一覧：ListPtsScene、GetPtsScene、ListOpenJMeterScenes、GetOpenJMeterScene
• シーンのライフサイクル：CreatePtsScene、SavePtsScene、ModifyPtsScene、DeletePtsScene、DeletePtsScenes
• テスト実行の制御：StartPtsScene、StopPtsScene、StartTestingJMeterScene、StopTestingJMeterScene
• デバッグの制御：StartDebugPtsScene、StopDebugPtsScene、StartDebuggingJMeterScene、StopDebuggingJMeterScene
• レポート／メトリクス：ListPtsReports、GetPtsReportDetails、GetPtsSceneRunningData、GetPtsSceneRunningStatus

API のグループ別一覧は references/api_quick_map.md を参照してください。

スクリプト一覧

• scripts/list_openapi_meta_apis.py：メタデータを取得し、API 一覧ファイルを生成します。
• scripts/list_pts_scenes.py：ページネーションを使用して PTS シーンを一覧表示します。
• scripts/start_pts_scene.py：シーンを開始し、必要に応じて実行状態をポーリングします。
• scripts/stop_pts_scene.py：シーンを停止し、必要に応じて実行状態でなくなるまでポーリングします。

出力ポリシー

生成ファイルと実行証跡を以下に書き込みます。 output/alicloud-observability-pts/

検証

mkdir -p output/alicloud-observability-pts
for f in skills/observability/pts/alicloud-observability-pts/scripts/*.py; do
  python3 -m py_compile "$f"
done
echo "py_compile_ok" > output/alicloud-observability-pts/validate.txt

合格基準：コマンドが 0 で終了し、output/alicloud-observability-pts/validate.txt が生成されること。

出力と証跡

• 成果物、コマンド出力、API レスポンスの概要を output/alicloud-observability-pts/ 以下に保存します。
• 再現性を確保するため、主要なパラメーター（リージョン／リソース ID／時間範囲）を証跡ファイルに含めます。

参考資料

• ソース一覧：references/sources.md
• API クイックマップ：references/api_quick_map.md
• リクエスト／レスポンスのテンプレート：references/templates.md