[ARTEMIS-405] JMX attributes should be documented

• Type: Improvement
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 1.2.0
• Fix Version/s: 1.3.0, 1.4.0
• Assignee: Justin Bertram
• Reporter: Lionel Cons
• Created: 19/Feb/16 06:12
• Updated: 03/Aug/17 15:41
• Resolved: 03/Aug/17 15:41

Description

Using Jolokia, it is very easy to list all the attributes exposed by Artemis:

$ jmx4perl http://localhost:8161/jolokia/ list 'org.apache.activemq.artemis:brokerName="0.0.0.0",module=JMS,name="DLQ",serviceType=Queue,type=Broker' 
org.apache.activemq.artemis:brokerName="0.0.0.0",module=JMS,name="DLQ",serviceType=Queue,type=Broker: 
===================================================================================================== 

Attributes: 
    Name                                java.lang.String [ro], "Attribute exposed for management" 
    ExpiryAddress                       java.lang.String [ro], "Attribute exposed for management" 
    RegistryBindings                    [Ljava.lang.String; [ro], "Attribute exposed for management" 
    DeliveringCount                     int [ro], "Attribute exposed for management" 
    Address                             java.lang.String [ro], "Attribute exposed for management" 
    Selector                            java.lang.String [ro], "Attribute exposed for management" 
    ScheduledCount                      long [ro], "Attribute exposed for management" 
    MessageCount                        long [ro], "Attribute exposed for management" 
    Paused                              boolean [ro], "Attribute exposed for management" 
    DeadLetterAddress                   java.lang.String [ro], "Attribute exposed for management" 
    FirstMessageTimestamp               java.lang.Long [ro], "Attribute exposed for management" 
    ConsumerCount                       int [ro], "Attribute exposed for management" 
    MessagesAdded                       long [ro], "Attribute exposed for management" 
    FirstMessageAge                     java.lang.Long [ro], "Attribute exposed for management" 
    Temporary                           boolean [ro], "Attribute exposed for management" 
    FirstMessageAsJSON                  java.lang.String [ro], "Attribute exposed for management" 
Operations: 
    int retryMessages()                 "Retry all messages on a DLQ to their respective original queues" 
    java.lang.String listMessageCounterHistory() "List the message counters history" 
    java.lang.String listMessageCounterHistoryAsHTML() "List the message counters history as HTML" 
    java.util.Map listDeliveringMessages() "List all messages being delivered per consumer" 
[...] 

As you see, the operations are documented but not the attributes. They should be.

Issue Links

• is related to: ARTEMIS-1319 JMX operations should be documented
• links to: GitHub Pull Request #651
• links to: GitHub Pull Request #678