第 35 章 为您的 API 设置和评估 3scale API 管理响应代码日志
要查看您的客户端如何使用 API,并实时查看您的服务器是否按预期运行,请设置并使用 3scale 中的响应代码日志。
流程
您已部署了 APIcast 网关:
-
在 Docker 容器化环境 中。将
APICAST_RESPONSE_CODES
环境变量设置为1
或true
。 -
使用 自我管理的操作器。在 APIcast CR 中,将
responseCodesIncluded
设置为true
。例如:
apiVersion: apps.3scale.net/v1alpha1 kind: APIcast metadata: name: example-apicast spec: ... responseCodesIncluded: true
示例
启用后,APIcast 网关会捕获上游服务为授权调用返回的 API 响应的 HTTP 状态代码,并将它们发送到服务管理 API(在 authrep
调用中)。例如:
https://su1.3scale.net/transactions/authrep.xml?service_token={SERVICE_TOKEN}&service_id={SERVICE_ID}&user_key={USER_KEY}&usage%5Bhits%5D=1&log%5Bcode%5D=200"
在本例中,发送log[code]=200
,这意味着 API 用 200
状态代码响应。
验证
要验证集成,使用有效的 3scale 凭证对 API 产品执行调用,然后验证在 Analytics > Usage 页面中是否正确报告了调用。
注意
- 响应代码跟踪不是所有响应的准确计数。
- 此视图的值是在一段时间内提供趋势的可视化表示。
-
响应代码跟踪和 3scale Auth 缓存模式:
None
不是受支持的组合。
如果一切进展顺利,请访问 Analytics >Response codes 页面。您应该可以看到一个图形,其中含有用颜色划分的最新流量,具体取决于响应是 2xx、4xx 或 5xx。
图形工具可让您查看响应代码历史记录。您还可以检查响应代码统计信息的不同时段和不同粒度级别。单击时间选择栏,再定义符合您需求的时间周期和粒度。