You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jira@kafka.apache.org by "mjsax (via GitHub)" <gi...@apache.org> on 2024/11/21 19:23:03 UTC

[PR] MINOR: improve Kafka Streams metrics documentation [kafka]

mjsax opened a new pull request, #17900:
URL: https://github.com/apache/kafka/pull/17900

   (no comment)


-- 
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] MINOR: improve Kafka Streams metrics documentation [kafka]

Posted by "cadonna (via GitHub)" <gi...@apache.org>.
cadonna commented on code in PR #17900:
URL: https://github.com/apache/kafka/pull/17900#discussion_r1853905853


##########
docs/ops.html:
##########
@@ -2988,7 +2988,7 @@ <h5 class="anchor-heading"><a id="kafka_streams_thread_monitoring" class="anchor
       </tr>
       <tr>
         <td>blocked-time-ns-total</td>
-        <td>The total time the thread spent blocked on kafka.</td>
+        <td>The total time in ns the thread spent blocked on kafka.</td>

Review Comment:
   nit:
   ```suggestion
           <td>The total time in nanoseconds the thread spent blocked on kafka.</td>
   ```



##########
docs/ops.html:
##########
@@ -2988,7 +2988,7 @@ <h5 class="anchor-heading"><a id="kafka_streams_thread_monitoring" class="anchor
       </tr>
       <tr>
         <td>blocked-time-ns-total</td>
-        <td>The total time the thread spent blocked on kafka.</td>
+        <td>The total time in ns the thread spent blocked on kafka.</td>

Review Comment:
   The comment also applies to the other units. 



-- 
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] MINOR: improve Kafka Streams metrics documentation [kafka]

Posted by "mjsax (via GitHub)" <gi...@apache.org>.
mjsax merged PR #17900:
URL: https://github.com/apache/kafka/pull/17900


-- 
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] MINOR: improve Kafka Streams metrics documentation [kafka]

Posted by "mjsax (via GitHub)" <gi...@apache.org>.
mjsax commented on code in PR #17900:
URL: https://github.com/apache/kafka/pull/17900#discussion_r1872618719


##########
docs/ops.html:
##########
@@ -2988,7 +2988,7 @@ <h5 class="anchor-heading"><a id="kafka_streams_thread_monitoring" class="anchor
       </tr>
       <tr>
         <td>blocked-time-ns-total</td>
-        <td>The total time the thread spent blocked on kafka.</td>
+        <td>The total time in ns the thread spent blocked on kafka.</td>

Review Comment:
   Talked to Bruno offline, and he is also fine with the abbreviations.
   
   I took one more look and also changed `seconds` to `sec` to use an abbreviation also there for consistency, and made a few other changes/fixed to get a unified way how docs are written.
   
   If there is no objections raised, I will merge this in the next couple of days.



-- 
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] MINOR: improve Kafka Streams metrics documentation [kafka]

Posted by "mjsax (via GitHub)" <gi...@apache.org>.
mjsax commented on code in PR #17900:
URL: https://github.com/apache/kafka/pull/17900#discussion_r1854780878


##########
docs/ops.html:
##########
@@ -2988,7 +2988,7 @@ <h5 class="anchor-heading"><a id="kafka_streams_thread_monitoring" class="anchor
       </tr>
       <tr>
         <td>blocked-time-ns-total</td>
-        <td>The total time the thread spent blocked on kafka.</td>
+        <td>The total time in ns the thread spent blocked on kafka.</td>

Review Comment:
   Well, we use `ns / ms` everywhere... If we update it here, we must update basically _all_ metrics. I tired to make a minimum change. Let me know what you think.



-- 
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] MINOR: improve Kafka Streams metrics documentation [kafka]

Posted by "guozhangwang (via GitHub)" <gi...@apache.org>.
guozhangwang commented on code in PR #17900:
URL: https://github.com/apache/kafka/pull/17900#discussion_r1872299683


##########
docs/ops.html:
##########
@@ -2988,7 +2988,7 @@ <h5 class="anchor-heading"><a id="kafka_streams_thread_monitoring" class="anchor
       </tr>
       <tr>
         <td>blocked-time-ns-total</td>
-        <td>The total time the thread spent blocked on kafka.</td>
+        <td>The total time in ns the thread spent blocked on kafka.</td>

Review Comment:
   I feel comfortable with `ns/ms`. Honestly either is fine, but if we want to keep the changes small I'd say just go for 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] MINOR: improve Kafka Streams metrics documentation [kafka]

Posted by "cadonna (via GitHub)" <gi...@apache.org>.
cadonna commented on code in PR #17900:
URL: https://github.com/apache/kafka/pull/17900#discussion_r1872726903


##########
docs/ops.html:
##########
@@ -2988,7 +2988,7 @@ <h5 class="anchor-heading"><a id="kafka_streams_thread_monitoring" class="anchor
       </tr>
       <tr>
         <td>blocked-time-ns-total</td>
-        <td>The total time the thread spent blocked on kafka.</td>
+        <td>The total time in ns the thread spent blocked on kafka.</td>

Review Comment:
   No objections.



-- 
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