13.9. 生成优化建议
当您向 /rebalance
端点发出 POST 请求时,Cruise Control 会根据提供的优化目标生成一个优化建议来重新平衡 Kafka 集群。您可以使用优化提议的结果来重新平衡 Kafka 集群。
您可以使用以下端点之一运行优化建议:
-
/rebalance
-
/add_broker
-
/remove_broker
您使用的端点取决于您是否正在在 Kafka 集群中已在运行的所有代理进行重新平衡 ; 或者要在扩展后或缩减 Kafka 集群前重新平衡。如需更多信息,请参阅使用代理扩展 重新平衡端点。
优化建议作为空运行方式生成,除非提供了 dryrun
参数,并将其设置为 false
。在"dry run mode"中,Cruise Control 会生成优化建议和估算结果,但不通过重新平衡集群来启动提议。
您可以分析优化提议中返回的信息,并决定是否批准它。
使用以下参数向端点发出请求:
dryRun
type: boolean, default: true
告知 Cruise 控制是否只生成优化提议(true
),或生成优化建议并执行集群重新平衡 (false
)。
当 dryrun=true
(默认值)时,您还可以传递 verbose
参数,以返回有关 Kafka 集群状态的更多详细信息。这包括应用优化提议前后每个 Kafka 代理上负载的指标,以及 before 和 after 值之间的区别。
excluded_topics
类型: regex
与优化提议的计算中排除的主题匹配的正则表达式。
目标
type: 字符串列表,默认为配置的 default.goals
列表
用户提供的优化目标列表,用于准备优化方法。如果没有提供目标,则会使用 cruisecontrol.properties
文件中配置的 default.goals
列表。
skip_hard_goals_check
type: boolean, default: false
默认情况下,Cruise Control 会检查用户提供的优化目标(在 goals
参数中)包含所有配置的硬目标(在 hard.goals
中)。如果您提供不是配置的 hard.goals
子集的目标,请求会失败。
如果要生成不使用所有配置的 hard.goals
优化目标,则将 skip_hard_goals_check
设置为 true
。
json
type: boolean, default: false
控制 Cruise Control 服务器返回的响应类型。如果没有提供,或设置为 false
,Cruise Control 会返回格式的文本,以便在命令行上显示。如果要以编程方式提取返回的信息元素,请设置 json=true
。这将返回 JSON 格式的文本,这些文本可以传送到 jq
等工具,或在脚本和程序中解析它们。
详细
type: boolean, default: false
控制 Cruise Control 服务器返回的响应中详情级别。可与 dryrun=true
一起使用。
其他参数可用。如需更多信息,请参阅 Cruise Control Wiki 中的 REST API。
先决条件
- Kafka 正在运行。
- 您已配置了 Cruise Control。
- (可选)您已在 主机上安装了新代理,以包含在重新平衡中。
流程
使用对
/rebalance
、/add_broker
或/remove_broker
端点的 POST 请求来生成优化建议。使用默认目标到
/rebalance
的请求示例curl -v -X POST 'cruise-control-server:9090/kafkacruisecontrol/rebalance'
缓存的优化提议会立即返回。
注意如果返回
NotEnoughValidWindows
,Cruise Control 尚未记录足够的指标数据,以生成优化器。等待几分钟,然后重新发送请求。使用指定目标向
/rebalance
的请求示例curl -v -X POST 'cruise-control-server:9090/kafkacruisecontrol/rebalance?goals=RackAwareGoal,ReplicaCapacityGoal'
如果请求满足提供的目标,则立即返回缓存的优化提议。否则,会使用提供的目标生成新的优化方案;这需要更长的时间来计算。您可以通过在请求中添加
ignore_proposal_cache=true
参数来强制实施此行为。使用指定目标向
/rebalance
的请求示例,而无需硬目标curl -v -X POST 'cruise-control-server:9090/kafkacruisecontrol/rebalance?goals=RackAwareGoal,ReplicaCapacityGoal,ReplicaDistributionGoal&skip_hard_goal_check=true'
包含指定代理的
/add_broker
请求示例curl -v -X POST 'cruise-control-server:9090/kafkacruisecontrol/add_broker?brokerid=3,4'
请求仅包含新代理的 ID。例如,此请求添加 ID 为
3
和4
的代理。在重新平衡时,副本会从现有代理移到新代理中。排除指定代理的
/remove_broker
请求示例curl -v -X POST 'cruise-control-server:9090/kafkacruisecontrol/remove_broker?brokerid=3,4'
请求仅包含被排除的代理 ID。例如,此请求排除 ID 为
3
和4
的代理。在重新平衡时,副本会从要删除的代理移到其他现有代理中。注意如果要删除的代理包含排除主题,则副本仍会移动。
查看响应中包含的优化提议。属性描述待处理的集群重新平衡操作。
提议包含所提出优化的高级概述,以及各个默认优化目标的总结,以及执行过程后的预期集群状态。
请特别注意以下信息:
-
在
重新平衡概述后集群负载
。如果满足您的要求,您应该使用高级别概述来评估所提议更改的影响。 -
n inter-broker replica (y MB) moves
表示在代理间移动的数据量。值越大,重新平衡过程中对 Kafka 集群的潜在性能影响越大。 -
n intra-broker replica (y MB) moves
表示代理本身(生成磁盘)中多少数据。数值越大,对各个代理的潜在性能影响越大(尽管小于n inter-broker replica (y MB) moves
)。 - 领导机移动的数量。这在重新平衡过程中对集群的性能有可忽略的影响。
-
在
异步响应
默认情况下,Cruise Control REST API 端点会在 10 秒后超时,虽然提议生成将继续在服务器上。如果最新缓存的优化器尚未就绪,或者用户提供的优化目标是通过 ignore_proposal_cache=true
指定,则可能会出现超时。
要允许您稍后检索优化过程,请记录请求的唯一标识符,该标识符在 /rebalance
端点的响应标头中提供。
要使用 curl
获取响应,请指定 verbose (-v
)选项:
curl -v -X POST 'cruise-control-server:9090/kafkacruisecontrol/rebalance'
以下是一个标头示例:
* Connected to cruise-control-server (::1) port 9090 (#0)
> POST /kafkacruisecontrol/rebalance HTTP/1.1
> Host: cc-host:9090
> User-Agent: curl/7.70.0
> Accept: /
>
* Mark bundle as not supporting multiuse
< HTTP/1.1 200 OK
< Date: Mon, 01 Jun 2023 15:19:26 GMT
< Set-Cookie: JSESSIONID=node01wk6vjzjj12go13m81o7no5p7h9.node0; Path=/
< Expires: Thu, 01 Jan 1970 00:00:00 GMT
< User-Task-ID: 274b8095-d739-4840-85b9-f4cfaaf5c201
< Content-Type: text/plain;charset=utf-8
< Cruise-Control-Version: 2.0.103.redhat-00002
< Cruise-Control-Commit_Id: 58975c9d5d0a78dd33cd67d4bcb497c9fd42ae7c
< Content-Length: 12368
< Server: Jetty(9.4.26.v20200117-redhat-00001)
如果优化提议在超时时间内没有就绪,您可以重新提交 POST 请求,这一次包括标头中原始请求的 User-Task-ID
:
curl -v -X POST -H 'User-Task-ID: 274b8095-d739-4840-85b9-f4cfaaf5c201' 'cruise-control-server:9090/kafkacruisecontrol/rebalance'
接下来要做什么