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

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 0.99.2
• Component/s: metrics
• Hadoop Flags: Reviewed

Release Note

When you click on 'Metrics Dump', it takes you to the servlet at /jmx. This servlet dumps all metrics by name and their value. If you add a query string of '?description=true', the dump will include descriptions on all metric mbeans and attributes that are non-null and that do not have a description that matches the attribute name exactly.

• Assignee: Michael Stack
• Reporter: Michael Stack
• Created: 11/Nov/14 05:41
• Updated: 06/Apr/18 17:55
• Resolved: 11/Nov/14 21:17

Description

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.

Issue Links

• breaks: HBASE-12544 ops_mgt.xml missing in branch-1