Skip to content

[Pipe] Fix remaining-event metric identities #19071

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
jt2594838 merged 2 commits into from
Nov 2, 2026
Merged

[Pipe] Fix remaining-event metric identities #19071

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4c4c9ee
[Pipe] Fix ConfigRegion remaining event count lookup
Caideyipi Nov 2, 2026
6f95211
[Pipe] Preserve full pipe names in remaining metrics
Caideyipi Nov 2, 2026
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
24 changes: 14 additions & 10 deletions .../iotdb/confignode/manager/pipe/metric/overview/PipeTemporaryMetaInCoordinatorMetrics.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,25 +69,27 @@ private void createMetrics(final String pipeID) {

private void createAutoGauge(final String pipeID) {
final PipeTemporaryMetaInCoordinator pipeTemporaryMeta = pipeTemporaryMetaMap.get(pipeID);
final String[] pipeNameAndCreationTime = pipeID.split("_");
final int separatorIndex = pipeID.lastIndexOf('_');
final String pipeName = pipeID.substring(0, separatorIndex);
final String creationTime = pipeID.substring(separatorIndex + 1);
metricService.createAutoGauge(
Metric.PIPE_GLOBAL_REMAINING_EVENT_COUNT.toString(),
MetricLevel.IMPORTANT,
pipeTemporaryMeta,
PipeTemporaryMetaInCoordinator::getGlobalRemainingEvents,
Tag.NAME.toString(),
pipeNameAndCreationTime[0],
pipeName,
Tag.CREATION_TIME.toString(),
pipeNameAndCreationTime[1]);
creationTime);
metricService.createAutoGauge(
Metric.PIPE_GLOBAL_REMAINING_TIME.toString(),
MetricLevel.IMPORTANT,
pipeTemporaryMeta,
PipeTemporaryMetaInCoordinator::getGlobalRemainingTime,
Tag.NAME.toString(),
pipeNameAndCreationTime[0],
pipeName,
Tag.CREATION_TIME.toString(),
pipeNameAndCreationTime[1]);
creationTime);
}

@Override
Expand All @@ -102,21 +104,23 @@ private void removeMetrics(final String pipeID) {
}

private void removeAutoGauge(final String pipeID) {
final String[] pipeNameAndCreationTime = pipeID.split("_");
final int separatorIndex = pipeID.lastIndexOf('_');
final String pipeName = pipeID.substring(0, separatorIndex);
final String creationTime = pipeID.substring(separatorIndex + 1);
metricService.remove(
MetricType.AUTO_GAUGE,
Metric.PIPE_GLOBAL_REMAINING_EVENT_COUNT.toString(),
Tag.NAME.toString(),
pipeNameAndCreationTime[0],
pipeName,
Tag.CREATION_TIME.toString(),
pipeNameAndCreationTime[1]);
creationTime);
metricService.remove(
MetricType.AUTO_GAUGE,
Metric.PIPE_GLOBAL_REMAINING_TIME.toString(),
Tag.NAME.toString(),
pipeNameAndCreationTime[0],
pipeName,
Tag.CREATION_TIME.toString(),
pipeNameAndCreationTime[1]);
creationTime);
}

//////////////////////////// register & deregister (pipe integration) ////////////////////////////
Expand Down
4 changes: 3 additions & 1 deletion ...org/apache/iotdb/confignode/manager/pipe/metric/source/PipeConfigRegionSourceMetrics.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@
import java.util.Objects;
import java.util.concurrent.ConcurrentHashMap;

import static org.apache.iotdb.commons.client.AbstractConfigNodeInfo.CONFIG_REGION_ID;

public class PipeConfigRegionSourceMetrics implements IMetricSet {

private static final Logger LOGGER = LoggerFactory.getLogger(PipeConfigRegionSourceMetrics.class);
Expand Down Expand Up @@ -117,7 +119,7 @@ public synchronized void deregister(final String taskID) {
//////////////////////////// Show pipes ////////////////////////////

public long getRemainingEventCount(final String pipeName, final long creationTime) {
final String taskID = pipeName + "_" + creationTime;
final String taskID = pipeName + "_" + CONFIG_REGION_ID.getId() + "_" + creationTime;
final IoTDBConfigRegionSource extractor = extractorMap.get(taskID);
// Do not print log to allow collection when config region extractor does not exists
if (Objects.isNull(extractor)) {
Expand Down
103 changes: 101 additions & 2 deletions ...ava/org/apache/iotdb/confignode/manager/pipe/metric/PipeConfigNodeMetricsRestartTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import org.apache.iotdb.commons.pipe.agent.task.meta.PipeTemporaryMetaInCoordinator;
import org.apache.iotdb.commons.service.metric.MetricService;
import org.apache.iotdb.commons.service.metric.enums.Metric;
import org.apache.iotdb.commons.service.metric.enums.Tag;
import org.apache.iotdb.confignode.manager.pipe.agent.task.PipeConfigNodeSubtask;
import org.apache.iotdb.confignode.manager.pipe.metric.overview.PipeConfigNodeRemainingTimeMetrics;
import org.apache.iotdb.confignode.manager.pipe.metric.overview.PipeTemporaryMetaInCoordinatorMetrics;
Expand All @@ -33,6 +34,7 @@
import org.apache.iotdb.metrics.config.MetricConfig;
import org.apache.iotdb.metrics.config.MetricConfigDescriptor;
import org.apache.iotdb.metrics.metricsets.IMetricSet;
import org.apache.iotdb.metrics.type.AutoGauge;
import org.apache.iotdb.metrics.type.IMetric;
import org.apache.iotdb.metrics.type.Rate;
import org.apache.iotdb.metrics.utils.MetricInfo;
Expand All @@ -49,6 +51,8 @@
import java.util.stream.Collectors;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import static org.mockito.Mockito.when;

/** Pipe metrics must survive a metric service restart, which drops and rebinds all metrics. */
Expand Down Expand Up @@ -87,14 +91,23 @@ public void tearDown() {
public void testConfigRegionSourceMetrics() {
final PipeConfigRegionSourceMetrics metrics = PipeConfigRegionSourceMetrics.getInstance();
bind(metrics);
metrics.register(mockConfigRegionSource());
final IoTDBConfigRegionSource source = mockConfigRegionSource();
when(source.getTaskID()).thenReturn(PIPE + "_0_" + CREATION_TIME);
when(source.getUnTransferredEventCount()).thenReturn(7L);
metrics.register(source);
try {
assertEquals(7L, metrics.getRemainingEventCount(PIPE, CREATION_TIME));
assertEquals(0L, metrics.getRemainingEventCount(PIPE, CREATION_TIME + 1));
assertEquals(0L, metrics.getRemainingEventCount("other_pipe", CREATION_TIME));
service.restartService();
assertEquals(1, count(Metric.UNTRANSFERRED_CONFIG_COUNT));
when(source.getUnTransferredEventCount()).thenReturn(3L);
assertEquals(3L, metrics.getRemainingEventCount(PIPE, CREATION_TIME));
} finally {
metrics.deregister(TASK_ID);
metrics.deregister(source.getTaskID());
}
assertEquals(0, count(Metric.UNTRANSFERRED_CONFIG_COUNT));
assertEquals(0L, metrics.getRemainingEventCount(PIPE, CREATION_TIME));
}

@Test
Expand Down Expand Up @@ -154,6 +167,79 @@ public void testTemporaryMetaInCoordinatorMetrics() {
assertEquals(0, count(Metric.PIPE_GLOBAL_REMAINING_EVENT_COUNT));
}

@Test
public void testTemporaryMetaMetricsWithUnderscores() {
final PipeTemporaryMetaInCoordinatorMetrics metrics =
PipeTemporaryMetaInCoordinatorMetrics.getInstance();
bind(metrics);
final String[] pipeNames = {
"pipe_with_underscores", "pipe_with_underscores", "pipe_with_another_suffix_", "_pipe"
};
final long[] creationTimes = {CREATION_TIME, CREATION_TIME + 1, CREATION_TIME, CREATION_TIME};
final List<String> registeredPipeIds = new ArrayList<>();
final List<PipeTemporaryMetaInCoordinator> temporaryMetas = new ArrayList<>();
try {
for (int i = 0; i < pipeNames.length; i++) {
final PipeStaticMeta staticMeta = Mockito.mock(PipeStaticMeta.class);
when(staticMeta.getPipeName()).thenReturn(pipeNames[i]);
when(staticMeta.getCreationTime()).thenReturn(creationTimes[i]);
final PipeMeta pipeMeta = Mockito.mock(PipeMeta.class);
when(pipeMeta.getStaticMeta()).thenReturn(staticMeta);
final PipeTemporaryMetaInCoordinator temporaryMeta =
Mockito.mock(PipeTemporaryMetaInCoordinator.class);
when(temporaryMeta.getGlobalRemainingEvents()).thenReturn(7L + i);
when(temporaryMeta.getGlobalRemainingTime()).thenReturn(10.0 + i);
when(pipeMeta.getTemporaryMeta()).thenReturn(temporaryMeta);
registeredPipeIds.add(pipeNames[i] + "_" + creationTimes[i]);
temporaryMetas.add(temporaryMeta);
metrics.register(pipeMeta);
}
assertEquals(pipeNames.length, count(Metric.PIPE_GLOBAL_REMAINING_EVENT_COUNT));
assertEquals(pipeNames.length, count(Metric.PIPE_GLOBAL_REMAINING_TIME));
for (int i = 0; i < pipeNames.length; i++) {
assertTemporaryMetaValues(pipeNames[i], creationTimes[i], 7L + i, 10.0 + i);
}
service.restartService();
when(temporaryMetas.get(0).getGlobalRemainingEvents()).thenReturn(3L);
when(temporaryMetas.get(0).getGlobalRemainingTime()).thenReturn(4.0);
assertTemporaryMetaValues(pipeNames[0], creationTimes[0], 3L, 4.0);
metrics.deregister(registeredPipeIds.remove(0));
assertEquals(pipeNames.length - 1, count(Metric.PIPE_GLOBAL_REMAINING_EVENT_COUNT));
assertEquals(pipeNames.length - 1, count(Metric.PIPE_GLOBAL_REMAINING_TIME));
assertNull(get(Metric.PIPE_GLOBAL_REMAINING_EVENT_COUNT, pipeNames[0], creationTimes[0]));
assertNull(get(Metric.PIPE_GLOBAL_REMAINING_TIME, pipeNames[0], creationTimes[0]));
for (int i = 1; i < pipeNames.length; i++) {
assertTemporaryMetaValues(pipeNames[i], creationTimes[i], 7L + i, 10.0 + i);
}
service.restartService();
assertEquals(pipeNames.length - 1, count(Metric.PIPE_GLOBAL_REMAINING_EVENT_COUNT));
assertEquals(pipeNames.length - 1, count(Metric.PIPE_GLOBAL_REMAINING_TIME));
assertNull(get(Metric.PIPE_GLOBAL_REMAINING_EVENT_COUNT, pipeNames[0], creationTimes[0]));
assertNull(get(Metric.PIPE_GLOBAL_REMAINING_TIME, pipeNames[0], creationTimes[0]));
for (int i = 1; i < pipeNames.length; i++) {
assertTemporaryMetaValues(pipeNames[i], creationTimes[i], 7L + i, 10.0 + i);
}
} finally {
registeredPipeIds.forEach(metrics::deregister);
}
assertEquals(0, count(Metric.PIPE_GLOBAL_REMAINING_EVENT_COUNT));
assertEquals(0, count(Metric.PIPE_GLOBAL_REMAINING_TIME));
}

private void assertTemporaryMetaValues(
final String pipeName,
final long creationTime,
final long remainingEvents,
final double remainingTime) {
final IMetric eventGauge =
get(Metric.PIPE_GLOBAL_REMAINING_EVENT_COUNT, pipeName, creationTime);
final IMetric timeGauge = get(Metric.PIPE_GLOBAL_REMAINING_TIME, pipeName, creationTime);
assertNotNull(eventGauge);
assertNotNull(timeGauge);
assertEquals(remainingEvents, ((AutoGauge) eventGauge).getValue(), 0.0);
assertEquals(remainingTime, ((AutoGauge) timeGauge).getValue(), 0.0);
}

private void bind(final IMetricSet metricSet) {
service.addMetricSet(metricSet);
boundMetricSets.add(metricSet);
Expand Down Expand Up @@ -181,4 +267,17 @@ private IMetric get(final Metric metric) {
}
throw new AssertionError(metric + " is not registered");
}

private IMetric get(final Metric metric, final String pipeName, final long creationTime) {
return service.getAllMetrics().entrySet().stream()
.filter(entry -> metric.toString().equals(entry.getKey().getName()))
.filter(entry -> pipeName.equals(entry.getKey().getTags().get(Tag.NAME.toString())))
.filter(
entry ->
String.valueOf(creationTime)
.equals(entry.getKey().getTags().get(Tag.CREATION_TIME.toString())))
.map(Map.Entry::getValue)
.findFirst()
.orElse(null);
}
}
Loading