[jira] [Updated] (HBASE-12455) Add 'description' to bean and attribute output when you do /jmx?description=true

["stack (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/HBASE-12455?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

stack updated HBASE-12455:
--------------------------
    Attachment: 12455.txt

I tried to make it so if you added a '?description=true' param on your /jmx query, then we'd print out descriptions. Unfortunately it will take more work than I've done here.

Here is it working:

{code}
...
    "name" : "regionCount",
    "description" : "Number of regions",
    "value" : 2,
    "name" : "storeCount",
    "description" : "Number of Stores",
    "value" : 2,
    "name" : "hlogFileCount",
    "description" : "Number of HLog Files",
    "value" : 2,
    "name" : "hlogFileSize",
    "description" : "Size of all HLog Files",
    "value" : 0,
    "name" : "storeFileCount",
    "description" : "Number of Store Files",
    "value" : 2,
    "name" : "memStoreSize",
    "description" : "Size of the memstore",
    "value" : 26880,
    "name" : "storeFileSize",
    "description" : "Size of storefiles being served.",
    "value" : 14415,
    "name" : "regionServerStartTime",
    "description" : "RegionServer Start Time",
    "value" : 1415683550907,
    "name" : "totalRequestCount",
    "description" : "Total number of requests this RegionServer has answered.",
    "value" : 53,
    "name" : "readRequestCount",
    "description" : "Number of read requests this region server has answered.",
    "value" : 13,
    "name" : "writeRequestCount",
    "description" : "Number of mutation requests this region server has answered.",
    "value" : 42,
    "name" : "checkMutateFailedCount",
    "description" : "Number of Check and Mutate calls that failed the checks.",
    "value" : 0,
    "name" : "checkMutatePassedCount",
    "description" : "Number of Check and Mutate calls that passed the checks.",
    "value" : 0,
    "name" : "storeFileIndexSize",
    "description" : "Size of indexes in storefiles on disk.",
    "value" : 848,
...
{code}

But it then goes off the rails when beans and/or attributes are without description:

{code}
...
    "name" : "java.lang:type=MemoryPool,name=CMS Old Gen",
    "description" : "Information on the management interface of the MBean",
    "modelerType" : "sun.management.MemoryPoolImpl",
    "name" : "Name",
    "description" : "Name",
    "value" : "CMS Old Gen",
    "name" : "Type",
    "description" : "Type",
    "value" : "HEAP",
    "name" : "Valid",
    "description" : "Valid",
    "value" : true,
    "name" : "Usage",
    "description" : "Usage",
    "value" : {
    },
    "name" : "PeakUsage",
    "description" : "PeakUsage",
    "value" : {
    },
    "name" : "MemoryManagerNames",
    "description" : "MemoryManagerNames",
    "value" : [ "ConcurrentMarkSweep" ],
    "name" : "UsageThreshold",
    "description" : "UsageThreshold",
    "value" : 0,
...
{code}



> Add 'description' to bean and attribute output when you do /jmx?description=true
> --------------------------------------------------------------------------------
>
>                 Key: HBASE-12455
>                 URL: https://issues.apache.org/jira/browse/HBASE-12455
>             Project: HBase
>          Issue Type: Improvement
>          Components: metrics
>            Reporter: stack
>         Attachments: 12455.txt
>
>
> Its hard figuring what our metrics mean. Each attribute and bean actually has a description but its hard to get at. In mission control, etc., you have to click on each attribute to see the description. Its painful.  Because the description is rarely read, they are not as info-full as they could be.
> If you do /jmx in the UI, you get a dump of all beans associated with the server but its just the attribute/bean name + value. The description is there but its not displayed. We should give option to display descriptions. It would be good for those exploring what metrics are available.  We actually point folks at jvisualvm in the refguide to figure what metrics are available.  Would be useful if we could point them at something that was easier to navigate.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)