用途:通过 Scout APM 的 REST API 只读查询应用性能监控数据,适合排查慢端点、响应时间回归、错误分组与追踪,以及查看 N+1 查询、内存膨胀、慢查询等洞察。不用于配置 Scout agent 或代码埋点。
主要能力:列出应用与详情;查询可用指标类型及时间序列(apdex、response_time、response_time_95th、errors、throughput、queue_time);列出端点及其统计、单端点指标;获取端点追踪列表与追踪详情(含 spans);查看错误分组、分组详情(含最新堆栈)与组内单条错误;获取全部或按类型的洞察,以及游标分页的洞察历史。
使用方式:先登录 Scout APM,在组织设置中创建命名 API token,并导出环境变量:export SCOUT_API_KEY="your-token-here"。基础地址为 https://scoutapm.com/api/v0。每个请求需带认证,可用请求头 X-SCOUT-API: $SCOUT_API_KEY,或查询参数 ?key=$SCOUT_API_KEY。示例:curl -sS -H "X-SCOUT-API: $SCOUT_API_KEY" "https://scoutapm.com/api/v0/apps"。端点路径中的 {endpoint} 需 Base64 URL 编码,例如 echo -n "UsersController#index" | base64。
限制:多数接口必须提供 ISO 8601 的 from/to,否则返回 422;追踪接口限 7 天窗口、最多 100 条;错误分组限 30 天、最多 100 条;当前洞察缓存 5 分钟,不宜更频繁轮询;追踪与错误列表无内置分页;时间序列步长由窗口时长决定,不可自行控制。响应统一为 header 与 results 信封,错误码包括 403、404、422。