KAFKA-15330: Add missing documentation of metrics introduced as part of KAFKA-15028 #14480
Conversation
I do think that we need to have an exhaustive list of all metrics available in documentation. Otherwise user may not know existence of certain metrics unless they look into the code. We can choose to do it in a separate JIRA. |
docs/ops.html
Outdated
| <tr> | ||
| <td>Rate of transactional verification errors</td> | ||
| <td>kafka.server:type=AddPartitionsToTxnManager,name=VerificationFailureRate</td> | ||
| <td>in steady state 0, but transient errors are expected during rolls and reassignments of the transactional state partition</td> |
There was a problem hiding this comment.
We didn't specify what the metric actually measures. Your PR description when you added it has a nice description asL
Rate of verifications that returned in failure either from the AddPartitionsToTxn API response or through errors in the AddPartitionsToTxnManager. In steady state this metric will report 0, but transient errors are expected during rolls and reassignments of the transactional state partition
|
I will open the kafka-site PR shortly :) |
|
Tests are unrelated 😓 It is a bit worrying we see this large number of failures in Java 11 from time to time. |
KAFKA-15028 (#14480) I've added details for VerificationFailureRate and VerificationTimeMs. I considered adding the documentation for the AddPartitionsToTxnVerification metrics, but I noticed that all the request metrics simply listed Produce|FetchConsumer|FetchFollower. If we don't already report the AddPartitionsToTxn request metrics in this file, it doesn't make sense to add the verification variant. (As well as all the other APIs we report) Filed a followup jira if we want to redo that whole section. Reviewers: Reviewers: Divij Vaidya <diviv@amazon.com>
…of KAFKA-15028 (apache#14480) I've added details for VerificationFailureRate and VerificationTimeMs. I considered adding the documentation for the AddPartitionsToTxnVerification metrics, but I noticed that all the request metrics simply listed Produce|FetchConsumer|FetchFollower. If we don't already report the AddPartitionsToTxn request metrics in this file, it doesn't make sense to add the verification variant. (As well as all the other APIs we report) Filed a followup jira if we want to redo that whole section. Reviewers: Reviewers: Divij Vaidya <diviv@amazon.com>
…of KAFKA-15028 (apache#14480) I've added details for VerificationFailureRate and VerificationTimeMs. I considered adding the documentation for the AddPartitionsToTxnVerification metrics, but I noticed that all the request metrics simply listed Produce|FetchConsumer|FetchFollower. If we don't already report the AddPartitionsToTxn request metrics in this file, it doesn't make sense to add the verification variant. (As well as all the other APIs we report) Filed a followup jira if we want to redo that whole section. Reviewers: Reviewers: Divij Vaidya <diviv@amazon.com>
I've added details for VerificationFailureRate and VerificationTimeMs.
I considered adding the documentation for the AddPartitionsToTxnVerification metrics, but I noticed that all the request metrics simply listed Produce|FetchConsumer|FetchFollower. If we don't already report the AddPartitionsToTxn request metrics in this file, it doesn't make sense to add the verification variant. (As well as all the other APIs we report)
We can file a followup jira if we want to redo that whole section.
Once we have alignment here, I will cherrypick to 3.6 branch as well as the kafka-site repo.
Committer Checklist (excluded from commit message)