KAFKA-19559: Remove ShareFetchMetricsManager sensors on consumer.close() (#20255)

*What*
https://issues.apache.org/jira/browse/KAFKA-19559

- There are a few sensors(created when a `ShareConsumer` initializes)
which are not removed when the `ShareConsumer` closes.
- To maintain consistency and prevent any leaks, we have to remove all
the sensors when the consumer is closed.

This is similar to this issue for regular consumers -
https://issues.apache.org/jira/browse/KAFKA-19542

Reviewers: Andrew Schofield <aschofield@confluent.io>, Apoorv Mittal
<apoorvmittal10@gmail.com>

Author: ShivsundarR

clients/src/main/java/org/apache/kafka/clients/consumer/internals/ShareConsumeRequestManager.java

@@ -1076,6 +1076,7 @@ boolean hasCompletedFetches() {
 
     protected void closeInternal() {
         Utils.closeQuietly(shareFetchBuffer, "shareFetchBuffer");
+        Utils.closeQuietly(metricsManager, "shareFetchMetricsManager");
     }
 
     public void close() {

clients/src/main/java/org/apache/kafka/clients/consumer/internals/ShareFetchMetricsManager.java

@@ -20,7 +20,10 @@
 import org.apache.kafka.common.metrics.Sensor;
 import org.apache.kafka.common.metrics.stats.WindowedCount;
 
-public class ShareFetchMetricsManager {
+import java.io.IOException;
+import java.util.Arrays;
+
+public class ShareFetchMetricsManager implements AutoCloseable {
     private final Metrics metrics;
     private final Sensor throttleTime;
     private final Sensor bytesFetched;
@@ -92,4 +95,16 @@ void recordAcknowledgementSent(int acknowledgements) {
     void recordFailedAcknowledgements(int acknowledgements) {
         failedAcknowledgements.record(acknowledgements);
     }
+
+    @Override
+    public void close() throws IOException {
+        Arrays.asList(
+            throttleTime.name(),
+            bytesFetched.name(),
+            recordsFetched.name(),
+            fetchLatency.name(),
+            sentAcknowledgements.name(),
+            failedAcknowledgements.name()
+        ).forEach(metrics::removeSensor);
+    }
 }

clients/src/test/java/org/apache/kafka/clients/consumer/internals/ShareConsumeRequestManagerTest.java

@@ -117,6 +117,7 @@
 import static org.junit.jupiter.api.Assertions.assertFalse;
 import static org.junit.jupiter.api.Assertions.assertInstanceOf;
 import static org.junit.jupiter.api.Assertions.assertNotEquals;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
 import static org.junit.jupiter.api.Assertions.assertNull;
 import static org.junit.jupiter.api.Assertions.assertThrows;
 import static org.junit.jupiter.api.Assertions.assertTrue;
@@ -2427,6 +2428,36 @@ void testWhenLeadershipChangedAfterDisconnected() {
         assertEquals(1, fetchedRecords.size());
     }
 
+    @Test
+    public void testCloseInternalClosesShareFetchMetricsManager() throws Exception {
+        buildRequestManager();
+
+        // Define all sensor names that should be created and removed
+        String[] sensorNames = {
+            "fetch-throttle-time",
+            "bytes-fetched",
+            "records-fetched",
+            "fetch-latency",
+            "sent-acknowledgements",
+            "failed-acknowledgements"
+        };
+
+        // Verify that sensors exist before closing
+        for (String sensorName : sensorNames) {
+            assertNotNull(metrics.getSensor(sensorName), 
+                "Sensor " + sensorName + " should exist before closing");
+        }
+
+        // Close the request manager
+        shareConsumeRequestManager.close();
+
+        // Verify that all sensors are removed after closing
+        for (String sensorName : sensorNames) {
+            assertNull(metrics.getSensor(sensorName), 
+                "Sensor " + sensorName + " should be removed after closing");
+        }
+    }
+
     private ShareFetchResponse fetchResponseWithTopLevelError(TopicIdPartition tp, Errors error) {
         Map<TopicIdPartition, ShareFetchResponseData.PartitionData> partitions = Map.of(tp,
                 new ShareFetchResponseData.PartitionData()

clients/src/test/java/org/apache/kafka/clients/consumer/internals/ShareFetchMetricsManagerTest.java

@@ -30,8 +30,12 @@
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 
+import java.io.IOException;
+
 import static org.apache.kafka.clients.consumer.internals.ConsumerUtils.CONSUMER_SHARE_METRIC_GROUP_PREFIX;
 import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+import static org.junit.jupiter.api.Assertions.assertNull;
 
 class ShareFetchMetricsManagerTest {
     private static final double EPSILON = 0.0001;
@@ -114,6 +118,41 @@ public void testRecordsFetched() {
         assertEquals(8, (double) getMetric(shareFetchMetricsRegistry.recordsPerRequestAvg).metricValue(), EPSILON);
     }
 
+    @Test
+    public void testAcknowledgements() {
+        shareFetchMetricsManager.recordAcknowledgementSent(5);
+        shareFetchMetricsManager.recordFailedAcknowledgements(2);
+
+        assertEquals(5, (double) getMetric(shareFetchMetricsRegistry.acknowledgementSendTotal).metricValue());
+        assertEquals(2, (double) getMetric(shareFetchMetricsRegistry.acknowledgementErrorTotal).metricValue());
+    }
+
+    @Test
+    public void testCloseRemovesAllSensors() throws IOException {
+        // Define all sensor names that should be created and removed
+        String[] sensorNames = {
+            "fetch-throttle-time",
+            "bytes-fetched", 
+            "records-fetched",
+            "fetch-latency",
+            "sent-acknowledgements",
+            "failed-acknowledgements"
+        };
+        
+        // Verify that sensors exist before closing
+        for (String sensorName : sensorNames) {
+            assertNotNull(metrics.getSensor(sensorName), "Sensor " + sensorName + " should exist before closing");
+        }
+
+        // Close the metrics manager
+        shareFetchMetricsManager.close();
+
+        // Verify that all sensors are removed
+        for (String sensorName : sensorNames) {
+            assertNull(metrics.getSensor(sensorName), "Sensor " + sensorName + " should be removed after closing");
+        }
+    }
+
     private KafkaMetric getMetric(MetricNameTemplate name) {
         return metrics.metric(metrics.metricInstance(name));
     }