/artemis-manager

Command line tool to manage Artemis queues

Primary LanguageJava

Artemis Manager

Build Status Coverage Status

Configuration

Configuration can be supplied in a config file and passed to the application via a '@<config_file_path>' option.

  • -jmxUrl: The full JMX url, can be used multiple times for clusters. (default: service:jmx:rmi:///jndi/rmi://localhost:1099/jmxrmi)
  • -brokerName: Name of the broker (default: "default")
  • -jmxUsername: User for JMX (default none)
  • -jmxPassword: Password for JMX (default none)
  • -jmsUrl: The JMS url, you should add the clientID as above. You can also add sslEnabled=true to get SSL capability (default: tcp://localhost:61616?clientID=artemis-manager)
  • -jmsUsername: User for JMS (default none)
  • -jmsPassword: Password for JMS (default none)

A complicated example configuration file might look like:

Assuming two brokers on 192.168.0.10 and 192.168.0.11, with JMX on 1098 and OpenWire on 61616 (but no security)

-jmxUrl
service:jmx:rmi:///jndi/rmi://192.168.0.10:1098/jmxrmi
-jmxUrl
service:jmx:rmi:///jndi/rmi://192.168.0.11:1098/jmxrmi
-jmsUrl
tcp://(192.168.0.10:61616,192.168.0.11:61616)?clientID=artemis-manager&sslEnabled=true

In the examples below it is assumed a configuration file of artemis.config has been created like that shown above

Browse DLQ

Note: Browse uses JMS to connect to the Artemis broker.

java -jar artemis-manager.jar browse @artemis.config

List Queues

Note: ListQueues uses JMS to connect to the Artemis broker.

java -jar artemis-manager.jar listqueues @artemis.config

List Topics

Note: ListTopics uses JMS to connect to the Artemis broker.

java -jar artemis-manager.jar listtopics @artemis.config

Remove Message from DLQ

  • Remove message by id

Note: Remove uses JMX to connect to the Artemis broker.

java -jar artemis-manager.jar remove @artemis.config -msgId 12d8e63e-c842-11e6-986d-00e1000074d2

  • Remove multiple messages (provide list of message ids on input)

echo msgId1 msgId2 | java -jar artemis-manager.jar remove

Remove All Duplicate Messages from DLQ

  • Remove all duplicate messages

This checks the DLQ to find any duplicate messages and will remove the duplicate messages from the DLQ leaving a single message on the DLQ.

Only messages that have the same JMSMessageId and Consumer (_AMQ_ORIG_QUEUE) will be removed. Thus any duplicate Topic messages which should go to different consumers will not be deleted.

Note: Browse uses JMS to connect to the Artemis broker.

java -jar artemis-manager.jar removeallduplicates @artemis.config

Deduplicate Topic Messages from DLQ

  • Deduplicate topic messages

This checks the DLQ to find any duplicate Topic messages and will remove the duplicate messages from the DLQ. Then it re-sends the duplicates to the DLQ, so that a unique JMSMessageId is created for each message. The messages can then be replayed or removed individually.

Only messages that have the same JMSMessageId and different Consumer (_AMQ_ORIG_QUEUE) will be removed.

Note: Browse uses JMS to connect to the Artemis broker.

java -jar artemis-manager.jar deduplicatetopicmessages @artemis.config

Reprocess Message from DLQ

  • Reprocess message by id

Note: Reprocess uses JMX port to connect to the Artemis broker.

java -jar artemis-manager.jar reprocess @artemis.config -msgId 12d8e63e-c842-11e6-986d-00e1000074d2

  • Reprocess multiple messages (provide list of message ids on input)

echo msgId1 msgId2 | java -jar artemis-manager.jar reprocess @artemis.config

Reprocess All Messages from DLQ

  • Reprocess all message on DLQ

This command will reprocess ALL messages on the DLQ

Note: ReprocessAll uses JMX port to connect to the Artemis broker.

java -jar artemis-manager.jar reprocessall @artemis.config

Reports on DLQ

  • Generate report on the contents of the DLQ. There are three different reports available.

Note: Report uses JMS to connect to the Artemis broker.

java -jar artemis-manager.jar browse @artemis.config -report totals-by-name-report

java -jar artemis-manager.jar browse @artemis.config -report names-by-original-destination-report

java -jar artemis-manager.jar browse @artemis.config -report created-at-name-total-report

Send a Text Message to the DLQ

  • Sends a text message to the DLQ. The message must be contained in a text file, the path of which must be included in the command

Note: SendMessage uses JMS to connect to the Artemis broker.

java -jar artemis-manager.jar sendmessage -messageFile path/to/some/text/file/containing/the/message.txt @artemis.config

Warning. In order to have the correct permissions to run this command, you will need to update your broker.xml file in your Artemis configuration. This will disable your security

Add these 2 lines to broker.xml directly under the

    <security-settings/>

tag

  <security-enabled>false</security-enabled>
  <populate-validated-user>true</populate-validated-user>

For an example, look at src/test/resources/artemis/broker.xml

Chaining Commands

  • Chaining commands

This will remove all messages from DLQ that have been originally sent to the queue abracadabra

java -jar target/artemis-manager.jar browse @artemis.config |\
 jgrep originalDestination=jms.queue.abracadabra -s msgId |\
 java -jar target/artemis-manager.jar remove @artemis.config