Skip to content

Propagate flush to PeriodicMetricReader's metricExporter. #7410

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
jack-berg merged 2 commits into from
Jun 24, 2025
+44 −1
Merged

Propagate flush to PeriodicMetricReader's metricExporter. #7410

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7e488a0
Propagate flush to PeriodicMetricReader's metricExporter.
tylerbenson Jun 9, 2025
697d280
Improve test coverage
tylerbenson Jun 10, 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
16 changes: 15 additions & 1 deletion sdk/metrics/src/main/java/io/opentelemetry/sdk/metrics/export/PeriodicMetricReader.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,21 @@

@Override
public CompletableResultCode forceFlush() {
return scheduled.doRun();
CompletableResultCode result = new CompletableResultCode();
CompletableResultCode flushResult = scheduled.doRun();
flushResult.whenComplete(
() ->
exporter
.flush()
.whenComplete(
() -> {
if (!flushResult.isSuccess()) {
result.fail();

Check warning on line 93 in sdk/metrics/src/main/java/io/opentelemetry/sdk/metrics/export/PeriodicMetricReader.java

View check run for this annotation

Codecov / codecov/patch

sdk/metrics/src/main/java/io/opentelemetry/sdk/metrics/export/PeriodicMetricReader.java#L93 

Added line #L93 was not covered by tests
} else {
result.succeed();
}
}));
return result;
Copy link
Member Author

@tylerbenson tylerbenson Jun 9, 2025

Choose a reason for hiding this comment

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

I've seen this pattern in enough places I wonder if it would be worth adding CompletableResultCode.whenComplete(Callable<CompletableResultCode>) that handles this logic in one place.

Copy link
Member

@jack-berg jack-berg Jun 24, 2025

Choose a reason for hiding this comment

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

I like this idea

}

@Override
Expand Down
22 changes: 22 additions & 0 deletions sdk/metrics/src/test/java/io/opentelemetry/sdk/metrics/export/PeriodicMetricReaderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,28 @@ void flush() throws Exception {
}
}

@Test
void forceflush_callsFlush() {
MetricExporter metricExporter = mock(MetricExporter.class);
when(metricExporter.export(any())).thenReturn(CompletableResultCode.ofSuccess());
when(metricExporter.flush()).thenReturn(CompletableResultCode.ofSuccess());
when(metricExporter.shutdown()).thenReturn(CompletableResultCode.ofSuccess());

PeriodicMetricReader reader =
PeriodicMetricReader.builder(metricExporter)
.setInterval(Duration.ofNanos(Long.MAX_VALUE))
.build();

reader.register(collectionRegistration);
assertThat(reader.forceFlush().join(10, TimeUnit.SECONDS).isSuccess()).isTrue();

try {
verify(metricExporter).flush();
} finally {
reader.shutdown();
}
}

@Test
@Timeout(2)
@SuppressLogger(PeriodicMetricReader.class)
Expand Down
Loading