rocketmq控制台指令

1、1.1.  控制台使用RocketMQ提供有控制台及一系列控制台命令，用于管理员对主题，集群，broker等信息的管理；l  登录控制台：首先进入RocketMQ工程，进入/RocketMQ/bin在该目录下有个mqadmin脚本l  查看帮助：在mqadmin下可以查看有哪些命令              shmqadminl  查看具体命令的使用sh mqadmin help 命令名称例如，查看updateTopic的使用

2、sh mqadmin helpupdateTopic1.2.  详细命令1.2.1.          创建Topic指令updateTopic类路径mand.topic.UpdateTopicSubCommand参数是否必填说明-b如果 -c为空，则必填broker地址，表示topic建在该broker-c如果 -b为空，则必填cluster名称，表示topic建在该集群（集群可通过clusterList查询）-h否打印帮助-n是nameserve服务地址列表，格式ip:port;i

3、p:port;.-p否指定新topic的权限限制( W|R|WR )-r否可读队列数（默认为8）-w否可写队列数（默认为8）-t是topic名称（名称只能使用字符 a-zA-Z0-9_-+$ ）举例在集群DefaultCluster上创建主题ZTEExample，nameserve地址为68:9876sh mqadmin updateTopic n 68 c DefaultCluster t ZTEExample 1.2.2.          

4、删除Topic指令deleteTopic类路径mand.topic.DeleteTopicSubCommand参数是否必填说明-c是cluster名称，表示删除某集群下的某个topic （集群可通过clusterList查询）-h否打印帮助-n是nameserve服务地址列表，格式ip:port;ip:port;-t是topic名称（名称只能使用字符 a-zA-Z0-9_-+$ ）举例在集群DefaultCluster上删除主题ZTEExample，nameserve地址为68:9876sh mqadmin deleteTopic n 68:9876 c

5、 DefaultCluster t ZTEExample 1.2.3.         创建（修订）订阅组指令updateSubGroup类路径mand.consumer.UpdateSubGroupSubCommand参数是否必填说明-b如果 c为空，则必填broker地址，表示订阅组建在该broker-c如果 b为空，则必填cluster名称，表示topic建在该集群（集群可通过clusterList查询）-d否是否容许广播方式消费-g是订阅组名-i否从哪个broker开始消费-m否是否容许

6、从队列的最小位置开始消费，默认会设置为false-q否消费失败的消息放到一个重试队列，每个订阅组配置几个重试队列-r否重试消费最大次数，超过则投递到死信队列，不再投递，并报警-s否消费功能是否开启-w否发现消息堆积后，将Consumer的消费请求重定向到另外一台Slave机器-h否打印帮助-n是nameserve服务地址列表，格式ip:port;ip:port;.举例   1.2.4.         删除订阅组配置指令deleteSubGroup类路径mand.consum

7、er.DeleteSubscriptionGroupCommand参数是否必填说明-b如果 c为空，则必填broker地址，表示订阅组建在该broker-c如果 b为空，则必填cluster名称，表示topic建在该集群（集群可通过clusterList查询）-g是订阅组名-h否打印帮助-n是nameserve服务地址列表，格式ip:port;ip:port;.举例   1.2.5.         更新Broker配置文件指令updateBrokerConfig类路径man

8、d.broker.UpdateBrokerConfigSubCommand参数是否必填说明-b如果 c为空，则必填broker地址，表示订阅组建在该broker-c如果 b为空，则必填cluster名称，表示topic建在该集群（集群可通过clusterList查询）-k是key值-v否value值-h否打印帮助-n是nameserve服务地址列表，格式ip:port;ip:port;.举例   1.2.6.         查看Topic列表信息指令topicList类路径

9、mand.broker.UpdateBrokerConfigSubCommand参数是否必填说明-h否打印帮助-n是nameserve服务地址列表，格式ip:port;ip:port;.举例nameserve地址为68:9876sh mqadmin topicList n 68:9876打印内容：BenchmarkTest%RETRY%simple-consumer-testSELF_TEST_TOPICZTEExample注释：上述头三个主题是RocketMQ默认预先创建 1.2.7.     

10、;    查看Topic路由信息指令topicRoute类路径mand.topic.TopicRouteSubCommand参数是否必填说明-t是topic名称-h否打印帮助-n是nameserve服务地址列表，格式ip:port;ip:port;.举例查看主题ZTEExample的路由，nameserve地址为68:9876sh mqadmin topicRoute n 68:9876 t ZTEExample_Crm打印内容：       

11、"brokerDatas":                "brokerAddrs":0:"68:10911"                ,      &

12、#160;         "brokerName":"crmdb"        ,        "queueDatas":                "

13、;brokerName":"crmdb",                "perm":6,                "readQueueNums":8,      

14、;          "writeQueueNums":8         1.2.8.         查看Topic统计信息指令topicStats类路径mand.topic.TopicStatsSubCommand参数是否必填说明-t是topic名称-h否打印帮助-n是nameserve服务地址列表，格式ip:p

15、ort;ip:port;.举例查看主题ZTEExample的统计信息，nameserve地址为68:9876sh mqadmin topicStats n 68:9876 t ZTEExample打印内容：（统计信息里包括有offset、最后更新时间）#Broker Name  #QID  #Min Offset  #Max Offset   #Last Updatedcrmdb         0  &#

16、160;  0            1             2014-02-10 11:37:44,977crmdb         1     0       &

17、#160;    0            crmdb         2     0            0         

18、   crmdb         3     0            0            crmdb         4 

19、    0            0            crmdb         5     0          

20、;  0            crmdb         6     0            0           

21、0;crmdb         7     0            0       1.2.9.         查看Broker统计信息指令brokerStats类路径mand.broker.BrokerS

22、tatsSubCommand参数是否必填说明-b是broker地址-h否打印帮助-n是nameserve服务地址列表，格式ip:port;ip:port;.举例查看broker(crmdb)的统计信息，broker地址为68:10911,nameserve地址为68:9876sh mqadmin brokerStats n 68:9876 b 68:10911打印内容：bootTimestamp          &

23、#160;        : 1392003367470brokerVersion                   : 29brokerVersionDesc               : V3_0_7c

24、ommitLogDiskRatio              : 0.32690830974763857commitLogMaxOffset              : 217commitLogMinOffset          

25、60;   : 0consumeQueueDiskRatio           : 0.32690830974763857dispatchMaxBuffer               : 1getFoundTps           &

26、#160;         : 0.0 0.0 0.0getMessageEntireTimeMax         : 4getMissTps                      : 0.0 0.0 0.0get

27、TotalTps                     : 0.0 0.0 0.0getTransferedTps                : 0.0 0.0 0.0msgGetTotalTodayMorning  

28、60;      : 0msgGetTotalTodayNow             : 1msgGetTotalYesterdayMorning     : 0msgPutTotalTodayMorning         : 0msgPutTotalTodayNow   &

29、#160;         : 1msgPutTotalYesterdayMorning     : 0putMessageAverageSize           : 217.0putMessageDistributeTime        :     &

30、#160;          0(0.0%)                1(100.0%)                0(0.0%)      

31、;          0(0.0%)                0(0.0%)                0(0.0%)       

32、;         0(0.0%)putMessageEntireTimeMax         : 6putMessageSizeTotal             : 217putMessageTimesTotal        

33、60;   : 1putTps                          : 0.0 0.0 0.0runtime                 &#

34、160;       : 0 days, 3 hours, 21 minutes, 1 seconds sendThreadPoolQueueCapacity     : 100000sendThreadPoolQueueSize         : 0  1.2.10.     根据消息ID查询消息指令queryMsgById类路径mand.me

35、ssage.QueryMsgByIdSubCommand参数是否必填说明-i是msgId-h否打印帮助-n是nameserve服务地址列表，格式ip:port;ip:port;.举例查询msgId= 0A2D2FA800002A9F0000000000000000的消息，nameserve地址为68:9876sh mqadmin queryMsgById n 68:9876 i 0A2D2FA800002A9F0000000000000000打印内容:Topic:       

36、0;       ZTEExampleTags:                SimpleTestKeys:                SimpleTest-1Queue ID:    

37、0;       0Queue Offset:        0CommitLog Offset:    0Born Timestamp:      2014-02-26 14:49:10,875Store Timestamp:     2014-02-26 14:48:44,840Born Host:    

38、;       29:4231Store Host:          68:10911System Flag:         0Properties:          TAGS=SimpleTest, KEYS=SimpleTest-

39、1, WAIT=trueMessage Body Path:   /tmp/rocketmq/msgbodys/0A2D2FA800002A9F0000000000000000 1.2.11.     根据消息Key查询消息指令queryMsgByKey类路径mand.message.QueryMsgByKeySubCommand参数是否必填说明-f否被查询消息的截止时间-k是msgKey-t是Topic名称-h否打印帮助-n是nameserve服务地址列表，格式ip:port;ip:port;.举例查询Topic

40、= ZTEExample下key= SimpleTest-1的消息，nameserve地址为68:9876sh mqadmin queryMsgByKey -n 68:9876 -t ZTEExample -k SimpleTest-1打印内容:#Message ID                        &#

41、160;               #QID  #Offset0A2D2FA800002A9F0000000000000000                   0    01.2.12.    

42、 根据Offset查询消息指令queryMsgByOffset类路径mand.message.QueryMsgByOffsetSubCommand参数是否必填说明-b是Broker名称，表示订阅组建在该broker（这里需要注意填写的是broker的名称，不是broker的地址，broker名称可以在clusterList查到）-i是query队列id-o是offset值-t是topic名称-h否打印帮助-n是nameserve服务地址列表，格式ip:port;ip:port;.举例查询brokerName=crm-168，Topic= ZTEExample的第1个队列下offset

43、=0的消息，nameserve地址为68:9876sh mqadmin queryMsgByOffset -n 68:9876 -b crm-168 -i 0 -t ZTEExample -o 0打印内容:Topic:               ZTEExampleTags:            

44、;    SimpleTestKeys:                SimpleTest-1Queue ID:            0Queue Offset:        0CommitLog Offset:  

45、;  0Born Timestamp:      2014-02-26 14:49:10,875Store Timestamp:     2014-02-26 14:48:44,840Born Host:           29:4231Store Host:          10.4

46、5.47.168:10911System Flag:         0Properties:          TAGS=SimpleTest, KEYS=SimpleTest-1, WAIT=trueMessage Body Path:   /tmp/rocketmq/msgbodys/0A2D2FA800002A9F0000000000000000 1.2.13.  &#

47、160;  查询Producer的网络连接l  该命令只打印当前与cluster连接的producer网络连接信息指令producerConnection类路径mand.connection.ProducerConnectionSubCommand参数是否必填说明-g是生产者所属组名-t是topic名称-h否打印帮助-n是nameserve服务地址列表，格式ip:port;ip:port;.举例查询当前属于group（生产者组）=simple-producer-test的生产者到topic=ZTEExample的网络连接，nameserve地址为10.45.47.

48、168:9876sh mqadmin producerConnection -n 68:9876 -g simple-producer-test -t ZTEExample打印内容:0001 29simple-producer-test-99f09de2a20a4b6284bb949b452bee0c 29:4332   Java  V3_0_7 1.2.14.     查询Consumer的网络连接l  该命令只打印当前与c

49、luster连接的consumer网络连接信息指令consumerConnection类路径mand.connection.ConsumerConnectionSubCommand参数是否必填说明-g是消费者所属组名-h否打印帮助-n是nameserve服务地址列表，格式ip:port;ip:port;.举例查询当前属于group（消费者组）=simple-consumer-test的消费者的网络连接，nameserve地址为68:9876sh mqadmin consumerConnection -n 68:9876 -g simple-consume

50、r-test打印内容:001  29simple-consumer-test-7babbb6021b040d29978494b16d559ae 29:4355      JAVA     V3_0_7 Below is subscription:001  Topic: ZTEExample            

51、60;                  SubExpression: * ConsumeType: CONSUME_ACTIVELYMessageModel: CLUSTERINGConsumeFromWhere: CONSUME_FROM_LAST_OFFSET 1.2.15.     查看订阅组消费状态指令consumerProgress类路径mand

52、.consumer.ConsumerProgressSubCommand参数是否必填说明-g是消费者所属组名-h否打印帮助-n是nameserve服务地址列表，格式ip:port;ip:port;.举例查询当前属于group（消费者组）=simple-consumer-test的订阅状态，nameserve地址为68:9876sh mqadmin consumerProgress -n 68:9876 -g simple-consumer-test打印内容:#Topic       &

53、#160; #Broker Name    #QID  #Broker Offset        #Consumer Offset      #DiffZTEExample     crm-168         0     2    &

54、#160;                2                     0ZTEExample     crm-168      

55、60;  1     0                     0                     0ZTEExample 

56、60;   crm-168         2     0                     0             &

57、#160;       0ZTEExample     crm-168         3     0                     0   

58、;                  0ZTEExample     crm-168         4     0             

59、;        0                     0ZTEExample     crm-168         5     0  

60、60;                  0                     0ZTEExample     crm-168     

61、;    6     0                     0                     0ZTEExampl

62、e     crm-168         7     0                     0           

63、60;         0 Consume TPS: 0Diff Total: 0 1.2.16.     查看集群消息指令clusterList类路径mand.cluster.ClusterListSubCommand参数是否必填说明-m否打印更多信息 (增加打印出如下信息 #InTotalYest,   #OutTotalYest, #InTotalToday ,#OutTotalToday)-h否打印帮助-n是names

64、erve服务地址列表，格式ip:port;ip:port;.举例查询当前集群状态，nameserve地址为68:9876sh mqadmin clusterList -n 68:9876打印内容:#Cluster Name  #Broker Name  #BID  #Addr               #Version   #InTPS  

65、60;  #OutTPSCRM            crm-168       0     68:10911  V3_0_7       0.00        0.00CRM   

66、60;        crm-181       0     81:10911  V3_0_7       0.00        0.00 sh mqadmin clusterList -n 68:9876 m#Cluster Name

67、   #Broker Name  #InTotalYest  #OutTotalYest  #InTotalToday   #OutTotalTodayCRM           crm-168                 0  

68、60;          0              2              3CRM           crm-181 

69、0;               0             0              0         

70、0;    01.2.17.     添加（更新）KV配置信息指令updateKvConfig类路径srv.UpdateKvConfigCommand参数是否必填说明-k是key值-v是value值-s是Namespace值-h否打印帮助-n是nameserve服务地址列表，格式ip:port;ip:port;.举例   1.2.18.     删除KV配置信息指令deleteKvConfig类路径s

71、rv.DeleteKvConfigCommand参数是否必填说明-k是key值-s是Namespace值-h否打印帮助-n是nameserve服务地址列表，格式ip:port;ip:port;.举例   1.2.19.     添加（更新）Project group配置信息指令updateProjectGroup类路径srv.UpdateProjectGroupCommand参数是否必填说明-i是服务器ip-p是project group名-h否打印帮助-n是nameserve服务地址列表，格式i

72、p:port;ip:port;.举例   1.2.20.     删除Projectgroup配置信息指令deleteProjectGroup类路径srv.DeleteProjectGroupCommand参数是否必填说明-i是服务器ip-p是project group名-h否打印帮助-n是nameserve服务地址列表，格式ip:port;ip:port;.举例  1.2.21.     取得Projectgroup配置信息指

73、令getProjectGroup类路径srv.GetProjectGroupCommand参数是否必填说明-i是服务器ip-p是project group名-h否打印帮助-n是nameserve服务地址列表，格式ip:port;ip:port;.举例   1.2.22.     设置消费进度l  根据时间来设置消费进度，设置之前要关闭这个订阅组的所有consumer，设置完再启动，方可生效指令resetOffsetByTime类路径mand.offset.ResetOffsetByTim

74、eSubCommand参数是否必填说明-f否通过时间戳强制回滚（true|false），默认为true-s是时间戳（currentTimeMillis|yyyy-MM-dd#HH:mm:ss:SSS）-g是消费者所属组名-t是topic名称-h否打印帮助-n是nameserve服务地址列表，格式ip:port;ip:port;.举例   1.2.23.     清除特定Broker权限指令wipeWritePerm类路径srv.WipeWritePermSubCommand参数是否必填说明-b是b

75、roker地址-h否打印帮助-n是nameserve服务地址列表，格式ip:port;ip:port;.举例   1.2.24.     获取Consumer消费进度l  该命令只打印当前与cluster连接的consumer的消费进度指令getConsumerStatus类路径mand.offset.GetConsumerStatusCommand参数是否必填说明-g是消费者所属组名-t是查询主题-i否Consumer客户端ip-h否打印帮助-n是nameserve服务地址列表，格式ip:port;ip

76、:port;.举例查询属于group（消费者组）=simple-consumer-test的消费者在Topic=ZTEExample上的消费状态，nameserve地址为68:9876sh mqadmin getConsumerStatus -n 68:9876 -g simple-consumer-test -t ZTEExampleget consumer status from client. group=simple-consumer-test, topic=ZTEExample, originClientId=#clientId