You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@activemq.apache.org by "Lionel Cons (JIRA)" <ji...@apache.org> on 2017/08/02 12:17:09 UTC

[jira] [Commented] (ARTEMIS-1319) JMX operations should be documented

    [ https://issues.apache.org/jira/browse/ARTEMIS-1319?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16110772#comment-16110772 ] 

Lionel Cons commented on ARTEMIS-1319:
--------------------------------------

Note that some of the existing operation documentation is more useful than others.

Compare for instance ({{org.apache.activemq.artemis:broker="0.0.0.0",component=acceptors,name="hornetq"}}):
{code}
        Operations:
            void reload()                       "Re-create the acceptor with the existing configuration values. Useful, for example, for reloading key/trust stores on acceptors which support SSL."
            void stop()                         "stops this component"
            void start()                        "starts this component"
{code}

with ({{java.util.logging:type=Logging}}):
{code}
        Operations:
            void setLoggerLevel(java.lang.String p0,java.lang.String p1) "setLoggerLevel"
            java.lang.String getParentLoggerName(java.lang.String p0) "getParentLoggerName"
            java.lang.String getLoggerLevel(java.lang.String p0) "getLoggerLevel"
{code}


> JMX operations should be documented
> -----------------------------------
>
>                 Key: ARTEMIS-1319
>                 URL: https://issues.apache.org/jira/browse/ARTEMIS-1319
>             Project: ActiveMQ Artemis
>          Issue Type: Improvement
>            Reporter: Lionel Cons
>
> Similarly to ARTEMIS-405, JMX operations should be documented too.
> Using {{apache-artemis-2.3.0-20170801.204113-14-bin.tar.gz}}, I see:
> {code}
> $ jmx4perl http://localhost:8161/jolokia list | grep "Operation exposed for management"
>             java.util.List lookupAgentsWithTimeout(int p1) "Operation exposed for management"
>             java.util.List lookupAgents()       "Operation exposed for management"
>             java.lang.String mBeanServersInfo() "Operation exposed for management"
>             java.lang.String mBeanServersInfo() "Operation exposed for management"
>             java.lang.String debugInfo()        "Operation exposed for management"
>             void setHistoryLimitForOperation(java.lang.String p1,java.lang.String p2,java.lang.String p3,int p4,long p5) "Operation exposed for management"
>             void resetHistoryEntries()          "Operation exposed for management"
>             void setHistoryEntriesForOperation(java.lang.String p1,java.lang.String p2,java.lang.String p3,int p4) "Operation exposed for management"
>             void setHistoryLimitForAttribute(java.lang.String p1,java.lang.String p2,java.lang.String p3,java.lang.String p4,int p5,long p6) "Operation exposed for management"
>             void setHistoryEntriesForAttribute(java.lang.String p1,java.lang.String p2,java.lang.String p3,java.lang.String p4,int p5) "Operation exposed for management"
>             void resetDebugInfo()               "Operation exposed for management"
>             java.lang.String debugInfo()        "Operation exposed for management"
>             void setHistoryLimitForOperation(java.lang.String p1,java.lang.String p2,java.lang.String p3,int p4,long p5) "Operation exposed for management"
>             void resetHistoryEntries()          "Operation exposed for management"
>             void setHistoryEntriesForOperation(java.lang.String p1,java.lang.String p2,java.lang.String p3,int p4) "Operation exposed for management"
>             void setHistoryLimitForAttribute(java.lang.String p1,java.lang.String p2,java.lang.String p3,java.lang.String p4,int p5,long p6) "Operation exposed for management"
>             void setHistoryEntriesForAttribute(java.lang.String p1,java.lang.String p2,java.lang.String p3,java.lang.String p4,int p5) "Operation exposed for management"
>             void resetDebugInfo()               "Operation exposed for management"
>             java.lang.String debugInfo()        "Operation exposed for management"
>             void setHistoryLimitForOperation(java.lang.String p1,java.lang.String p2,java.lang.String p3,int p4,long p5) "Operation exposed for management"
>             void resetHistoryEntries()          "Operation exposed for management"
>             void setHistoryEntriesForOperation(java.lang.String p1,java.lang.String p2,java.lang.String p3,int p4) "Operation exposed for management"
>             void setHistoryLimitForAttribute(java.lang.String p1,java.lang.String p2,java.lang.String p3,java.lang.String p4,int p5,long p6) "Operation exposed for management"
>             void setHistoryEntriesForAttribute(java.lang.String p1,java.lang.String p2,java.lang.String p3,java.lang.String p4,int p5) "Operation exposed for management"
>             void resetDebugInfo()               "Operation exposed for management"
>             java.lang.String debugInfo()        "Operation exposed for management"
>             void setHistoryLimitForOperation(java.lang.String p1,java.lang.String p2,java.lang.String p3,int p4,long p5) "Operation exposed for management"
>             void resetHistoryEntries()          "Operation exposed for management"
>             void setHistoryEntriesForOperation(java.lang.String p1,java.lang.String p2,java.lang.String p3,int p4) "Operation exposed for management"
>             void setHistoryLimitForAttribute(java.lang.String p1,java.lang.String p2,java.lang.String p3,java.lang.String p4,int p5,long p6) "Operation exposed for management"
>             void setHistoryEntriesForAttribute(java.lang.String p1,java.lang.String p2,java.lang.String p3,java.lang.String p4,int p5) "Operation exposed for management"
>             void resetDebugInfo()               "Operation exposed for management"
>             java.util.Map list()                "Operation exposed for management"
>             boolean delete(java.lang.String p1,java.lang.String p2) "Operation exposed for management"
>             java.util.List list(java.lang.String p1) "Operation exposed for management"
>             boolean canInvoke(java.lang.String p1) "Operation exposed for management"
>             javax.management.openmbean.TabularData canInvoke(java.util.Map p1) "Operation exposed for management"
>             boolean canInvoke(java.lang.String p1,java.lang.String p2,[Ljava.lang.String; p3) "Operation exposed for management"
>             boolean canInvoke(java.lang.String p1,java.lang.String p2) "Operation exposed for management"
>             void updateSimpleTrigger(java.lang.String p1,java.lang.String p2,java.lang.String p3,int p4,int p5,long p6) "Operation exposed for management"
>             void updateCronTrigger(java.lang.String p1,java.lang.String p2,java.lang.String p3,int p4,java.lang.String p5,java.lang.String p6) "Operation exposed for management"
> {code}
> Could these be documented?
> Also, it would be nice to have a process in place to make sure all new operations get documented...



--
This message was sent by Atlassian JIRA
(v6.4.14#64029)