关于 alicloud-observability-pts
通过 Alibaba Cloud PTS OpenAPI 管理性能测试场景的技能,支持场景检查、压测生命周期操作,以及报告和指标查询。适用于需要自动化压测并验证或排查结果的场景。
主要功能
- 01测试场景清单与检查
- 02压测场景生命周期管理
- 03场景启动与停止
- 04报告和指标查询
- 05OpenAPI 元数据发现
适用场景
- 01盘点并检查测试场景
- 02启动或停止压测场景
- 03获取运行状态与指标
- 04查询压测报告以排查问题
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ cinience/ alicloud-skills --skill alicloud-observability-pts安装后在 Claude Code 中输入/alicloud-observability-pts确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
agents/openai.yamlreferences/api_quick_map.mdsources.mdtemplates.mdscripts/_pts_client.pylist_openapi_meta_apis.pylist_pts_scenes.pystart_pts_scene.pystop_pts_scene.py详细介绍
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_IDALICLOUD_ACCESS_KEY_SECRET- 可选:
ALICLOUD_REGION_ID
- 执行变更操作前,先进行只读 API 探索并检查当前状态。
AccessKey 优先级
- 环境变量:
ALICLOUD_ACCESS_KEY_ID/ALICLOUD_ACCESS_KEY_SECRET/ALICLOUD_REGION_ID - 共享凭证文件:
~/.alibabacloud/credentials
如果区域或环境不明确,请在执行变更操作前与用户确认。
工作流
- 确定目标区域、测试场景标识符和操作范围。
- 进行 API 探索,确认 API 名称和必需参数。
- 首先执行只读 API(
List*/Get*/Describe*)。 - 仅在确认回滚方案和变更窗口后,执行变更操作。
- 将输出和证据保存到
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
启动一个场景(变更操作):
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
停止一个场景(变更操作):
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
评论
支持 Markdown