• 极客专栏正式上线!欢迎访问 https://www.jikewenku.com/topic.html
  • 极客专栏正式上线!欢迎访问 https://www.jikewenku.com/topic.html

kafka入门教程(九)kafka shell脚本用法详解

技术杂谈 勤劳的小蚂蚁 4个月前 (01-03) 107次浏览 已收录 0个评论 扫描二维码

9. kafka shell脚本用法详解

kafka安装目录下的bin目录包含了很多运维可操作的shell脚本,列举如下:
脚 本名称用途描述
connect-distributed.sh连接kafka集群模式
connect-standalone.sh连接kafka单机模式
kafka-acls.shtodo
kafka-broker-api-versions.shtodo
kafka-configs.sh配置管理脚本
kafka-console-consumer.shkafka消费者控制台
kafka-console-producer.shkafka生产者控制台
kafka-consumer-groups.shkafka消费者组相关信息
kafka-consumer-perf-test.shkafka消费者性能测试脚本
kafka-delegation-tokens.shtodo
kafka-delete-records.sh删除低水位的日志文件
kafka-log-dirs.shkafka消息日志目录信息
kafka-mirror-maker.sh不同数据中心kafka集群复制工具
kafka-preferred-replica-election.sh触发preferred replica选举
kafka-producer-perf-test.shkafka生产者性能测试脚本
kafka-reassign-partitions.sh分区重分配脚本
kafka-replay-log-producer.shtodo
kafka-replica-verification.sh复制进度验证脚本
kafka-run-class.shtodo
kafka-server-start.sh启动kafka服务
kafka-server-stop.sh停止kafka服务
kafka-simple-consumer-shell.shdeprecated,推荐使用kafka-console-consumer.sh
kafka-streams-application-reset.shtodo
kafka-topics.shtopic管理脚本
kafka-verifiable-consumer.sh可检验的kafka消费者
kafka-verifiable-producer.sh可检验的kafka生产者
trogdor.shtodo
zookeeper-security-migration.shtodo
zookeeper-server-start.sh启动zk服务
zookeeper-server-stop.sh停止zk服务
zookeeper-shell.shzk客户端
接下来详细说明每个脚本的使用方法。
  • connect-distributed.sh&connect-standalone.sh
Kafka Connect是在0.9以后加入的功能,主要是用来将其他系统的数据导入到Kafka,然后再将Kafka中的数据导出到另外的系统。可以用来做实时数据同步的ETL,数据实时分析处理等。
主要有2种模式:Standalone(单机模式)和Distribute(分布式模式)。
单机主要用来开发,测试,分布式的用于生产环境。
用法比较复杂,建议参考:Kafka Connect教程详解 https://3gods.com/bigdata/Kafka-Connect-Details.html
  • kafka-broker-api-versions.sh
用法:bin/kafka-broker-api-versions.sh –bootstrap-server 10.0.55.229:9092,10.0.55.229:9093,10.0.55.229:9094
  • kafka-configs.sh
配置管理脚本,这个脚本主要分两类用法:describe和alter。这个脚本主要用于显示和修改覆盖配置,即覆盖默认配置。
describe相关用法:
查看每个topic的配置:bin/kafka-configs.sh –zookeeper localhost:2181 –describe –entity-type topics
部分结果如下:
Configs for topic ‘afei’ are 
Configs for topic ‘TOPIC-TEST-AFEI’ are retention.ms=600000 
Configs for topic ‘__consumer_offsets’ are segment.bytes=104857600,cleanup.policy=compact,compression.type=producer
查看broker的配置:bin/kafka-configs.sh –bootstrap-server localhost:9092 –describe  –entity-type brokers –entity-name  0
说明:0是broker.id,因为entity-type为brokers,所以entity-name表示broker.id。
alter相关用法:
给指定topic增加配置:bin/kafka-configs.sh –zookeeper localhost:2181 –alter –entity-type topics –entity-name  TOPIC-TEST-AFEI –add-config retention.ms=600000
给指定topic删除配置:bin/kafka-configs.sh –zookeeper localhost:2181 –alter –entity-type topics –entity-name  TOPIC-TEST-AFEI –delete-config max.message.bytes
通过该脚本可以管理的属性,可以通过执行bin/kafka-configs.sh得到的输出中–add-config的desc可以得到。
  • kafka-broker-api-versions.sh
用法:bin/kafka-broker-api-versions.sh –bootstrap-server localhost:9092
  • kafka-console-consumer.sh
用法:bin/kafka-console-consumer.sh –bootstrap-server localhost:9092 –topic afei [–group groupName] [–partition 目标分区]
这个命令后面还可带很多参数:
–key-deserializer:指定key的反序列化方式,默认是 org.apache.kafka.common.serialization.StringDeserializer
–value-deserializer:指定value的反序列化方式,默认是 org.apache.kafka.common.serialization.StringDeserializer
–from-beginning:从最早的消息开始消费,默认是从最新消息开始消费。
–offset: 从指定的消息位置开始消费,如果设置了这个参数,还需要带上–partition。否则会提示:The partition is required when offset is specified.
–timeout-ms:当消费者在这个参数指定时间间隔内没有收到消息就会推出,并抛出异常:kafka.consumer.ConsumerTimeoutException。
–whitelist:接收的topic白名单集合,和–topic二者取其一。例如:–whitelist “afei.*”(以afei开头的topic),–whitelist “afei”(指定afei这个topic),“afei|fly”(指定afei或者fly这两个topic)。另外一个参数–blacklist用法类似。
  • kafka-console-producer.sh
用法:bin/kafka-console-producer.sh –broker-list localhost:9092 –topic afei
,如果连接集群,那么broker-list参数格式为:HOST1:PORT1,HOST2:PORT2,HOST3:PORT3
这个命令后面还可带很多参数:
–key-serializer:指定key的序列化方式,默认是 org.apache.kafka.common.serialization.StringSerializer
–value-serializer:指定value的序列化方式,默认是 org.apache.kafka.common.serialization.StringSerializer
–sync: 指定同步方式发送消息,即在发送下一个消息之前会等待当前发送的消息得到确认。
  • kafka-consumer-groups.sh
查看所有消费者组:bin/kafka-consumer-groups.sh –bootstrap-server localhost:9092 –list
查看某个消费者组:bin/kafka-consumer-groups.sh –bootstrap-server localhost:9092 –group AfeiGroup –describe,输出结果如下:
Note: This will not show information about old Zookeeper-based consumers.
TOPIC           PARTITION  CURRENTOFFSET  LOGENDOFFSET  LAG             CONSUMER-ID                                     HOST            CLIENTID
afei            0          8               8               0               consumer-1-7a46c647-8221-4aca-b6bf-ed14571fb0f1 /172.18.36.203  consumer-1
afei            4          10              10              0               consumer-1-7a46c647-8221-4aca-b6bf-ed14571fb0f1 /172.18.36.203  consumer-1
afei            1          8               8               0               consumer-1-7a46c647-8221-4aca-b6bf-ed14571fb0f1 /172.18.36.203  consumer-1
afei            3          6               6               0               consumer-1-7a46c647-8221-4aca-b6bf-ed14571fb0f1 /172.18.36.203  consumer-1
afei            2          9               9               0               consumer-1-7a46c647-8221-4aca-b6bf-ed14571fb0f1 /172.18.36.203  consumer-1
输出结果列中LAG表示消费者当前offset和broker中LOG-END-OFFSET之间的差距,理想结果是0,表水没有任何延迟。如果这个值比较大,需要注意。
  • kafka-consumer-perf-test.sh
perf是performance的缩写,所以这个脚本是kafka消费者性能测试脚本。
用法:bin/kafka-consumer-perf-test.sh –broker-list localhost:9092 –group testGroup –topic afei –messages 1024
输出结果如下:
start.timeend.timedata.consumed.in.MBMB.secdata.consumed.in.nMsgnMsg.secrebalance.time.msfetch.time.msfetch.MB.secfetch.nMsg.sec
2018-07-02 22:49:10:068, 2018-07-02 22:49:12:077, 0.0001, 0.0001, 41, 20.4082, 19, 1990, 0.0001, 20.6030
  • kafka-delete-records.sh
用法:bin/kafka-delete-records.sh –bootstrap-server 10.0.55.229:9092,10.0.55.229:9093,10.0.55.229:9094  –offset-json-file offset.json,offset.json文件内容:
{
    “partitions”: [{
        “topic”“afei”,
        “partition”3,
        “offset”10
    }],
    “version”1
}
执行结果如下,表示删除afei这个topic下分区为3的offset少于10的消息日志(不会删除offset=10的消息日志):
Executing records delete operation
Records delete operation completed:
partition: afei-3    low_watermark: 10
  • kafka-log-dirs.sh
用法:bin/kafka-log-dirs.sh  –bootstrap-server localhost:9092  –describe  –topic-list afei[,topicName2,topicNameN],如果没有指定–topic-list,那么会输出所有kafka消息日志目录以及目录下所有topic信息。加上–topic-list参数后,输出结果如下,由这段结果可知,消息日志所在目录为/data/kafka-logs,并且afei这个topic有3个分区:
{
    “version”1,
    “brokers”: [{
        “broker”0,
        “logDirs”: [{
            “logDir”“/data/kafka-logs”,
            “error”null,
            “partitions”: [{
                “partition”“afei-1”,
                “size”567,
                “offsetLag”0,
                “isFuture”false
            }, {
                “partition”“afei-2”,
                “size”639,
                “offsetLag”0,
                “isFuture”false
            }, {
                “partition”“afei-0”,
                “size”561,
                “offsetLag”0,
                “isFuture”false
            }]
        }]
    }]
}
  • kafka-preferred-replica-election.sh
用法:bin/kafka-preferred-replica-election.sh –zookeeper  10.0.55.208:2181/wallet,10.0.55.209:2181/wallet,10.0.55.210:2181/wallet  –path-to-json-file afei-preferred.json(如果不带–path-to-json-file就是对所有topic进行preferred replica election),json文件内容如下::
{
    “partitions”: [{
        “topic”“afei”,
        “partition”0
    },
    {
        “topic”“afei”,
        “partition”1
    },
    {
        “topic”“afei”,
        “partition”2
    }]
}
场景:在创建一个topic时,kafka尽量将partition均分在所有的brokers上,并且将replicas也均分在不同的broker上。每个partitiion的所有replicas叫做”assigned replicas”,”assigned replicas”中的第一个replicas叫”preferred replica”,刚创建的topic一般”preferred replica”是leader。leader replica负责所有的读写。其他replica只是冷备状态,不接受读写请求。但随着时间推移,broker可能会主动停机甚至客观宕机,会发生leader选举迁移,导致机群的负载不均衡。我们期望对topic的leader进行重新负载均衡,让partition选择”preferred replica”做为leader。
kafka提供了一个参数auto.leader.rebalance.enable自动做这件事情,且默认为true,原理是一个后台线程检查并触发leader balance。但是并不建议把这个参数设置为true。因为担心这个自动选举发生在业务高峰期,从而导致影响业务。
验证:
操作比较简单,常见一个3个分区3个副本的topic,然后kill掉一个broker。这时候topic信息如下,我们可以看到broker.id为0的broker上有两个leader:
Topic:afei    PartitionCount:3    ReplicationFactor:3 Configs:
    Topicafei Partition: 0    Leader: 0   Replicas: 0,1,2 Isr: 0,1,2
    Topicafei Partition: 1    Leader: 1   Replicas: 1,2,0 Isr: 0,1,2
    Topicafei Partition: 2    Leader: 0   Replicas: 2,0,1 Isr: 0,1,2
执行kafka-preferred-replica-election.sh脚本后,topic信息如下,leader均匀分布在3个不同的broker上,
Topic:afei    PartitionCount:3    ReplicationFactor:3 Configs:
    Topicafei Partition: 0    Leader: 0   Replicas: 0,1,2 Isr: 0,1,2
    Topicafei Partition: 1    Leader: 1   Replicas: 1,2,0 Isr: 0,1,2
    Topicafei Partition: 2    Leader: 2   Replicas: 2,0,1 Isr: 0,1,2
  • kafka-producer-perf-test.sh
perf是performance的缩写,所以这个脚本是kafka生产者性能测试脚本。
  • kafka-reassign-partitions.sh
场景:将一些topic上的分区从当前所在broker移到其他比如新增的broker上。假设有个名为ORDER-DETAIL的topic,在broker.id为2的broker上:
Topic:ORDER-DETAIL    PartitionCount:1    ReplicationFactor:1 Configs:
    TopicORDER-DETAIL Partition: 0    Leader: 2   Replicas: 2 Isr: 2
现在想要把它移动到broker.id为1的broker上,执行脚本:bin/kafka-reassign-partitions.sh –zookeeper 10.0.55.208:2181/wallet,10.0.55.209:2181/wallet,10.0.55.210:2181/wallet –topics-to-move-json-file move.json –broker-list “1” –generate
–generate参数表示生成一个分区再分配配置,并不会真正的执行,命令执行结果如下:
Current partition replica assignment
{“version”:1,“partitions”:[{“topic”:“ORDER-DETAIL”,“partition”:0,“replicas”:[2],“log_dirs”:[“any”]}]}
Proposed partition reassignment configuration
{“version”:1,“partitions”:[{“topic”:“ORDER-DETAIL”,“partition”:0,“replicas”:[1],“log_dirs”:[“any”]}]}
我们只需要把第二段json内容保存到一个新建的final.json文件中(如果知道如何编写这段json内容,那么也可以不执行第一条命令),然后执行命令:bin/kafka-reassign-partitions.sh –zookeeper 10.0.55.208:2181/wallet,10.0.55.209:2181/wallet,10.0.55.210:2181/wallet –reassignment-json-file move_final.json –execute,此次执行的命令带有–execute参数,说明是真正的执行分区重分配。
通过这个命令还可以给某个topic增加副本,例如有一个名为ORDER-DETAIL的topic,有3个分区,但是只有1个副本,为了高可用,需要将副本数增加到2,那么编写replica.json文本内容如下:
{
    “version”1,
    “partitions”: [{
        “topic”“ORDER-DETAIL”,
        “partition”0,
        “replicas”: [12]
    },
    {
        “topic”“ORDER-DETAIL”,
        “partition”1,
        “replicas”: [02]
    },
    {
        “topic”“ORDER-DETAIL”,
        “partition”2,
        “replicas”: [10]
    }]
}
然后执行命令即可:bin/kafka-reassign-partitions.sh –zookeeper 10.0.55.208:2181/wallet,10.0.55.209:2181/wallet,10.0.55.210:2181/wallet –reassignment-json-file  replica.json
注意:分区重分配对集群的性能有比较大的影响,因为它会使内存页缓存发生变化,并且占用额外的网络和磁盘资源。将重分配过程拆分成几个小过程可以降低影响。
  • kafka-replica-verification.sh
用法:bin/kafka-replica-verification.sh –broker-list 10.0.55.229:9092,10.0.55.229:9093,10.0.55.229:9094 [–topic-white-list afei],参数–topic-white-list指定要检查的目标topic。输出结果如下,如果输出信息为max lag is 0 for …表示这个topic的复制没有任何延迟:
2018-07-03 15:04:46,889: verification process is started.
2018-07-03 15:05:16,811: max lag is 0 for partition afei at offset 0 among 5 partitions
2018-07-03 15:05:46,812: max lag is 0 for partition afei at offset 0 among 5 partitions
… …
这个脚本使用时也要注意,会对集群造成一定影响,因为它需要读取所有消息。
  • kafka-server-start.sh
用法:bin/kafka-server-start.sh -daemon config/server.properties,指定配置文件并以守护进程模式启动。
  • kafka-server-stop.sh
用法:bin/kafka-server-stop.sh 。说明,这个命令会kill掉当前服务器上所有kafka broker。但是这个脚本可能执行结果为:No kafka server to stop
分析原因:我们先看一下kafka-server-stop.sh脚本内容,这个脚本非常简单,就是得到所有包含kafka.Kafka的进程ID,但是由于kafka启动依赖比较多的jar,导致kafka进程的ps结果输出内容比较长,而ps输出结果受到PAGE_SIZE(其值通过命令getconf PAGE_SIZE可以得到)的限制,从而导致ps结果中看不到kafka.Kafka,所以不能kill掉kafka server:
SIGNAL=${SIGNAL:-TERM}
PIDS=$(ps ax | grep -i ‘kafka.Kafka’ | grep java | grep -v grep | awk ‘{print $1}’)
if [ -z $PIDS ]; then
  echo “No kafka server to stop”
  exit 1
else
  kill -s $SIGNAL $PIDS
fi
为了kafka-server-stop.sh脚本可以正常执行,建议修改脚本如下,通过bin脚本所在目录的上级目录来查找进程ID,从而kill相关进程:
cd `dirname $0`
BIN_DIR=`pwd`
cd ..
DEPLOY_DIR=`pwd`
SIGNAL=${SIGNAL:-TERM}
PIDS=$(ps ax | grep -i ${DEPLOY_DIR} | grep java | grep -v grep | awk ‘{print $1}’)
if [ -z $PIDS ]; then
  echo “No kafka server to stop”
  exit 1
else
  kill -s $SIGNAL $PIDS
fi
  • kafka-simple-consumer-shell.sh
deprecated,用法:bin/kafka-simple-consumer-shell.sh –broker-list 10.0.55.229:9092,10.0.55.229:9093,10.0.55.229:9094 –topic afei
  • kafka-topics.sh
创建topic: bin/kafka-topics.sh –zookeeper localhost:2181 –create –topic afei –partitions 3 –replication-factor 1
删除topic: bin/kafka-topics.sh –zookeeper localhost:2181 –delete –topic test,broker的delete.topic.enable一定要是true才能成功删除topic,否则删除命令会被忽视。
修改topic: bin/kafka-topics.sh –zookeeper localhost:2181 –alter –topic afei –partitions 5,修改topic时只能增加分区数量。
查询topic: bin/kafka-topics.sh –zookeeper localhost:2181 –describe [ –topic afei ],查询时如果带上–topic topicName,那么表示只查询该topic的详细信息。这时候还可以带上–unavailable-partitions–under-replicated-partitions任意一个参数。
说明:如果某些topic为了有序发送消息时会基于key,那么增加分区数量会导致key和分区的映射关系发生变化。如果这个影响不能接受,那么基于key的topic最好一开始就评估分区数量,将来尽量避免调整。
  • kafka-verifiable-consumer.sh
用法:bin/kafka-verifiable-consumer.sh –broker-list 10.0.55.229:9092,10.0.55.229:9093,10.0.55.229:9094 –topic afei  –group-id groupName
这个脚本的作用是接收指定topic的消息消费,并发出消费者事件,例如:offset提交等。
  • kafka-verifiable-producer.sh
用法:bin/kafka-verifiable-producer.sh  –broker-list 10.0.55.229:9092,10.0.55.229:9093,10.0.55.229:9094 –topic afei [–max-messages 64],建议使用该脚本时增加参数–max-messages,否则会不停的发送消息。
这个脚本的作用是持续发送消息到指定的topic中,参数–max-messages限制最大发送消息数。且每条发送的消息都会有响应信息,这就是和kafka-console-producer.sh最大的不同:
[mwopr@jtcrtvdra35 kafka_2.121.1.0]$ bin/kafka-verifiable-producer.sh  –broker-list 10.0.55.229:9092,10.0.55.229:9093,10.0.55.229:9094 –topic afei –max-messages 9
{“timestamp”:1530515959900,“name”:“startup_complete”}
{“timestamp”:1530515960310,“name”:“producer_send_success”,“key”:null,“value”:“1”,“offset”:5,“topic”:“afei”,“partition”:0}
{“timestamp”:1530515960315,“name”:“producer_send_success”,“key”:null,“value”:“4”,“offset”:6,“topic”:“afei”,“partition”:0}
{“timestamp”:1530515960315,“name”:“producer_send_success”,“key”:null,“value”:“7”,“offset”:7,“topic”:“afei”,“partition”:0}
{“timestamp”:1530515960316,“name”:“producer_send_success”,“key”:null,“value”:“0”,“offset”:5,“topic”:“afei”,“partition”:1}
{“timestamp”:1530515960316,“name”:“producer_send_success”,“key”:null,“value”:“3”,“offset”:6,“topic”:“afei”,“partition”:1}
{“timestamp”:1530515960316,“name”:“producer_send_success”,“key”:null,“value”:“6”,“offset”:7,“topic”:“afei”,“partition”:1}
{“timestamp”:1530515960316,“name”:“producer_send_success”,“key”:null,“value”:“2”,“offset”:6,“topic”:“afei”,“partition”:2}
{“timestamp”:1530515960316,“name”:“producer_send_success”,“key”:null,“value”:“5”,“offset”:7,“topic”:“afei”,“partition”:2}
{“timestamp”:1530515960316,“name”:“producer_send_success”,“key”:null,“value”:“8”,“offset”:8,“topic”:“afei”,“partition”:2}
{“timestamp”:1530515960333,“name”:“shutdown_complete”}
{“timestamp”:1530515960334,“name”:“tool_data”,“sent”:9,“acked”:9,“target_throughput”:-1,“avg_throughput”:20.689655172413794}
afei这个topic有3个分区,使用kafka-verifiable-producer.sh发送9条消息。根据输出结果可以看出,往每个分区发送了3条消息。另外,我们可以通过设置参数–max-messages一个比较大的值,可以压测一下搭建的kafka集群环境。
  • zookeeper-shell.sh
用法:bin/zookeeper-shell.sh  localhost:2181[/path],如果kafka集群的zk配置了chroot路径,那么需要加上/path,例如bin/zookeeper-shell.sh  localhost:2181/mykafka,登陆zk后,就可以查看kafka写在zk上的节点信息。例如查看有哪些broker,以及broker的详细信息:
ls /brokers/ids
[0]
get /brokers/ids/0
{“listener_security_protocol_map”:{“PLAINTEXT”:”PLAINTEXT”},”endpoints”:[“PLAINTEXT://izwz91rhzhed2c54e6yx87z:9092″],”jmx_port”:-1,”host”:”izwz91rhzhed2c54e6yx87z”,”timestamp”:”1530435834272″,”port”:9092,”version”:4}
cZxid = 0x2d3
ctime = Sun Jul 01 17:03:54 CST 2018
mZxid = 0x2d3
mtime = Sun Jul 01 17:03:54 CST 2018
pZxid = 0x2d3
cversion = 0
dataVersion = 0
aclVersion = 0
ephemeralOwner = 0x1642cb09421006c
dataLength = 216
numChildren = 0
  • 写在最后
上面的这些kafka运维脚本,有些是指定参数–zookeeper,有些是指定参数–broker-list,有些是指定参数–bootstrap-server。
这实际上是历史问题。broker-list代表broker地址,而bootstrap-server代表连接起点,可以从中拉取broker地址信息(前面的[4. kafka生产者&消费者]已经分析过)。bootstrap-server的命名更高级点。还有通过zookeeper连接的,kafka早起很多信息存方在zk中,后期慢慢弱化了zk的作用,这三个参数代表kafka的三个时代。往好的讲是见证kafka设计的理念变迁,往坏的讲:什么**玩意儿,绕的一笔(来自厮大大的解答),哈。


丨极客文库, 版权所有丨如未注明 , 均为原创丨
本网站采用知识共享署名-非商业性使用-相同方式共享 3.0 中国大陆许可协议进行授权
转载请注明原文链接:kafka入门教程(九)kafka shell脚本用法详解
喜欢 (0)
[247507792@qq.com]
分享 (0)
勤劳的小蚂蚁
关于作者:
温馨提示:本文来源于网络,转载文章皆标明了出处,如果您发现侵权文章,请及时向站长反馈删除。

您必须 登录 才能发表评论!

  • 精品技术教程
  • 编程资源分享
  • 问答交流社区
  • 极客文库知识库

客服QQ


QQ:2248886839


工作时间:09:00-23:00