[KAFKA-16252] Maligned Metrics formatting

• Type: Bug
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 3.6.1
• Fix Version/s: 3.8.0
• Component/s: documentation
• Assignee: Cheng-Kai, Zhang
• Reporter: James
• Created: 14/Feb/24 06:38
• Updated: 04/Jun/24 21:58
• Resolved: 06/Mar/24 09:20

Description

There's some inconsistencies, and I believe indeed some buggy content in the documentation for monitoring kafka.

1. Some MBean documentation is presented as a TR with a colspan of 3 instead of its normal location of the third column

2. There seems to be some erroneous data posted in the headings for a handful of documentation sections, ex

 [2023-09-15 00:40:42,725] INFO Metrics scheduler closed (org.apache.kafka.common.metrics.Metrics:693) [2023-09-15 00:40:42,729] INFO Metrics reporters closed (org.apache.kafka.common.metrics.Metrics:703)  

Links to erroneous content (not permalinks)

 

• https://kafka.apache.org/documentation/#producer_sender_monitoring
• https://kafka.apache.org/documentation/#consumer_fetch_monitoring
• https://kafka.apache.org/documentation/#connect_monitoring

This image demonstrates both issues

Issue Links

• links to: GitHub Pull Request #15473
• links to: GitHub Pull Request #15986
• links to: GitHub Pull Request #16160