用途:通过 b2c metrics 命令查询 SCAPI Metrics API(observability/metrics/v1)的可观测性指标,用于监控和分析 Commerce Cloud 技术性能,包括请求量、延迟分布、错误率、缓存等时间序列数据。该 API 处于封闭测试阶段,需为组织启用,行为、输出和 OAuth 范围可能变更。
主要能力:命令结构包含 list(列出可用指标类别)、overall(系统级聚合)、sales(销售交易)、ecdn(边缘 CDN)、third-party(第三方集成,支持 --third-party-service-id)、scapi(SCAPI 请求量/延迟/错误/缓存,支持 --api-family、--api-name)、scapi-hooks、mrt(Managed Runtime/PWA Kit)、controller(SFRA 控制器)、ocapi(支持 --ocapi-category、--ocapi-api)。通用标志有 --from/--to/--window 时间窗口和 --tags/--no-tags。
使用方式:若未全局安装 b2c,使用 npx @salesforce/b2c-cli。先运行 b2c metrics list 查看类别,再用类别命令获取指标,例如 b2c metrics overall --window 1h、b2c metrics scapi --api-family products --api-name shopper-products、b2c metrics ocapi --ocapi-category shop --ocapi-api baskets。时间窗口支持相对时长(1h/7d)或 ISO 8601,最多指定 --from/--to/--window 中的两个,默认 24 小时窗口。配置值(tenantId、shortCode、clientId、clientSecret)从 dw.json、SFCC_* 环境变量、活动实例或配置插件解析,可用 b2c setup inspect 查看。
适用场景:监控 Commerce Cloud 各层性能、按 API 家族或 OCAPI 类别过滤分析、排查错误率与延迟问题、通过 --json 输出供脚本处理,或使用 SDK(@salesforce/b2c-tooling-sdk)编程调用。
限制:Metrics API 为封闭测试,需组织启用;仅支持 OAuth 客户端凭据,不支持 --user-auth;API 客户端需具备带租户过滤的 Salesforce Commerce API 角色,OAuth 范围 sfcc.metrics 由 CLI 自动请求;数据保留 30 天;类别专属过滤器只能用于对应命令;标签解析为客户端尽力而为,realm/environment 和应用过滤器可靠,字符串解析维度为启发式。