Skip to content

MINOR: Remove fetchQuotaMetrics and copyQuotaMetrics on close #20394

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Aug 23, 2025
Merged

MINOR: Remove fetchQuotaMetrics and copyQuotaMetrics on close #20394

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3e299c4
Remove fetchQuotaMetrics and copyQuotaMetrics
jim0987795064 Aug 21, 2025
5d651bf
Add testClose in RLMQuotaMetricsTest
jim0987795064 Aug 21, 2025
254993a
Apply spotless and checkstyle fixes
jim0987795064 Aug 22, 2025
f32c9e0
Move the closure of fetchQuotaMetrics and copyQuotaMetrics into remov…
jim0987795064 Aug 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion storage/src/main/java/org/apache/kafka/server/log/remote/quota/RLMQuotaMetrics.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

import java.util.concurrent.locks.ReentrantReadWriteLock;

public class RLMQuotaMetrics {
public class RLMQuotaMetrics implements AutoCloseable {

private final SensorAccess sensorAccess;
private final Metrics metrics;
Expand All @@ -51,4 +51,9 @@ public Sensor sensor() {
String.format(descriptionFormat, "maximum")), new Max());
});
}

@Override
public void close() {
this.metrics.removeSensor(name);
}
}
19 changes: 11 additions & 8 deletions storage/src/main/java/org/apache/kafka/server/log/remote/storage/RemoteLogManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -314,6 +314,8 @@ private void removeMetrics() {
metricsGroup.removeMetric(REMOTE_LOG_MANAGER_TASKS_AVG_IDLE_PERCENT_METRIC);
metricsGroup.removeMetric(REMOTE_LOG_READER_FETCH_RATE_AND_TIME_METRIC);
remoteStorageReaderThreadPool.removeMetrics();
Utils.closeQuietly(fetchQuotaMetrics, "fetchQuotaMetrics");
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jim0987795064 Could you please add unit test for it? RemoteLogManagerTest would be a good place.

Utils.closeQuietly(copyQuotaMetrics, "copyQuotaMetrics");
}

// Visible for testing
Expand Down Expand Up @@ -2044,17 +2046,18 @@ public void close() {
followerThreadPool.close();
try {
shutdownAndAwaitTermination(remoteStorageReaderThreadPool, "RemoteStorageReaderThreadPool", 10, TimeUnit.SECONDS);

leaderCopyRLMTasks.clear();
leaderExpirationRLMTasks.clear();
followerRLMTasks.clear();

Utils.closeQuietly(indexCache, "RemoteIndexCache");
Utils.closeQuietly(remoteLogMetadataManagerPlugin, "remoteLogMetadataManagerPlugin");
Utils.closeQuietly(remoteStorageManagerPlugin, "remoteStorageManagerPlugin");
closed = true;
} finally {
removeMetrics();
}
leaderCopyRLMTasks.clear();
leaderExpirationRLMTasks.clear();
followerRLMTasks.clear();

Utils.closeQuietly(indexCache, "RemoteIndexCache");
Utils.closeQuietly(remoteLogMetadataManagerPlugin, "remoteLogMetadataManagerPlugin");
Utils.closeQuietly(remoteStorageManagerPlugin, "remoteStorageManagerPlugin");
closed = true;
}
}
}
Expand Down
20 changes: 20 additions & 0 deletions storage/src/test/java/org/apache/kafka/server/log/remote/quota/RLMQuotaMetricsTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertNull;

public class RLMQuotaMetricsTest {
private final MockTime time = new MockTime();
Expand All @@ -49,4 +51,22 @@ public void testNewSensorWhenExpired() {
Sensor newSensor = rlmQuotaMetrics.sensor();
assertNotEquals(sensor, newSensor);
}

@Test
public void testClose() {
RLMQuotaMetrics quotaMetrics = new RLMQuotaMetrics(metrics, "metric", "group", "format", 5);

// Register the sensor
quotaMetrics.sensor();
var avg = metrics.metricName("metric" + "-avg", "group", String.format("format", "average"));

// Verify that metrics are created
assertNotNull(metrics.metric(avg));

// Close the quotaMetrics instance
quotaMetrics.close();

// After closing, the metrics should be removed
assertNull(metrics.metric(avg));
}
}