| /** |
| * Licensed to the Apache Software Foundation (ASF) under one or more |
| * contributor license agreements. See the NOTICE file distributed with |
| * this work for additional information regarding copyright ownership. |
| * The ASF licenses this file to You under the Apache License, Version 2.0 |
| * (the "License"); you may not use this file except in compliance with |
| * the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| |
| package kafka.admin |
| |
| import joptsimple._ |
| import java.util.Properties |
| import kafka.common.AdminCommandFailedException |
| import kafka.utils._ |
| import org.I0Itec.zkclient.ZkClient |
| import org.I0Itec.zkclient.exception.ZkNodeExistsException |
| import scala.collection._ |
| import scala.collection.JavaConversions._ |
| import kafka.cluster.Broker |
| import kafka.log.LogConfig |
| import kafka.consumer.Whitelist |
| import kafka.server.OffsetManager |
| import org.apache.kafka.common.utils.Utils.formatAddress |
| |
| |
| object TopicCommand { |
| |
| def main(args: Array[String]): Unit = { |
| |
| val opts = new TopicCommandOptions(args) |
| |
| if(args.length == 0) |
| CommandLineUtils.printUsageAndDie(opts.parser, "Create, delete, describe, or change a topic.") |
| |
| // should have exactly one action |
| val actions = Seq(opts.createOpt, opts.listOpt, opts.alterOpt, opts.describeOpt, opts.deleteOpt).count(opts.options.has _) |
| if(actions != 1) |
| CommandLineUtils.printUsageAndDie(opts.parser, "Command must include exactly one action: --list, --describe, --create, --alter or --delete") |
| |
| opts.checkArgs() |
| |
| val zkClient = new ZkClient(opts.options.valueOf(opts.zkConnectOpt), 30000, 30000, ZKStringSerializer) |
| |
| try { |
| if(opts.options.has(opts.createOpt)) |
| createTopic(zkClient, opts) |
| else if(opts.options.has(opts.alterOpt)) |
| alterTopic(zkClient, opts) |
| else if(opts.options.has(opts.listOpt)) |
| listTopics(zkClient, opts) |
| else if(opts.options.has(opts.describeOpt)) |
| describeTopic(zkClient, opts) |
| else if(opts.options.has(opts.deleteOpt)) |
| deleteTopic(zkClient, opts) |
| } catch { |
| case e: Throwable => |
| println("Error while executing topic command " + e.getMessage) |
| println(Utils.stackTrace(e)) |
| } finally { |
| zkClient.close() |
| } |
| } |
| |
| private def getTopics(zkClient: ZkClient, opts: TopicCommandOptions): Seq[String] = { |
| val allTopics = ZkUtils.getAllTopics(zkClient).sorted |
| if (opts.options.has(opts.topicOpt)) { |
| val topicsSpec = opts.options.valueOf(opts.topicOpt) |
| val topicsFilter = new Whitelist(topicsSpec) |
| allTopics.filter(topicsFilter.isTopicAllowed(_, excludeInternalTopics = false)) |
| } else |
| allTopics |
| } |
| |
| def createTopic(zkClient: ZkClient, opts: TopicCommandOptions) { |
| val topic = opts.options.valueOf(opts.topicOpt) |
| val configs = parseTopicConfigsToBeAdded(opts) |
| if (opts.options.has(opts.replicaAssignmentOpt)) { |
| val assignment = parseReplicaAssignment(opts.options.valueOf(opts.replicaAssignmentOpt)) |
| AdminUtils.createOrUpdateTopicPartitionAssignmentPathInZK(zkClient, topic, assignment, configs) |
| } else { |
| CommandLineUtils.checkRequiredArgs(opts.parser, opts.options, opts.partitionsOpt, opts.replicationFactorOpt) |
| val partitions = opts.options.valueOf(opts.partitionsOpt).intValue |
| val replicas = opts.options.valueOf(opts.replicationFactorOpt).intValue |
| AdminUtils.createTopic(zkClient, topic, partitions, replicas, configs) |
| } |
| println("Created topic \"%s\".".format(topic)) |
| } |
| |
| def alterTopic(zkClient: ZkClient, opts: TopicCommandOptions) { |
| val topics = getTopics(zkClient, opts) |
| topics.foreach { topic => |
| val configs = AdminUtils.fetchTopicConfig(zkClient, topic) |
| if(opts.options.has(opts.configOpt) || opts.options.has(opts.deleteConfigOpt)) { |
| val configsToBeAdded = parseTopicConfigsToBeAdded(opts) |
| val configsToBeDeleted = parseTopicConfigsToBeDeleted(opts) |
| // compile the final set of configs |
| configs.putAll(configsToBeAdded) |
| configsToBeDeleted.foreach(config => configs.remove(config)) |
| AdminUtils.changeTopicConfig(zkClient, topic, configs) |
| println("Updated config for topic \"%s\".".format(topic)) |
| } |
| if(opts.options.has(opts.partitionsOpt)) { |
| if (topic == OffsetManager.OffsetsTopicName) { |
| throw new IllegalArgumentException("The number of partitions for the offsets topic cannot be changed.") |
| } |
| println("WARNING: If partitions are increased for a topic that has a key, the partition " + |
| "logic or ordering of the messages will be affected") |
| val nPartitions = opts.options.valueOf(opts.partitionsOpt).intValue |
| val replicaAssignmentStr = opts.options.valueOf(opts.replicaAssignmentOpt) |
| AdminUtils.addPartitions(zkClient, topic, nPartitions, replicaAssignmentStr, config = configs) |
| println("Adding partitions succeeded!") |
| } |
| } |
| } |
| |
| def listTopics(zkClient: ZkClient, opts: TopicCommandOptions) { |
| val topics = getTopics(zkClient, opts) |
| for(topic <- topics) { |
| if (ZkUtils.pathExists(zkClient,ZkUtils.getDeleteTopicPath(topic))) { |
| println("%s - marked for deletion".format(topic)) |
| } else { |
| println(topic) |
| } |
| } |
| } |
| |
| def deleteTopic(zkClient: ZkClient, opts: TopicCommandOptions) { |
| val topics = getTopics(zkClient, opts) |
| if (topics.length == 0) { |
| println("Topic %s does not exist".format(opts.options.valueOf(opts.topicOpt))) |
| } |
| topics.foreach { topic => |
| try { |
| ZkUtils.createPersistentPath(zkClient, ZkUtils.getDeleteTopicPath(topic)) |
| println("Topic %s is marked for deletion.".format(topic)) |
| println("Note: This will have no impact if delete.topic.enable is not set to true.") |
| } catch { |
| case e: ZkNodeExistsException => |
| println("Topic %s is already marked for deletion.".format(topic)) |
| case e2: Throwable => |
| throw new AdminOperationException("Error while deleting topic %s".format(topic)) |
| } |
| } |
| } |
| |
| def describeTopic(zkClient: ZkClient, opts: TopicCommandOptions) { |
| val topics = getTopics(zkClient, opts) |
| val reportUnderReplicatedPartitions = if (opts.options.has(opts.reportUnderReplicatedPartitionsOpt)) true else false |
| val reportUnavailablePartitions = if (opts.options.has(opts.reportUnavailablePartitionsOpt)) true else false |
| val reportOverriddenConfigs = if (opts.options.has(opts.topicsWithOverridesOpt)) true else false |
| val liveBrokers = ZkUtils.getAllBrokersInCluster(zkClient).map(_.id).toSet |
| for (topic <- topics) { |
| ZkUtils.getPartitionAssignmentForTopics(zkClient, List(topic)).get(topic) match { |
| case Some(topicPartitionAssignment) => |
| val describeConfigs: Boolean = !reportUnavailablePartitions && !reportUnderReplicatedPartitions |
| val describePartitions: Boolean = !reportOverriddenConfigs |
| val sortedPartitions = topicPartitionAssignment.toList.sortWith((m1, m2) => m1._1 < m2._1) |
| if (describeConfigs) { |
| val configs = AdminUtils.fetchTopicConfig(zkClient, topic) |
| if (!reportOverriddenConfigs || configs.size() != 0) { |
| val numPartitions = topicPartitionAssignment.size |
| val replicationFactor = topicPartitionAssignment.head._2.size |
| println("Topic:%s\tPartitionCount:%d\tReplicationFactor:%d\tConfigs:%s" |
| .format(topic, numPartitions, replicationFactor, configs.map(kv => kv._1 + "=" + kv._2).mkString(","))) |
| } |
| } |
| if (describePartitions) { |
| for ((partitionId, assignedReplicas) <- sortedPartitions) { |
| val inSyncReplicas = ZkUtils.getInSyncReplicasForPartition(zkClient, topic, partitionId) |
| val leader = ZkUtils.getLeaderForPartition(zkClient, topic, partitionId) |
| if ((!reportUnderReplicatedPartitions && !reportUnavailablePartitions) || |
| (reportUnderReplicatedPartitions && inSyncReplicas.size < assignedReplicas.size) || |
| (reportUnavailablePartitions && (!leader.isDefined || !liveBrokers.contains(leader.get)))) { |
| print("\tTopic: " + topic) |
| print("\tPartition: " + partitionId) |
| print("\tLeader: " + (if(leader.isDefined) leader.get else "none")) |
| print("\tReplicas: " + assignedReplicas.mkString(",")) |
| println("\tIsr: " + inSyncReplicas.mkString(",")) |
| } |
| } |
| } |
| case None => |
| println("Topic " + topic + " doesn't exist!") |
| } |
| } |
| } |
| |
| def formatBroker(broker: Broker) = broker.id + " (" + formatAddress(broker.host, broker.port) + ")" |
| |
| def parseTopicConfigsToBeAdded(opts: TopicCommandOptions): Properties = { |
| val configsToBeAdded = opts.options.valuesOf(opts.configOpt).map(_.split("""\s*=\s*""")) |
| require(configsToBeAdded.forall(config => config.length == 2), |
| "Invalid topic config: all configs to be added must be in the format \"key=val\".") |
| val props = new Properties |
| configsToBeAdded.foreach(pair => props.setProperty(pair(0).trim, pair(1).trim)) |
| LogConfig.validate(props) |
| props |
| } |
| |
| def parseTopicConfigsToBeDeleted(opts: TopicCommandOptions): Seq[String] = { |
| if (opts.options.has(opts.deleteConfigOpt)) { |
| val configsToBeDeleted = opts.options.valuesOf(opts.deleteConfigOpt).map(_.trim()) |
| val propsToBeDeleted = new Properties |
| configsToBeDeleted.foreach(propsToBeDeleted.setProperty(_, "")) |
| LogConfig.validateNames(propsToBeDeleted) |
| configsToBeDeleted |
| } |
| else |
| Seq.empty |
| } |
| |
| def parseReplicaAssignment(replicaAssignmentList: String): Map[Int, List[Int]] = { |
| val partitionList = replicaAssignmentList.split(",") |
| val ret = new mutable.HashMap[Int, List[Int]]() |
| for (i <- 0 until partitionList.size) { |
| val brokerList = partitionList(i).split(":").map(s => s.trim().toInt) |
| val duplicateBrokers = Utils.duplicates(brokerList) |
| if (duplicateBrokers.nonEmpty) |
| throw new AdminCommandFailedException("Partition replica lists may not contain duplicate entries: %s".format(duplicateBrokers.mkString(","))) |
| ret.put(i, brokerList.toList) |
| if (ret(i).size != ret(0).size) |
| throw new AdminOperationException("Partition " + i + " has different replication factor: " + brokerList) |
| } |
| ret.toMap |
| } |
| |
| class TopicCommandOptions(args: Array[String]) { |
| val parser = new OptionParser |
| val zkConnectOpt = parser.accepts("zookeeper", "REQUIRED: The connection string for the zookeeper connection in the form host:port. " + |
| "Multiple URLS can be given to allow fail-over.") |
| .withRequiredArg |
| .describedAs("urls") |
| .ofType(classOf[String]) |
| val listOpt = parser.accepts("list", "List all available topics.") |
| val createOpt = parser.accepts("create", "Create a new topic.") |
| val deleteOpt = parser.accepts("delete", "Delete a topic") |
| val alterOpt = parser.accepts("alter", "Alter the configuration for the topic.") |
| val describeOpt = parser.accepts("describe", "List details for the given topics.") |
| val helpOpt = parser.accepts("help", "Print usage information.") |
| val topicOpt = parser.accepts("topic", "The topic to be create, alter or describe. Can also accept a regular " + |
| "expression except for --create option") |
| .withRequiredArg |
| .describedAs("topic") |
| .ofType(classOf[String]) |
| val nl = System.getProperty("line.separator") |
| val configOpt = parser.accepts("config", "A topic configuration override for the topic being created or altered." + |
| "The following is a list of valid configurations: " + nl + LogConfig.ConfigNames.map("\t" + _).mkString(nl) + nl + |
| "See the Kafka documentation for full details on the topic configs.") |
| .withRequiredArg |
| .describedAs("name=value") |
| .ofType(classOf[String]) |
| val deleteConfigOpt = parser.accepts("delete-config", "A topic configuration override to be removed for an existing topic (see the list of configurations under the --config option).") |
| .withRequiredArg |
| .describedAs("name") |
| .ofType(classOf[String]) |
| val partitionsOpt = parser.accepts("partitions", "The number of partitions for the topic being created or " + |
| "altered (WARNING: If partitions are increased for a topic that has a key, the partition logic or ordering of the messages will be affected") |
| .withRequiredArg |
| .describedAs("# of partitions") |
| .ofType(classOf[java.lang.Integer]) |
| val replicationFactorOpt = parser.accepts("replication-factor", "The replication factor for each partition in the topic being created.") |
| .withRequiredArg |
| .describedAs("replication factor") |
| .ofType(classOf[java.lang.Integer]) |
| val replicaAssignmentOpt = parser.accepts("replica-assignment", "A list of manual partition-to-broker assignments for the topic being created or altered.") |
| .withRequiredArg |
| .describedAs("broker_id_for_part1_replica1 : broker_id_for_part1_replica2 , " + |
| "broker_id_for_part2_replica1 : broker_id_for_part2_replica2 , ...") |
| .ofType(classOf[String]) |
| val reportUnderReplicatedPartitionsOpt = parser.accepts("under-replicated-partitions", |
| "if set when describing topics, only show under replicated partitions") |
| val reportUnavailablePartitionsOpt = parser.accepts("unavailable-partitions", |
| "if set when describing topics, only show partitions whose leader is not available") |
| val topicsWithOverridesOpt = parser.accepts("topics-with-overrides", |
| "if set when describing topics, only show topics that have overridden configs") |
| |
| val options = parser.parse(args : _*) |
| |
| val allTopicLevelOpts: Set[OptionSpec[_]] = Set(alterOpt, createOpt, describeOpt, listOpt) |
| |
| def checkArgs() { |
| // check required args |
| CommandLineUtils.checkRequiredArgs(parser, options, zkConnectOpt) |
| if (!options.has(listOpt) && !options.has(describeOpt)) |
| CommandLineUtils.checkRequiredArgs(parser, options, topicOpt) |
| |
| // check invalid args |
| CommandLineUtils.checkInvalidArgs(parser, options, configOpt, allTopicLevelOpts -- Set(alterOpt, createOpt)) |
| CommandLineUtils.checkInvalidArgs(parser, options, deleteConfigOpt, allTopicLevelOpts -- Set(alterOpt)) |
| CommandLineUtils.checkInvalidArgs(parser, options, partitionsOpt, allTopicLevelOpts -- Set(alterOpt, createOpt)) |
| CommandLineUtils.checkInvalidArgs(parser, options, replicationFactorOpt, allTopicLevelOpts -- Set(createOpt)) |
| CommandLineUtils.checkInvalidArgs(parser, options, replicaAssignmentOpt, |
| allTopicLevelOpts -- Set(alterOpt, createOpt) + partitionsOpt + replicationFactorOpt) |
| CommandLineUtils.checkInvalidArgs(parser, options, reportUnderReplicatedPartitionsOpt, |
| allTopicLevelOpts -- Set(describeOpt) + reportUnavailablePartitionsOpt + topicsWithOverridesOpt) |
| CommandLineUtils.checkInvalidArgs(parser, options, reportUnavailablePartitionsOpt, |
| allTopicLevelOpts -- Set(describeOpt) + reportUnderReplicatedPartitionsOpt + topicsWithOverridesOpt) |
| CommandLineUtils.checkInvalidArgs(parser, options, topicsWithOverridesOpt, |
| allTopicLevelOpts -- Set(describeOpt) + reportUnderReplicatedPartitionsOpt + reportUnavailablePartitionsOpt) |
| } |
| } |
| |
| } |
