Configuration Options for the rebalancer tool

The following configuration options are specific to the rebalancer tool. For any configuration options related to metrics reporting, please see the Confluent Metrics Reporter configuration section.

The config file path is passed via the --config-file option and the following configs are supported. There are no required configs to try the tool although confluent.rebalancer.license is required after 30 days.

confluent.license or confluent.rebalancer.license

Confluent will issue a license key to each subscriber. The license key will be a short snippet of text that you can copy and paste. Without the license key, you can use the Confluent Rebalancer for a 30-day trial period. If you are a subscriber and don’t have a license key, please contact Confluent Support at support@confluent.io.

  • Type: string
  • Valid Values: Confluent Platform license
  • Importance: high
confluent.rebalancer.metrics.collection.timeout.ms

The maximum amount of time the rebalancer will collect metrics for. If the collection does not succeed before the timeout elapses, the rebalance command will fail.

  • Type: int
  • Default: 60000
  • Importance: low
confluent.rebalancer.metrics.topic

The topic where the metrics reporter publishes its metrics to

  • Type: string
  • Default: “_confluent-metrics”
  • Importance: low
confluent.rebalancer.min.free.volume.space.percentage

The log.dir volume will have at least the specified percentage of free space during and after the rebalance. For example, if the total volume space is 100 GB and this config is defined as 20, the rebalancer will use up to 80 GB during the rebalance. This is only supported in Confluent 3.2 (for both rebalancer and brokers) and if every broker in the cluster has a single log.dir. This is enabled by default if supported and disabled otherwise.

  • Type: double
  • Default: 20.0
  • Valid Values: [0,...,100]
  • Importance: low

The consumer used to retrieve metrics data can be configured by prefixing the consumer config name with confluent.rebalancer.metrics.. For example, to configure the consumer to use SSL, one would set confluent.rebalancer.metrics.security.protocol=SSL.