You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jira@kafka.apache.org by "ukpagrace (via GitHub)" <gi...@apache.org> on 2025/01/22 18:10:36 UTC
[PR] KAFKA-18572: Update Kafka Streams metric documenation [kafka]
ukpagrace opened a new pull request, #18673:
URL: https://github.com/apache/kafka/pull/18673
Updated the Kafka Streams documentation to include metrics for tasks, process nodes, and threads that were missing. I was unable to find metrics such as stream-state-metrics, client-metrics, state-store-metrics, and record-cache-metrics in the codebase, so they are not included in this update.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] KAFKA-18572: Update Kafka Streams metric documenation [kafka]
Posted by "ukpagrace (via GitHub)" <gi...@apache.org>.
ukpagrace commented on PR #18673:
URL: https://github.com/apache/kafka/pull/18673#issuecomment-2798439485
Done @mjsax and @bbejeck. Sorry it took this long.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] KAFKA-18572: Update Kafka Streams metric documenation [kafka]
Posted by "bbejeck (via GitHub)" <gi...@apache.org>.
bbejeck merged PR #18673:
URL: https://github.com/apache/kafka/pull/18673
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] KAFKA-18572: Update Kafka Streams metric documenation [kafka]
Posted by "bbejeck (via GitHub)" <gi...@apache.org>.
bbejeck commented on PR #18673:
URL: https://github.com/apache/kafka/pull/18673#issuecomment-2698400423
ping @ukpagrace - are you still able to work on this?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] KAFKA-18572: Update Kafka Streams metric documenation [kafka]
Posted by "bbejeck (via GitHub)" <gi...@apache.org>.
bbejeck commented on code in PR #18673:
URL: https://github.com/apache/kafka/pull/18673#discussion_r1962348788
##########
docs/ops.html:
##########
@@ -2888,6 +2898,21 @@ <h5 class="anchor-heading"><a id="kafka_streams_thread_monitoring" class="anchor
<td>The total number of consumer poll calls.</td>
<td>kafka.streams:type=stream-thread-metrics,thread-id=([-.\w]+)</td>
</tr>
+ <tr>
+ <td>poll-records-avg</td>
+ <td>The average number of records polled from consumer within an iteration.</td>
+ <td>kafka.streams:type=stream-thread-metrics,thread-id=([-.\w]+)</td>
+ </tr>
+ <tr>
+ <td>poll-records-max</td>
+ <td>The maximum number of records polled from consumer within an iteration.</td>
+ <td>kafka.streams:type=stream-thread-metrics,thread-id=([-.\w]+)</td>
+ </tr>
+ <tr>
+ <td>process-ratio</td>
+ <td>The fraction of time the thread spent on processing active tasks</td>
+ <td>kafka.consumer:type=consumer-coordinator-metrics,client-id=([-.\w]+)</td>
Review Comment:
I think this should be `kafka.streams` and type `stream-thread-metrics`
##########
docs/ops.html:
##########
@@ -2898,6 +2923,21 @@ <h5 class="anchor-heading"><a id="kafka_streams_thread_monitoring" class="anchor
<td>The total number of processed records.</td>
<td>kafka.streams:type=stream-thread-metrics,thread-id=([-.\w]+)</td>
</tr>
+ <tr>
+ <td>process-records-avg</td>
+ <td>The average number of records processed within an iteration (total count of processed records over total number of iterations).</td>
+ <td>kafka.streams:type=stream-thread-metrics,thread-id=([-.\w]+)</td>
+ </tr>
+ <tr>
+ <td>process-records-max</td>
+ <td>The maximum number of records processed within an iteration.</td>
+ <td>kafka.streams:type=stream-thread-metrics,thread-id=([-.\w]+)</td>
+ </tr>
+ <tr>
+ <td>punctuate-ratio</td>
+ <td>"The fraction of time the thread spends performing punctuating actions on active tasks"</td>
Review Comment:
```suggestion
<td>The fraction of time the thread spends performing punctuating actions on active tasks</td>
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] KAFKA-18572: Update Kafka Streams metric documenation [kafka]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #18673:
URL: https://github.com/apache/kafka/pull/18673#issuecomment-2638723600
A label of 'needs-attention' was automatically added to this PR in order to raise the
attention of the committers. Once this issue has been triaged, the `triage` label
should be removed to prevent this automation from happening again.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] KAFKA-18572: Update Kafka Streams metric documenation [kafka]
Posted by "bbejeck (via GitHub)" <gi...@apache.org>.
bbejeck commented on PR #18673:
URL: https://github.com/apache/kafka/pull/18673#issuecomment-2822420681
merged #18673 into trunk
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] KAFKA-18572: Update Kafka Streams metric documenation [kafka]
Posted by "ukpagrace (via GitHub)" <gi...@apache.org>.
ukpagrace commented on PR #18673:
URL: https://github.com/apache/kafka/pull/18673#issuecomment-2645509003
> Did not forget about it. Just no time yet.
Thanks for the update, Matthias. If someone else can review it, let me know who to reach out to.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] KAFKA-18572: Update Kafka Streams metric documenation [kafka]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #18673:
URL: https://github.com/apache/kafka/pull/18673#issuecomment-2628732355
A label of 'needs-attention' was automatically added to this PR in order to raise the
attention of the committers. Once this issue has been triaged, the `triage` label
should be removed to prevent this automation from happening again.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] KAFKA-18572: Update Kafka Streams metric documenation [kafka]
Posted by "mjsax (via GitHub)" <gi...@apache.org>.
mjsax commented on PR #18673:
URL: https://github.com/apache/kafka/pull/18673#issuecomment-2635582260
Did not forget about it. Just no time yet.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] KAFKA-18572: Update Kafka Streams metric documenation [kafka]
Posted by "ukpagrace (via GitHub)" <gi...@apache.org>.
ukpagrace commented on PR #18673:
URL: https://github.com/apache/kafka/pull/18673#issuecomment-2698478874
hey @bbejeck yes i am still able to work on it
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] KAFKA-18572: Update Kafka Streams metric documenation [kafka]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #18673:
URL: https://github.com/apache/kafka/pull/18673#issuecomment-2623418927
A label of 'needs-attention' was automatically added to this PR in order to raise the
attention of the committers. Once this issue has been triaged, the `triage` label
should be removed to prevent this automation from happening again.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] KAFKA-18572: Update Kafka Streams metric documenation [kafka]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #18673:
URL: https://github.com/apache/kafka/pull/18673#issuecomment-2646823782
A label of 'needs-attention' was automatically added to this PR in order to raise the
attention of the committers. Once this issue has been triaged, the `triage` label
should be removed to prevent this automation from happening again.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] KAFKA-18572: Update Kafka Streams metric documenation [kafka]
Posted by "ukpagrace (via GitHub)" <gi...@apache.org>.
ukpagrace commented on code in PR #18673:
URL: https://github.com/apache/kafka/pull/18673#discussion_r1985387479
##########
docs/ops.html:
##########
@@ -2888,6 +2898,21 @@ <h5 class="anchor-heading"><a id="kafka_streams_thread_monitoring" class="anchor
<td>The total number of consumer poll calls.</td>
<td>kafka.streams:type=stream-thread-metrics,thread-id=([-.\w]+)</td>
</tr>
+ <tr>
+ <td>poll-records-avg</td>
+ <td>The average number of records polled from consumer within an iteration.</td>
+ <td>kafka.streams:type=stream-thread-metrics,thread-id=([-.\w]+)</td>
+ </tr>
+ <tr>
+ <td>poll-records-max</td>
+ <td>The maximum number of records polled from consumer within an iteration.</td>
+ <td>kafka.streams:type=stream-thread-metrics,thread-id=([-.\w]+)</td>
+ </tr>
+ <tr>
+ <td>process-ratio</td>
+ <td>The fraction of time the thread spent on processing active tasks</td>
+ <td>kafka.consumer:type=consumer-coordinator-metrics,client-id=([-.\w]+)</td>
Review Comment:
yes you are right
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] KAFKA-18572: Update Kafka Streams metric documenation [kafka]
Posted by "ukpagrace (via GitHub)" <gi...@apache.org>.
ukpagrace commented on PR #18673:
URL: https://github.com/apache/kafka/pull/18673#issuecomment-2706937831
> > hey @bbejeck yes i am still able to work on it
>
> Great! if you can address the comments here, we should be able to merge this soon.
Alright I will make the changes
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] KAFKA-18572: Update Kafka Streams metric documenation [kafka]
Posted by "bbejeck (via GitHub)" <gi...@apache.org>.
bbejeck commented on PR #18673:
URL: https://github.com/apache/kafka/pull/18673#issuecomment-2706918769
> hey @bbejeck yes i am still able to work on it
Great! if you can address the comments here, we should be able to merge this soon.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] KAFKA-18572: Update Kafka Streams metric documenation [kafka]
Posted by "bbejeck (via GitHub)" <gi...@apache.org>.
bbejeck commented on PR #18673:
URL: https://github.com/apache/kafka/pull/18673#issuecomment-2711200622
@ukpagrace gentle ping for updates
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] KAFKA-18572: Update Kafka Streams metric documenation [kafka]
Posted by "mjsax (via GitHub)" <gi...@apache.org>.
mjsax commented on PR #18673:
URL: https://github.com/apache/kafka/pull/18673#issuecomment-2798090506
@ukpagrace -- What the status on this PR? Would be great to complete it.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] KAFKA-18572: Update Kafka Streams metric documenation [kafka]
Posted by "ukpagrace (via GitHub)" <gi...@apache.org>.
ukpagrace commented on PR #18673:
URL: https://github.com/apache/kafka/pull/18673#issuecomment-2798425018
I made the changes,don't know what happened. Will push again. Thanks
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org