You are viewing a plain text version of this content. The canonical link for it is here.

Posted to dev@kafka.apache.org by "Gwen Shapira (JIRA)" <ji...@apache.org> on 2016/04/01 22:54:25 UTC

[jira] [Commented] (KAFKA-3480) Autogenerate metrics documentation

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

Gwen Shapira commented on KAFKA-3480:
-------------------------------------

>From what I've seen, the new KafkaMetrics have a doc string already, so maybe it will be really easy to generate docs.

Yammer are already documented and we are not adding new ones, so maybe just add auto-generate metric docs through KafkaMetrics, and leave the existing metric docs in place?

> Autogenerate metrics documentation
> ----------------------------------
>
>                 Key: KAFKA-3480
>                 URL: https://issues.apache.org/jira/browse/KAFKA-3480
>             Project: Kafka
>          Issue Type: Improvement
>            Reporter: Jason Gustafson
>
> Metrics documentation is done manually, which means it's hard to keep it current. It would be nice to have automatic generation of this documentation as we have for configs.



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