Cloudprober Starlark 脚本探针编写多步骤 API 流程检查的实用教程【免费下载链接】cloudproberAn active monitoring software to detect failures before your customers do.项目地址: https://gitcode.com/gh_mirrors/clo/cloudproberCloudprober 是一款开源的主动监控软件其核心目标是在客户发现问题之前先发现故障。而Cloudprober Starlark 脚本探针Script Probe配置类型STARLARK让你用一段简洁的脚本完成多步骤 API 流程检查——从获取 Token、调用接口、校验响应到输出自定义指标一气呵成。本文将以一个真实的交易 API 链路为例带你从零掌握用 Starlark 编写多步骤接口检查的完整方法。Cloudprober 连接多种输入检查网站、内部服务、合作伙伴连接输出仪表板、SLOs 与告警为什么需要 Starlark 脚本探针普通的 HTTP 探针只能一次请求、一次判断无法表达真实业务中的依赖关系。真实场景往往是这样的链路先登录换取 Token携带 Token 拉取资源列表再根据列表中的 ID 请求详情页最后校验关键字段并记录耗时指标。这类多步骤 API 流程检查正是 Starlark 脚本探针的主场。官方文档把它形象地概括为curl jq 断言还带一门真正的脚本语言详见 docs/official.md 与 Script Probe 官方文档。适用场景速查表需求推荐探针只检查单个 URL 是否可达HTTP 探针运行任意语言的独立二进制External 探针用真实浏览器模拟用户操作Browser 探针串联多个请求、断言响应、输出自定义指标Starlark 脚本探针Starlark 是什么为什么安全Starlark 是 Bazel 项目使用的、类 Python 的沙箱语言支持if/for、字典、列表和字符串格式化体验接近 Python但没有文件系统访问、没有exec、没有模块系统语义确定、执行可控。因此你的探针脚本可以直接内嵌在配置文件里随配置一起分发无需单独编译和部署二进制——这正是它比 External 探针轻量的原因。最快上手一个最小的 Starlark 探针配置先看最小的配置形态完整示例见 examples/starlark/cloudprober.cfgprobe { name: trading_api_flow type: STARLARK targets { host_names: 127.0.0.1:8080 } interval_msec: 5000 timeout_msec: 3000 starlark_probe { source_file: trading_api.star } }Cloudprober 会每隔 5 秒对每个目标调用一次脚本入口函数probe(target)。脚本整体执行耗时即为探针延迟正常返回即成功任何未捕获的异常包括断言失败都会让本次探测失败——total、success、latency指标会自动流向你配置的 surfacer。编写第一个多步骤 API 流程检查脚本项目内置了一份完整的交易 API 示例脚本 examples/starlark/trading_api.star完整演示登录 → 列表 → 详情 → 校验四步链路def probe(target): base http://%s:%d % (target.name, target.port) # 第 1 步登录获取 Token r http.post( url base /api-token-auth/, json {username: demo, password: demo}, ) assert.http_status(r, 200) token r.json()[token] auth {Authorization: Token token} # 第 2 步拉取账户列表 r http.get(url base /accounts/, headers auth) assert.http_status(r, 200) accounts r.json()[results] if len(accounts) 0: fail(no accounts returned) account_number accounts[0][account_number] # 第 3 步查询第一个账户的投资组合 r http.get(url base /portfolios/%s/ % account_number, headers auth) assert.http_status(r, 200) equity r.json()[equity] print(equity for %s: %s % (account_number, equity)) # 第 4 步查询股票行情并校验返回内容 r http.get(url base /quotes/?symbolsXYZ, headers auth) assert.http_status(r, 200) quote r.json()[results][0] if quote[symbol] ! XYZ: fail(expected XYZ, got %s % quote[symbol])几个关键要点assert.http_status(r, 200)状态码不符立即抛错本次探测记为失败无需额外管道r.json()自动解析 JSON 响应体解析失败会抛异常fail(msg)业务逻辑校验不通过时主动终止链路中任何一步失败后续步骤不再执行探针立即失败——这正是多步骤 API 流程检查的核心价值。想在本机快速体验项目自带的模拟服务 examples/starlark/mock_server.go 实现了上述完整 APIgo run examples/starlark/mock_server.go后启动 Cloudprober 即可看到指标输出。探针内置函数速查所有脚本都获得一组固定内置函数实现见 probes/starlark/builtins.go沙箱保证它们不会访问文件系统或执行任意代码内置函数作用http.get/post/put/patch/deleteHTTP 请求支持headers、json、body、max_redirects、keep_alive、tls参数assert.http_status(resp, code)断言响应状态码不符即失败vars.get(name, default)读取探针配置中的静态变量state.get/set跨轮次持久化的每目标键值存储oauth.token(name)/oauth.header(name)获取配置好的 OAuth Token 或 Authorization 头log.info/warn/error/debug带目标信息输出日志print_metric(line)输出自定义指标同 External 探针协议print(msg)/fail(msg)标准输出 / 主动失败关于target参数入口函数接收的唯一参数暴露目标信息target.name主机名、target.port端口、target.ip解析后的 IP、target.labels目标标签字典。连接复用keep_alive的妙用多步骤链路中每步默认都会重新建立连接走一遍 DNS/TCP/TLS这正是监控想要的效果但如果你希望链路内复用连接池只需在调用时传keep_aliveTrue即可在链路内共享连接。用state记住上次的状态state是每个探针目标独立的持久化字典跨轮次保留。非常适合记录游标、ETag 或限流倒计时比如只拉取上次之后的新事件last_id state.get(last_id, 0) r http.get(url http://%s/events?since%d % (target.name, last_id)) events r.json()[events] if events: state.set(last_id, events[-1][id])用oauth.header()优雅注入鉴权在 examples/starlark/gcp_oauth_jwt.star 中脚本通过oauth.header(gcp)获取 Google API 的 Bearer 凭证。Token 的签发、缓存、刷新全部由 Cloudprober 侧完成脚本只需伸手要即可。注意脚本探针不会自动注入 Token你需要显式地把Authorization头加到需要的请求上避免把凭证泄漏给链路中无需鉴权的公网端点。输出自定义指标print_metric实战多步骤流程检查除了成败往往还关心关键步骤有多慢。用print_metric可以输出任意自定义指标print_metric(items_in_cart 5) print_metric(checkout_latency_ms{flowguest} 234.5)配合探针配置中的output_metrics_options可以声明分布桶distribution buckets、是否在 Cloudprober 内聚合等starlark_probe { source_file: checkout.star output_metrics_options { aggregate_in_cloudprober: true dist_metric { key: checkout_latency_ms value { explicit_buckets: 10,50,100,250,500,1000,5000 } } } }注意指标是随行即发的即使后续断言失败之前已输出的指标行依然有效。如何查看探针运行结果探针运行后你可以在 Cloudprober 的 Web UI 中按时间线查看每次执行的结果失败的运行会以红色标记并附带失败详情在 UI 中按时间查看每次探针执行的成功与失败快速定位链路中断的环节配合 File surfacer指标也会持续写入本地文件如示例中的/tmp/cloudprober-starlark.metrics方便接入 Prometheus 等监控系统做告警。五个新手常踩的坑 ️混淆body与jsonjson会自动编码 JSON 并设置Content-Typebody是原始字符串/字节二者取其一即可忘记显式注入 Token脚本探针不会自动加 Authorization 头漏了会得到 401在模块级积累跨轮次状态模块全局变量在加载后被冻结跨轮次状态请用statetls传空字符串这是错误而非回退到系统默认 TLS脚本会直接失败——设计如此为了让配置错误大声暴露探针超时设置过小多步骤链路总耗时更长timeout_msec要留足余量否则链路会被中途取消。总结Cloudprober Starlark 脚本探针把多步骤 API 流程检查从需要自研二进制降低到写一段脚本配合内置的http、assert、state、oauth、print_metric能力几乎覆盖了接口链路监控的全部需求。建议你从 examples/starlark/ 目录下的示例出发结合 probes/starlark/ 源码理解内置函数行为一步步构建属于你自己的接口健康检查体系。记住 Cloudprober 的使命在客户发现问题之前先发现故障。而 Starlark 脚本探针正是让你把复杂业务链路也纳入主动监控的最短路径。【免费下载链接】cloudproberAn active monitoring software to detect failures before your customers do.项目地址: https://gitcode.com/gh_mirrors/clo/cloudprober创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考 Cloudprober Starlark 脚本探针：编写多步骤 API 流程检查的实用教程
Cloudprober Starlark 脚本探针编写多步骤 API 流程检查的实用教程【免费下载链接】cloudproberAn active monitoring software to detect failures before your customers do.项目地址: https://gitcode.com/gh_mirrors/clo/cloudproberCloudprober 是一款开源的主动监控软件其核心目标是在客户发现问题之前先发现故障。而Cloudprober Starlark 脚本探针Script Probe配置类型STARLARK让你用一段简洁的脚本完成多步骤 API 流程检查——从获取 Token、调用接口、校验响应到输出自定义指标一气呵成。本文将以一个真实的交易 API 链路为例带你从零掌握用 Starlark 编写多步骤接口检查的完整方法。Cloudprober 连接多种输入检查网站、内部服务、合作伙伴连接输出仪表板、SLOs 与告警为什么需要 Starlark 脚本探针普通的 HTTP 探针只能一次请求、一次判断无法表达真实业务中的依赖关系。真实场景往往是这样的链路先登录换取 Token携带 Token 拉取资源列表再根据列表中的 ID 请求详情页最后校验关键字段并记录耗时指标。这类多步骤 API 流程检查正是 Starlark 脚本探针的主场。官方文档把它形象地概括为curl jq 断言还带一门真正的脚本语言详见 docs/official.md 与 Script Probe 官方文档。适用场景速查表需求推荐探针只检查单个 URL 是否可达HTTP 探针运行任意语言的独立二进制External 探针用真实浏览器模拟用户操作Browser 探针串联多个请求、断言响应、输出自定义指标Starlark 脚本探针Starlark 是什么为什么安全Starlark 是 Bazel 项目使用的、类 Python 的沙箱语言支持if/for、字典、列表和字符串格式化体验接近 Python但没有文件系统访问、没有exec、没有模块系统语义确定、执行可控。因此你的探针脚本可以直接内嵌在配置文件里随配置一起分发无需单独编译和部署二进制——这正是它比 External 探针轻量的原因。最快上手一个最小的 Starlark 探针配置先看最小的配置形态完整示例见 examples/starlark/cloudprober.cfgprobe { name: trading_api_flow type: STARLARK targets { host_names: 127.0.0.1:8080 } interval_msec: 5000 timeout_msec: 3000 starlark_probe { source_file: trading_api.star } }Cloudprober 会每隔 5 秒对每个目标调用一次脚本入口函数probe(target)。脚本整体执行耗时即为探针延迟正常返回即成功任何未捕获的异常包括断言失败都会让本次探测失败——total、success、latency指标会自动流向你配置的 surfacer。编写第一个多步骤 API 流程检查脚本项目内置了一份完整的交易 API 示例脚本 examples/starlark/trading_api.star完整演示登录 → 列表 → 详情 → 校验四步链路def probe(target): base http://%s:%d % (target.name, target.port) # 第 1 步登录获取 Token r http.post( url base /api-token-auth/, json {username: demo, password: demo}, ) assert.http_status(r, 200) token r.json()[token] auth {Authorization: Token token} # 第 2 步拉取账户列表 r http.get(url base /accounts/, headers auth) assert.http_status(r, 200) accounts r.json()[results] if len(accounts) 0: fail(no accounts returned) account_number accounts[0][account_number] # 第 3 步查询第一个账户的投资组合 r http.get(url base /portfolios/%s/ % account_number, headers auth) assert.http_status(r, 200) equity r.json()[equity] print(equity for %s: %s % (account_number, equity)) # 第 4 步查询股票行情并校验返回内容 r http.get(url base /quotes/?symbolsXYZ, headers auth) assert.http_status(r, 200) quote r.json()[results][0] if quote[symbol] ! XYZ: fail(expected XYZ, got %s % quote[symbol])几个关键要点assert.http_status(r, 200)状态码不符立即抛错本次探测记为失败无需额外管道r.json()自动解析 JSON 响应体解析失败会抛异常fail(msg)业务逻辑校验不通过时主动终止链路中任何一步失败后续步骤不再执行探针立即失败——这正是多步骤 API 流程检查的核心价值。想在本机快速体验项目自带的模拟服务 examples/starlark/mock_server.go 实现了上述完整 APIgo run examples/starlark/mock_server.go后启动 Cloudprober 即可看到指标输出。探针内置函数速查所有脚本都获得一组固定内置函数实现见 probes/starlark/builtins.go沙箱保证它们不会访问文件系统或执行任意代码内置函数作用http.get/post/put/patch/deleteHTTP 请求支持headers、json、body、max_redirects、keep_alive、tls参数assert.http_status(resp, code)断言响应状态码不符即失败vars.get(name, default)读取探针配置中的静态变量state.get/set跨轮次持久化的每目标键值存储oauth.token(name)/oauth.header(name)获取配置好的 OAuth Token 或 Authorization 头log.info/warn/error/debug带目标信息输出日志print_metric(line)输出自定义指标同 External 探针协议print(msg)/fail(msg)标准输出 / 主动失败关于target参数入口函数接收的唯一参数暴露目标信息target.name主机名、target.port端口、target.ip解析后的 IP、target.labels目标标签字典。连接复用keep_alive的妙用多步骤链路中每步默认都会重新建立连接走一遍 DNS/TCP/TLS这正是监控想要的效果但如果你希望链路内复用连接池只需在调用时传keep_aliveTrue即可在链路内共享连接。用state记住上次的状态state是每个探针目标独立的持久化字典跨轮次保留。非常适合记录游标、ETag 或限流倒计时比如只拉取上次之后的新事件last_id state.get(last_id, 0) r http.get(url http://%s/events?since%d % (target.name, last_id)) events r.json()[events] if events: state.set(last_id, events[-1][id])用oauth.header()优雅注入鉴权在 examples/starlark/gcp_oauth_jwt.star 中脚本通过oauth.header(gcp)获取 Google API 的 Bearer 凭证。Token 的签发、缓存、刷新全部由 Cloudprober 侧完成脚本只需伸手要即可。注意脚本探针不会自动注入 Token你需要显式地把Authorization头加到需要的请求上避免把凭证泄漏给链路中无需鉴权的公网端点。输出自定义指标print_metric实战多步骤流程检查除了成败往往还关心关键步骤有多慢。用print_metric可以输出任意自定义指标print_metric(items_in_cart 5) print_metric(checkout_latency_ms{flowguest} 234.5)配合探针配置中的output_metrics_options可以声明分布桶distribution buckets、是否在 Cloudprober 内聚合等starlark_probe { source_file: checkout.star output_metrics_options { aggregate_in_cloudprober: true dist_metric { key: checkout_latency_ms value { explicit_buckets: 10,50,100,250,500,1000,5000 } } } }注意指标是随行即发的即使后续断言失败之前已输出的指标行依然有效。如何查看探针运行结果探针运行后你可以在 Cloudprober 的 Web UI 中按时间线查看每次执行的结果失败的运行会以红色标记并附带失败详情在 UI 中按时间查看每次探针执行的成功与失败快速定位链路中断的环节配合 File surfacer指标也会持续写入本地文件如示例中的/tmp/cloudprober-starlark.metrics方便接入 Prometheus 等监控系统做告警。五个新手常踩的坑 ️混淆body与jsonjson会自动编码 JSON 并设置Content-Typebody是原始字符串/字节二者取其一即可忘记显式注入 Token脚本探针不会自动加 Authorization 头漏了会得到 401在模块级积累跨轮次状态模块全局变量在加载后被冻结跨轮次状态请用statetls传空字符串这是错误而非回退到系统默认 TLS脚本会直接失败——设计如此为了让配置错误大声暴露探针超时设置过小多步骤链路总耗时更长timeout_msec要留足余量否则链路会被中途取消。总结Cloudprober Starlark 脚本探针把多步骤 API 流程检查从需要自研二进制降低到写一段脚本配合内置的http、assert、state、oauth、print_metric能力几乎覆盖了接口链路监控的全部需求。建议你从 examples/starlark/ 目录下的示例出发结合 probes/starlark/ 源码理解内置函数行为一步步构建属于你自己的接口健康检查体系。记住 Cloudprober 的使命在客户发现问题之前先发现故障。而 Starlark 脚本探针正是让你把复杂业务链路也纳入主动监控的最短路径。【免费下载链接】cloudproberAn active monitoring software to detect failures before your customers do.项目地址: https://gitcode.com/gh_mirrors/clo/cloudprober创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考