kafka-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "James Cheng (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (KAFKA-3480) Autogenerate metrics documentation
Date Sun, 03 Jul 2016 08:09:11 GMT

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

James Cheng commented on KAFKA-3480:
------------------------------------

[~hachikuji], I almost have this ready for code review. But, I'm afraid I may have pulled
a https://twitter.com/iamdevloper/status/397664295875805184. I generated metrics for ALL the
Java code. That includes producer, consumer, Kafka Connect, and Kafka Streams. It touched
53 files, and according to Github +1,527 −284 lines. Will this be impossible to code review?
Should I try to find a way to break it up?

Unfortunately, per our discussion before, there are classes that are shared between the producer/consumer
and even the broker, so some changes are going to affect multiple places. But I could definitely
slice it up into a series of smaller changes. It would, however, be a bunch of work to extract
them out from this large change.

I'm still finishing up the coding, but let me know if you think this change will be too large.
Especially considering it's my 1st (or 2nd) code contribution.


> Autogenerate metrics documentation
> ----------------------------------
>
>                 Key: KAFKA-3480
>                 URL: https://issues.apache.org/jira/browse/KAFKA-3480
>             Project: Kafka
>          Issue Type: Improvement
>            Reporter: Jason Gustafson
>            Assignee: James Cheng
>         Attachments: Screen Shot 2016-04-07 at 6.52.19 PM.png, sample_metrics.html
>
>
> 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)

Mime
View raw message