Skip to content

Commit

Permalink
Fix stale documentation for Analyzer Configurations. (#1503)
Browse files Browse the repository at this point in the history
  • Loading branch information
@efeg
efeg authored and Adem Efe Gencer committed Mar 25, 2021
1 parent ff5b318 commit 163e22b
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
2 changes: 1 addition & 1 deletion ...ntrol/src/main/java/com/linkedin/kafka/cruisecontrol/config/constants/AnalyzerConfig.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,7 @@ private AnalyzerConfig() {
.add(IntraBrokerDiskUsageDistributionGoal.class.getName()).toString();
public static final String INTRA_BROKER_GOALS_DOC = "A list of case insensitive intra-broker goals in the order of priority. "
+ "The high priority goals will be executed first. The intra-broker goals are only relevant if intra-broker operation is "
+ "supported(i.e. in Cruise Control versions above 2.*), otherwise this list should be empty.";
+ "supported (i.e. in Cruise Control versions above 2.*), otherwise this list should be empty.";

/**
* <code>hard.goals</code>
Expand Down
4 changes: 3 additions & 1 deletion docs/wiki/User Guide/Configurations.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,6 @@ The following configurations are inherited from the open source Kafka client con
| disk.low.utilization.threshold | Double | N | 0.0 | The threshold to define the utilization of disk is low enough that rebalance is not worthwhile. The cluster will only be in a low utilization state when all the brokers are below the low utilization threshold. Such a cluster is overprovisioned in terms of its disk utilization. The threshold is in percentage. |
| network.inbound.low.utilization.threshold | Double | N | 0.0 | The threshold to define the utilization of network inbound rate is low enough that rebalance is not worthwhile. The cluster will only be in a low utilization state when all the brokers are below the low utilization threshold. Such a cluster is overprovisioned in terms of its network inbound rate. The threshold is in percentage. |
| network.outbound.low.utilization.threshold | Double | N | 0.0 | The threshold to define the utilization of network outbound rate is low enough that rebalance is not worthwhile. The cluster will only be in a low utilization state when all the brokers are below the low utilization threshold. Such a cluster is overprovisioned in terms of its network outbound rate. The threshold is in percentage. |
| max.proposal.candidates | Integer | N | 10 | Kafka cruise control precomputes the optimization proposal candidates continuously in the background. This config sets the maximum number of candidate proposals to precompute for each cluster workload model. The more proposal candidates are generated, the more likely a better optimization proposal will be found, but more CPU will be used as well. |
| proposal.expiration.ms | Integer | N | 900,000 | Kafka cruise control will cache one of the best proposal among all the optimization proposal candidates it recently computed. This configuration defines when will the cached proposal be invalidated and needs a recomputation. If proposal.expiration.ms is set to 0, cruise control will continuously compute the proposal candidates. |
| max.replicas.per.broker | Integer | N | 10,000 | The maximum number of replicas allowed to reside on a broker. The analyzer will enforce a hard goal that the number of replica on a broker cannot be higher than this config. |
| num.proposal.precompute.threads | Integer | N | 1 | The number of thread used to precompute the optimization proposal candidates. The more threads are used, the more memory and CPU resource will be used. |
Expand All @@ -121,6 +120,9 @@ The following configurations are inherited from the open source Kafka client con
| overprovisioned.min.extra.racks | Integer | N | 2 | The minimum number of extra racks to consider a cluster as overprovisioned such that the cluster has at least the configured number of extra alive racks in addition to the number of racks needed to place replica of each partition to a separate rack -- e.g. a cluster with 7 racks is overprovisioned in terms of its number of racks if the maximum replication factor is 4 and this config is 3. |
| overprovisioned.min.brokers | Integer | N | 3 | The minimum number of alive brokers for the cluster to be eligible in overprovisioned consideration -- i.e. the cluster has at least the configured number of alive brokers |
| overprovisioned.max.replicas.per.broker | Long | N | 1500 | The maximum number of replicas that should reside on each broker to consider a cluster as overprovisioned after balancing its replica distribution. |
| optimization.options.generator.class | Class | N | com.linkedin.kafka.cruisecontrol.analyzer.DefaultOptimizationOptionsGenerator | The class implementing OptimizationOptionsGenerator interface and is used to generate optimization options for proposal calculations. |
| intra.broker.goals | List | N | com.linkedin.kafka.cruisecontrol.analyzer.goals.IntraBrokerDiskCapacityGoal,com.linkedin.kafka.cruisecontrol.analyzer.goals.IntraBrokerDiskUsageDistributionGoal | A list of case insensitive intra-broker goals in the order of priority. The high priority goals will be executed first. The intra-broker goals are only relevant if intra-broker operation is supported (i.e. in Cruise Control versions above 2.*), otherwise this list should be empty. |
| allow.capacity.estimation.on.proposal.precompute | Boolean | N | true | The flag to indicate whether to allow capacity estimation on proposal precomputation. |

### Executor Configurations
| Name | Type | Required? | Default Value | Descriptions |
Expand Down

0 comments on commit 163e22b

Please sign in to comment.