SuperAPI AI 工具集

shopify-observability

部署与运维

查看项目

更新于 10-15 23:29

技能介绍

用途:为 Shopify 应用集成提供针对性的可观测性埋点,覆盖通用监控容易遗漏的 Shopify 专有指标,包括 GraphQL 查询成本、速率限制余量、REST 漏桶状态、API 延迟、Webhook 处理与错误分类。

主要能力:定义 Prometheus 计数器、直方图与仪表盘指标;包装 Shopify GraphQL 客户端,自动记录 extensions.cost 中的查询成本、更新速率限制仪表并分类错误(限流、认证、API 错误);解析 REST 响应中的 X-Shopify-Shop-Api-Call-Limit 头(如 "32/40")跟踪漏桶水位,超过 80% 时告警;跟踪 Webhook 的 HMAC 校验结果、处理成败与耗时;基于 pino 的结构化日志,自动脱敏 PII 并附加上下文字段(查询成本、可用点数、操作名);提供低速率限制、高查询成本(P95 > 500)、Webhook 失败率(> 10%)、API 延迟(P95 > 3s)的 Prometheus 告警规则。

必要用法:需准备 Prometheus 或兼容的指标后端、pino 或类似结构化日志器,以及可拦截响应的 Shopify API 客户端。示例指标端点:app.get("/metrics", async (req, res) => { res.set("Content-Type", registry.contentType); res.send(await registry.metrics()); })。

限制与注意事项:缺少成本数据通常因响应前发生查询错误,需检查错误处理包裹;按店铺打标签易造成高基数,建议按套餐层级聚合;阈值过激可能引发告警风暴,应基于基线流量调优;Webhook 指标缺失常因处理器未埋点。具体实现细节与完整配置暂未提供。