[
https://issues.apache.org/jira/browse/CASSANDRA-13145?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Chris Lohfink resolved CASSANDRA-13145.
---------------------------------------
Resolution: Won't Fix
Metrics documented well with the markdown and apache.org doc generation.
> Include documentation in metric registration
> --------------------------------------------
>
> Key: CASSANDRA-13145
> URL: https://issues.apache.org/jira/browse/CASSANDRA-13145
> Project: Cassandra
> Issue Type: Improvement
> Reporter: Chris Lohfink
> Assignee: Chris Lohfink
> Priority: Major
>
> If we include the description of the metrics in the declaration in code we
> can expose it in JMX mbeans (and other reporters) which will greatly increase
> accuracy in operational tooling. The metrics can sometimes be a little vague
> and are often misunderstood.
> Metric descriptions are currently hand kept between different definitions and
> versions (ie apache docs, graphite reporter definitions, agent configs). They
> quickly get stale and can be described incorrectly.
> Id like to purpose a patch that does the initial work of porting all the
> descriptions into the declaration so that going forward to register a metric
> developers must define a more friendly description. Future work may be
> automatic generation of apache doc from the descriptions.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@cassandra.apache.org
For additional commands, e-mail: commits-h...@cassandra.apache.org
