Agent快速入门

云眼About 2 min

Agent快速入门

提供有关步骤,说明如何使用 Node 快速开始使用 云眼 Agent,并探索 Agent 的 REST API。

通过节点在本地运行

观看此 4 分钟视频open in new window,了解如何使用示例微服务实施 云眼 Agent,或按照此处的说明在首选操作系统上安装Agent。

评估Agent REST API

📘 注意

Agent REST API 是通过 OpenAPI (Swagger) 定义的,可以在 localhostopen in new window 或我们的开发人员文档中open in new window找到。为简洁起见,以下示例使用 Python 代码,但可以针对任何编程语言进行扩展。

启动 HTTP 会话

向 云眼 Agent 发出的每个请求都在 云眼 SDK 密钥的上下文中。SDK 密钥将 API 请求映射到特定的云眼灰度实验项目和环境。我们可以使用该对象设置全局请求标头。requests.Session

Python

import requests s = requests.Session() s.headers.update({'X-云眼-SDK-Key': 'YOUR-SDK-KEY'})

要进行身份验证,请将开发工具包密钥作为 API 调用中命名的标头传递给云眼Agent。可以在 app.eyeofcloud.comopen in new window 的**“设置**>环境”>“SDK 密钥”下找到 SDK 密钥。请记住,每个环境都有不同的 SDK 密钥。X-云眼-SDK-Key

🚧 重要

️必须启动 HTTP 会话。将来的示例将假定此会话正在维护中。

获取当前环境配置

/configopen in new window 终结点返回当前工作环境的清单。

Python

resp = s.get('http://localhost:8080/v1/config') env = resp.json() for key in env['featuresMap']: print(key)

运行灰度标帜规则

/decide?keys={keys} 终结点决定是否为给定用户启用一个或多个灰度标帜。可以使用以下语法决定多个标帜:。我们将通过请求正文提供。API 评估以确定用户分桶进入的标帜规则和标帜变体。/v1/decide?keys=flagA&keys=flagB``userId``userId

规则类型包括:

此终结点返回一个数组云眼Decision 对象 ,其中包含有关用户被分桶到的标帜和规则的信息。

Python

params = { "keys": "my-feature-flag" } payload = { "userId": "test-user", "userAttributes": { "attr1": "sample-attribute-1", "attr2": "sample-attribute-2" } } resp = s.post(url = 'http://localhost:8080/v1/decide', params=params, json=payload) print(resp.json())

决策 API 是一个 POST,用于向调用方发出有副作用的信号。也就是说,此端点会导致发送到 云眼 分析的“决策”事件,以便分析 A/B 测试结果。默认情况下,如果灰度标帜只是交付的一部分,则不会发送“决定”。

Last update:
Contributors: “zhangweixue”