文章目录
- OverView
- Topic主题命令行操作
- 重要参数
- 帮助文档
- 实操
- 生产者命令行操作
- 重要参数
- 帮助文档
- 实操
- 消费者命令行操作
- 重要参数
- 帮助文档
- 实操
OverView
Topic主题命令行操作
重要参数
| 参数 | 描述 |
|---|---|
--bootstrap-server | 连接Kafka Broker的主机名和端口号 |
--topic | 操作的主题名称 |
--create | 创建主题 |
--delete | 删除主题 |
--alter | 修改主题 |
--list | 查看所有主题 |
--describe | 查看主题详细描述 |
--partitions | 设置主题分区数 |
--replication-factor | 设置主题分区副本 |
--config | 更新系统默认的配置 |
这些参数是用于操作和管理Apache Kafka主题的命令行工具参数，通常用于kafka-topics.sh工具。以下是每个参数的描述：
-
--bootstrap-server：指定要连接的Kafka Broker的主机名和端口号，用于建立连接到Kafka集群的初始引导服务器。 -
--topic：指定操作的主题的名称，这是执行各种操作的目标主题。 -
--create：用于创建一个新的Kafka主题。在使用此参数时，需要提供主题名称和其他相关配置，例如分区数、副本因子等。 -
--delete：用于删除指定的Kafka主题。要谨慎使用此参数，因为删除主题将删除主题的所有数据和配置。 -
--alter：用于修改主题的配置，例如更改分区数、副本因子等。需要指定要修改的主题以及新的配置。 -
--list：列出Kafka集群中所有的主题名称。 -
--describe：查看指定主题的详细描述，包括主题的配置、分区信息、副本分配等。 -
--partitions：用于设置主题的分区数，通常与--create或--alter一起使用，以定义主题的分区数量。 -
--replication-factor：用于设置主题的分区副本因子，通常与--create或--alter一起使用，以定义主题的分区副本数量。 -
--config：用于更新系统默认的Kafka主题配置，可以设置不同的主题级别的配置参数。
这些参数是Kafka管理工具的一部分，用于在Kafka集群上执行各种管理任务，例如创建、删除、配置和查看主题。根据具体的任务，您可以使用这些参数中的一个或多个来执行相应的操作。
帮助文档
[root@localhost bin]# ./kafka-topics.sh
Create, delete, describe, or change a topic.
Option Description
------ -----------
--alter Alter the number of partitions andreplica assignment. Update theconfiguration of an existing topicvia --alter is no longer supportedhere (the kafka-configs CLI supportsaltering topic configs with a --bootstrap-server option).
--at-min-isr-partitions if set when describing topics, onlyshow partitions whose isr count isequal to the configured minimum.
--bootstrap-server <String: server to REQUIRED: The Kafka server to connectconnect to> to.
--command-config <String: command Property file containing configs to beconfig property file> passed to Admin Client. This is usedonly with --bootstrap-server optionfor describing and altering brokerconfigs.
--config <String: name=value> A topic configuration override for thetopic being created or altered. Thefollowing is a list of validconfigurations:cleanup.policycompression.typedelete.retention.msfile.delete.delay.msflush.messagesflush.msfollower.replication.throttled.replicasindex.interval.bytesleader.replication.throttled.replicaslocal.retention.byteslocal.retention.msmax.compaction.lag.msmax.message.bytesmessage.downconversion.enablemessage.format.versionmessage.timestamp.after.max.msmessage.timestamp.before.max.msmessage.timestamp.difference.max.msmessage.timestamp.typemin.cleanable.dirty.ratiomin.compaction.lag.msmin.insync.replicaspreallocateremote.storage.enableretention.bytesretention.mssegment.bytessegment.index.bytessegment.jitter.mssegment.msunclean.leader.election.enableSee the Kafka documentation for fulldetails on the topic configs. It issupported only in combination with --create if --bootstrap-server optionis used (the kafka-configs CLIsupports altering topic configs witha --bootstrap-server option).
--create Create a new topic.
--delete Delete a topic
--delete-config <String: name> A topic configuration override to beremoved for an existing topic (seethe list of configurations under the--config option). Not supported withthe --bootstrap-server option.
--describe List details for the given topics.
--exclude-internal exclude internal topics when runninglist or describe command. Theinternal topics will be listed bydefault
--help Print usage information.
--if-exists if set when altering or deleting ordescribing topics, the action willonly execute if the topic exists.
--if-not-exists if set when creating topics, theaction will only execute if thetopic does not already exist.
--list List all available topics.
--partitions <Integer: # of partitions> The number of partitions for the topicbeing created or altered (WARNING:If partitions are increased for atopic that has a key, the partitionlogic or ordering of the messageswill be affected). If not suppliedfor create, defaults to the clusterdefault.
--replica-assignment <String: A list of manual partition-to-brokerbroker_id_for_part1_replica1 : assignments for the topic beingbroker_id_for_part1_replica2 , created or altered.broker_id_for_part2_replica1 :broker_id_for_part2_replica2 , ...>
--replication-factor <Integer: The replication factor for eachreplication factor> partition in the topic beingcreated. If not supplied, defaultsto the cluster default.
--topic <String: topic> The topic to create, alter, describeor delete. It also accepts a regularexpression, except for --createoption. Put topic name in doublequotes and use the '\' prefix toescape regular expression symbols; e.g. "test\.topic".
--topic-id <String: topic-id> The topic-id to describe.This is usedonly with --bootstrap-server optionfor describing topics.
--topics-with-overrides if set when describing topics, onlyshow topics that have overriddenconfigs
--unavailable-partitions if set when describing topics, onlyshow partitions whose leader is notavailable
--under-min-isr-partitions if set when describing topics, onlyshow partitions whose isr count isless than the configured minimum.
--under-replicated-partitions if set when describing topics, onlyshow under replicated partitions
--version Display Kafka version.
[root@localhost bin]# ./kafka-topics.sh --bootstrap-server 127.0.0.1:9092 --list[root@localhost bin]#实操
[root@localhost bin]# 创建一个主题名为artisan的topic
[root@localhost bin]# ./kafka-topics.sh --bootstrap-server 127.0.0.1:9092 --create --replication-factor 3 --partitions 3 --topic artisan
Error while executing topic command : Replication factor: 3 larger than available brokers: 1.
[2023-10-25 15:11:52,489] ERROR org.apache.kafka.common.errors.InvalidReplicationFactorException: Replication factor: 3 larger than available brokers: 1.(kafka.admin.TopicCommand$)
[root@localhost bin]#
[root@localhost bin]#
[root@localhost bin]# 创建一个主题名为artisan的topic
[root@localhost bin]# ./kafka-topics.sh --bootstrap-server 127.0.0.1:9092 --create --replication-factor 1 --partitions 3 --topic artisan
Created topic artisan.
[root@localhost bin]#
[root@localhost bin]# 看当前服务器中的所有topic
[root@localhost bin]# ./kafka-topics.sh --bootstrap-server 127.0.0.1:9092 --list
artisan
[root@localhost bin]# 查看Topic的详情
[root@localhost bin]# ./kafka-topics.sh --bootstrap-server 127.0.0.1:9092 --describe --topic artisan
Topic: artisan TopicId: CQ8T4OtdR_aPJVYRTp9Jbg PartitionCount: 3 ReplicationFactor: 1 Configs:Topic: artisan Partition: 0 Leader: 0 Replicas: 0 Isr: 0Topic: artisan Partition: 1 Leader: 0 Replicas: 0 Isr: 0Topic: artisan Partition: 2 Leader: 0 Replicas: 0 Isr: 0
[root@localhost bin]#
[root@localhost bin]#
[root@localhost bin]#
[root@localhost bin]# 修改分区数（注意：分区数只能增加，不能减少）
[root@localhost bin]# ./kafka-topics.sh --bootstrap-server 127.0.0.1:9092 --alter --topic artisan --partitions 4
[root@localhost bin]#
[root@localhost bin]#
[root@localhost bin]#
[root@localhost bin]# 再次查看Topic的详情
[root@localhost bin]# ./kafka-topics.sh --bootstrap-server 127.0.0.1:9092 --describe --topic artisan
Topic: artisan TopicId: CQ8T4OtdR_aPJVYRTp9Jbg PartitionCount: 4 ReplicationFactor: 1 Configs:Topic: artisan Partition: 0 Leader: 0 Replicas: 0 Isr: 0Topic: artisan Partition: 1 Leader: 0 Replicas: 0 Isr: 0Topic: artisan Partition: 2 Leader: 0 Replicas: 0 Isr: 0Topic: artisan Partition: 3 Leader: 0 Replicas: 0 Isr: 0
[root@localhost bin]# 删除artian主题
[root@localhost bin]# ./kafka-topics.sh --bootstrap-server 127.0.0.1:9092 --delete --topic artisan
[root@localhost bin]#
[root@localhost bin]#
[root@localhost bin]#
[root@localhost bin]# ./kafka-topics.sh --bootstrap-server 127.0.0.1:9092 --list[root@localhost bin]#修改分区数（ 分区数只能增加，不能减少）
生产者命令行操作
重要参数
| 参数 | 描述 |
|---|---|
--bootstrap-server | 连接Kafka Broker的主机名和端口号 |
--topic | 操作的主题名称 |
帮助文档
# 查看帮助文档
[root@localhost bin]# ./kafka-console-producer.sh
Missing required option(s) [bootstrap-server]
Option Description
------ -----------
--batch-size <Integer: size> Number of messages to send in a singlebatch if they are not being sentsynchronously. please note that thisoption will be replaced if max-partition-memory-bytes is also set(default: 16384)
--bootstrap-server <String: server to REQUIRED unless --broker-listconnect to> (deprecated) is specified. The server(s) to connect to. The broker liststring in the form HOST1:PORT1,HOST2:PORT2.
--broker-list <String: broker-list> DEPRECATED, use --bootstrap-serverinstead; ignored if --bootstrap-server is specified. The brokerlist string in the form HOST1:PORT1,HOST2:PORT2.
--compression-codec [String: The compression codec: either 'none',compression-codec] 'gzip', 'snappy', 'lz4', or 'zstd'.If specified without value, then itdefaults to 'gzip'
--help Print usage information.
--line-reader <String: reader_class> The class name of the class to use forreading lines from standard in. Bydefault each line is read as aseparate message. (default: kafka.tools.ConsoleProducer$LineMessageReader)
--max-block-ms <Long: max block on The max time that the producer willsend> block for during a send request.(default: 60000)
--max-memory-bytes <Long: total memory The total memory used by the producerin bytes> to buffer records waiting to be sentto the server. This is the option tocontrol `buffer.memory` in producerconfigs. (default: 33554432)
--max-partition-memory-bytes <Integer: The buffer size allocated for amemory in bytes per partition> partition. When records are receivedwhich are smaller than this size theproducer will attempt tooptimistically group them togetheruntil this size is reached. This isthe option to control `batch.size`in producer configs. (default: 16384)
--message-send-max-retries <Integer> Brokers can fail receiving the messagefor multiple reasons, and beingunavailable transiently is just oneof them. This property specifies thenumber of retries before theproducer give up and drop thismessage. This is the option tocontrol `retries` in producerconfigs. (default: 3)
--metadata-expiry-ms <Long: metadata The period of time in millisecondsexpiration interval> after which we force a refresh ofmetadata even if we haven't seen anyleadership changes. This is theoption to control `metadata.max.age.ms` in producer configs. (default:300000)
--producer-property <String: A mechanism to pass user-definedproducer_prop> properties in the form key=value tothe producer.
--producer.config <String: config file> Producer config properties file. Notethat [producer-property] takesprecedence over this config.
--property <String: prop> A mechanism to pass user-definedproperties in the form key=value tothe message reader. This allowscustom configuration for a user-defined message reader.Default properties include:parse.key=falseparse.headers=falseignore.error=falsekey.separator=\theaders.delimiter=\theaders.separator=,headers.key.separator=:null.marker= When set, any fields(key, value and headers) equal tothis will be replaced by nullDefault parsing pattern when:parse.headers=true and parse.key=true:"h1:v1,h2:v2...\tkey\tvalue"parse.key=true:"key\tvalue"parse.headers=true:"h1:v1,h2:v2...\tvalue"
--reader-config <String: config file> Config properties file for the messagereader. Note that [property] takesprecedence over this config.
--request-required-acks <String: The required `acks` of the producerrequest required acks> requests (default: -1)
--request-timeout-ms <Integer: request The ack timeout of the producertimeout ms> requests. Value must be non-negativeand non-zero. (default: 1500)
--retry-backoff-ms <Long> Before each retry, the producerrefreshes the metadata of relevanttopics. Since leader election takesa bit of time, this propertyspecifies the amount of time thatthe producer waits before refreshingthe metadata. This is the option tocontrol `retry.backoff.ms` inproducer configs. (default: 100)
--socket-buffer-size <Integer: size> The size of the tcp RECV size. This isthe option to control `send.buffer.bytes` in producer configs.(default: 102400)
--sync If set message send requests to thebrokers are synchronously, one at atime as they arrive.
--timeout <Long: timeout_ms> If set and the producer is running inasynchronous mode, this gives themaximum amount of time a messagewill queue awaiting sufficient batchsize. The value is given in ms. Thisis the option to control `linger.ms`in producer configs. (default: 1000)
--topic <String: topic> REQUIRED: The topic id to producemessages to.
--version Display Kafka version.实操
[root@localhost bin]# ./kafka-topics.sh --bootstrap-server 127.0.0.1:9092 --create --replication-factor 1 --partitions 3 --topic artisan
Created topic artisan.
[root@localhost bin]#
[root@localhost bin]#
[root@localhost bin]# ./kafka-console-producer.sh --bootstrap-server 127.0.0.1:9092 --topic artisan
>test
>artisan (在这之后启动consumer的消费，默认只能收到之后的消息)
>666
>消费者命令行操作
重要参数
| 参数 | 描述 |
|---|---|
--bootstrap-server | 连接Kafka Broker的主机名和端口号 |
--topic | 操作的topic名称 |
--from-beginning | 从头开始消费 |
--group | 指定消费者组名称 |
帮助文档
# 查看帮助文档
[root@localhost bin]# ./kafka-console-consumer.sh
This tool helps to read data from Kafka topics and outputs it to standard output.
Option Description
------ -----------
--bootstrap-server <String: server to REQUIRED: The server(s) to connect to.connect to>
--consumer-property <String: A mechanism to pass user-definedconsumer_prop> properties in the form key=value tothe consumer.
--consumer.config <String: config file> Consumer config properties file. Notethat [consumer-property] takesprecedence over this config.
--enable-systest-events Log lifecycle events of the consumerin addition to logging consumedmessages. (This is specific forsystem tests.)
--formatter <String: class> The name of a class to use forformatting kafka messages fordisplay. (default: kafka.tools.DefaultMessageFormatter)
--formatter-config <String: config Config properties file to initializefile> the message formatter. Note that[property] takes precedence overthis config.
--from-beginning If the consumer does not already havean established offset to consumefrom, start with the earliestmessage present in the log ratherthan the latest message.
--group <String: consumer group id> The consumer group id of the consumer.
--help Print usage information.
--include <String: Java regex (String)> Regular expression specifying list oftopics to include for consumption.
--isolation-level <String> Set to read_committed in order tofilter out transactional messageswhich are not committed. Set toread_uncommitted to read allmessages. (default: read_uncommitted)
--key-deserializer <String:deserializer for key>
--max-messages <Integer: num_messages> The maximum number of messages toconsume before exiting. If not set,consumption is continual.
--offset <String: consume offset> The offset to consume from (a non-negative number), or 'earliest'which means from beginning, or'latest' which means from end(default: latest)
--partition <Integer: partition> The partition to consume from.Consumption starts from the end ofthe partition unless '--offset' isspecified.
--property <String: prop> The properties to initialize themessage formatter. Defaultproperties include:print.timestamp=true|falseprint.key=true|falseprint.offset=true|falseprint.partition=true|falseprint.headers=true|falseprint.value=true|falsekey.separator=<key.separator>line.separator=<line.separator>headers.separator=<line.separator>null.literal=<null.literal>key.deserializer=<key.deserializer>value.deserializer=<value.deserializer>header.deserializer=<header.deserializer>Users can also pass in customizedproperties for their formatter; morespecifically, users can pass inproperties keyed with 'key.deserializer.', 'value.deserializer.' and 'headers.deserializer.' prefixes to configuretheir deserializers.
--skip-message-on-error If there is an error when processing amessage, skip it instead of halt.
--timeout-ms <Integer: timeout_ms> If specified, exit if no message isavailable for consumption for thespecified interval.
--topic <String: topic> The topic to consume on.
--value-deserializer <String:deserializer for values>
--version Display Kafka version.
--whitelist <String: Java regex DEPRECATED, use --include instead;(String)> ignored if --include specified.Regular expression specifying listof topics to include for consumption.实操
[root@localhost bin]# ./kafka-console-consumer.sh --bootstrap-server 127.0.0.1:9092 --topic artisan666# 从头开始消费[root@localhost bin]# ./kafka-console-consumer.sh --bootstrap-server 127.0.0.1:9092 --from-beginning --topic artisan
test
artisan
666
