Skip to content
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

Jump to bottom

Makes Export methods async #1428

Merged
merged 2 commits into from
Aug 18, 2020
Merged

Makes Export methods async #1428

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
a1c86fa
Makes Export methods async
huntc Jul 17, 2020
ca10135
PR feedback
huntc Aug 18, 2020
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
11 changes: 6 additions & 5 deletions ...rs/inmemory/src/main/java/io/opentelemetry/exporters/inmemory/InMemoryMetricExporter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@

package io.opentelemetry.exporters.inmemory;

import io.opentelemetry.sdk.common.export.CompletableResultCode;
import io.opentelemetry.sdk.metrics.data.MetricData;
import io.opentelemetry.sdk.metrics.export.MetricExporter;
import java.util.ArrayList;
Expand Down Expand Up @@ -103,12 +104,12 @@ public void reset() {
* <p>If this is called after {@code shutdown}, this will return {@code ResultCode.FAILURE}.
*/
@Override
public ResultCode export(Collection<MetricData> metrics) {
public CompletableResultCode export(Collection<MetricData> metrics) {
if (isStopped) {
return ResultCode.FAILURE;
return CompletableResultCode.ofFailure();
}
finishedMetricItems.addAll(metrics);
return ResultCode.SUCCESS;
return CompletableResultCode.ofSuccess();
}

/**
Expand All @@ -118,8 +119,8 @@ public ResultCode export(Collection<MetricData> metrics) {
* @return always Success
*/
@Override
public ResultCode flush() {
return ResultCode.SUCCESS;
public CompletableResultCode flush() {
return CompletableResultCode.ofSuccess();
}

/**
Expand Down
11 changes: 6 additions & 5 deletions ...ters/inmemory/src/main/java/io/opentelemetry/exporters/inmemory/InMemorySpanExporter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@

package io.opentelemetry.exporters.inmemory;

import io.opentelemetry.sdk.common.export.CompletableResultCode;
import io.opentelemetry.sdk.trace.data.SpanData;
import io.opentelemetry.sdk.trace.export.SpanExporter;
import java.util.ArrayList;
Expand Down Expand Up @@ -85,14 +86,14 @@ public void reset() {
}

@Override
public ResultCode export(Collection<SpanData> spans) {
public CompletableResultCode export(Collection<SpanData> spans) {
synchronized (this) {
if (isStopped) {
return ResultCode.FAILURE;
return CompletableResultCode.ofFailure();
}
finishedSpanItems.addAll(spans);
}
return ResultCode.SUCCESS;
return CompletableResultCode.ofSuccess();
}

/**
Expand All @@ -102,8 +103,8 @@ public ResultCode export(Collection<SpanData> spans) {
* @return always Success
*/
@Override
public ResultCode flush() {
return ResultCode.SUCCESS;
public CompletableResultCode flush() {
return CompletableResultCode.ofSuccess();
}

@Override
Expand Down
13 changes: 6 additions & 7 deletions ...nmemory/src/test/java/io/opentelemetry/exporters/inmemory/InMemoryMetricExporterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@
import io.opentelemetry.sdk.metrics.data.MetricData;
import io.opentelemetry.sdk.metrics.data.MetricData.Descriptor;
import io.opentelemetry.sdk.metrics.data.MetricData.LongPoint;
import io.opentelemetry.sdk.metrics.export.MetricExporter.ResultCode;
import io.opentelemetry.sdk.resources.Resource;
import java.util.ArrayList;
import java.util.Collections;
Expand Down Expand Up @@ -54,7 +53,7 @@ void test_getFinishedMetricItems() {
metrics.add(generateFakeMetric());
metrics.add(generateFakeMetric());

assertThat(exporter.export(metrics)).isEqualTo(ResultCode.SUCCESS);
assertThat(exporter.export(metrics).isSuccess()).isTrue();
List<MetricData> metricItems = exporter.getFinishedMetricItems();
assertThat(metricItems).isNotNull();
assertThat(metricItems.size()).isEqualTo(3);
Expand All @@ -67,7 +66,7 @@ void test_reset() {
metrics.add(generateFakeMetric());
metrics.add(generateFakeMetric());

assertThat(exporter.export(metrics)).isEqualTo(ResultCode.SUCCESS);
assertThat(exporter.export(metrics).isSuccess()).isTrue();
List<MetricData> metricItems = exporter.getFinishedMetricItems();
assertThat(metricItems).isNotNull();
assertThat(metricItems.size()).isEqualTo(3);
Expand All @@ -84,7 +83,7 @@ void test_shutdown() {
metrics.add(generateFakeMetric());
metrics.add(generateFakeMetric());

assertThat(exporter.export(metrics)).isEqualTo(ResultCode.SUCCESS);
assertThat(exporter.export(metrics).isSuccess()).isTrue();
exporter.shutdown();
List<MetricData> metricItems = exporter.getFinishedMetricItems();
assertThat(metricItems).isNotNull();
Expand All @@ -98,13 +97,13 @@ void testShutdown_export() {
metrics.add(generateFakeMetric());
metrics.add(generateFakeMetric());

assertThat(exporter.export(metrics)).isEqualTo(ResultCode.SUCCESS);
assertThat(exporter.export(metrics).isSuccess()).isTrue();
exporter.shutdown();
assertThat(exporter.export(metrics)).isEqualTo(ResultCode.FAILURE);
assertThat(exporter.export(metrics).isSuccess()).isFalse();
}

@Test
void test_flush() {
assertThat(exporter.flush()).isEqualTo(ResultCode.SUCCESS);
assertThat(exporter.flush().isSuccess()).isTrue();
}
}
10 changes: 3 additions & 7 deletions .../inmemory/src/test/java/io/opentelemetry/exporters/inmemory/InMemorySpanExporterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@
import io.opentelemetry.sdk.trace.TracerSdkProvider;
import io.opentelemetry.sdk.trace.data.SpanData;
import io.opentelemetry.sdk.trace.export.SimpleSpanProcessor;
import io.opentelemetry.sdk.trace.export.SpanExporter.ResultCode;
import io.opentelemetry.trace.Span.Kind;
import io.opentelemetry.trace.SpanId;
import io.opentelemetry.trace.Status;
Expand Down Expand Up @@ -89,16 +88,13 @@ void shutdown() {

@Test
void export_ReturnCode() {
assertThat(exporter.export(Collections.singletonList(makeBasicSpan())))
.isEqualTo(ResultCode.SUCCESS);
assertThat(exporter.export(Collections.singletonList(makeBasicSpan())).isSuccess()).isTrue();
exporter.shutdown();
// After shutdown no more export.
assertThat(exporter.export(Collections.singletonList(makeBasicSpan())))
.isEqualTo(ResultCode.FAILURE);
assertThat(exporter.export(Collections.singletonList(makeBasicSpan())).isSuccess()).isFalse();
exporter.reset();
// Reset does not do anything if already shutdown.
assertThat(exporter.export(Collections.singletonList(makeBasicSpan())))
.isEqualTo(ResultCode.FAILURE);
assertThat(exporter.export(Collections.singletonList(makeBasicSpan())).isSuccess()).isFalse();
}

static SpanData makeBasicSpan() {
Expand Down
11 changes: 6 additions & 5 deletions exporters/jaeger/src/main/java/io/opentelemetry/exporters/jaeger/JaegerGrpcSpanExporter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
import io.opentelemetry.exporters.jaeger.proto.api_v2.Collector;
import io.opentelemetry.exporters.jaeger.proto.api_v2.CollectorServiceGrpc;
import io.opentelemetry.exporters.jaeger.proto.api_v2.Model;
import io.opentelemetry.sdk.common.export.CompletableResultCode;
import io.opentelemetry.sdk.common.export.ConfigBuilder;
import io.opentelemetry.sdk.trace.data.SpanData;
import io.opentelemetry.sdk.trace.export.SpanExporter;
Expand Down Expand Up @@ -107,7 +108,7 @@ private JaegerGrpcSpanExporter(String serviceName, ManagedChannel channel, long
* @return the result of the operation
*/
@Override
public ResultCode export(Collection<SpanData> spans) {
public CompletableResultCode export(Collection<SpanData> spans) {
Collector.PostSpansRequest request =
Collector.PostSpansRequest.newBuilder()
.setBatch(
Expand All @@ -126,10 +127,10 @@ public ResultCode export(Collection<SpanData> spans) {
// for now, there's nothing to check in the response object
//noinspection ResultOfMethodCallIgnored
stub.postSpans(request);
return ResultCode.SUCCESS;
return CompletableResultCode.ofSuccess();
} catch (Throwable e) {
logger.log(Level.WARNING, "Failed to export spans", e);
return ResultCode.FAILURE;
return CompletableResultCode.ofFailure();
}
}

Expand All @@ -139,8 +140,8 @@ public ResultCode export(Collection<SpanData> spans) {
* @return always Success
*/
@Override
public ResultCode flush() {
return ResultCode.SUCCESS;
public CompletableResultCode flush() {
return CompletableResultCode.ofSuccess();
}

/**
Expand Down
13 changes: 7 additions & 6 deletions ...rters/logging/src/main/java/io/opentelemetry/exporters/logging/LoggingMetricExporter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@

package io.opentelemetry.exporters.logging;

import io.opentelemetry.sdk.common.export.CompletableResultCode;
import io.opentelemetry.sdk.metrics.data.MetricData;
import io.opentelemetry.sdk.metrics.export.MetricExporter;
import java.util.Collection;
Expand All @@ -27,12 +28,12 @@ public class LoggingMetricExporter implements MetricExporter {
private static final Logger logger = Logger.getLogger(LoggingMetricExporter.class.getName());

@Override
public ResultCode export(Collection<MetricData> metrics) {
public CompletableResultCode export(Collection<MetricData> metrics) {
logger.info("Received a collection of " + metrics.size() + " metrics for export.");
for (MetricData metricData : metrics) {
logger.log(Level.INFO, "metric: {0}", metricData);
}
return ResultCode.SUCCESS;
return CompletableResultCode.ofSuccess();
}

/**
Expand All @@ -41,16 +42,16 @@ public ResultCode export(Collection<MetricData> metrics) {
* @return the result of the operation
*/
@Override
public ResultCode flush() {
ResultCode resultCode = ResultCode.SUCCESS;
public CompletableResultCode flush() {
CompletableResultCode resultCode = new CompletableResultCode();
for (Handler handler : logger.getHandlers()) {
try {
handler.flush();
} catch (Throwable t) {
resultCode = ResultCode.FAILURE;
resultCode.fail();
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we early return here? Similar comment elsewhere

Copy link
Contributor

Choose a reason for hiding this comment

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

I think it doesn't matter in this particular case, since we might want to flush all the handlers, even if one fails. The call to succeed() below is a no-op if it's been previously failed.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'll add a return to make it clear but, as John mentioned, it makes no diff.

}
}
return resultCode;
return resultCode.succeed();
}

@Override
Expand Down
13 changes: 7 additions & 6 deletions exporters/logging/src/main/java/io/opentelemetry/exporters/logging/LoggingSpanExporter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@

package io.opentelemetry.exporters.logging;

import io.opentelemetry.sdk.common.export.CompletableResultCode;
import io.opentelemetry.sdk.trace.data.SpanData;
import io.opentelemetry.sdk.trace.export.SpanExporter;
import java.util.Collection;
Expand All @@ -28,11 +29,11 @@ public class LoggingSpanExporter implements SpanExporter {
private static final Logger logger = Logger.getLogger(LoggingSpanExporter.class.getName());

@Override
public ResultCode export(Collection<SpanData> spans) {
public CompletableResultCode export(Collection<SpanData> spans) {
for (SpanData span : spans) {
logger.log(Level.INFO, "span: {0}", span);
}
return ResultCode.SUCCESS;
return CompletableResultCode.ofSuccess();
}

/**
Expand All @@ -41,16 +42,16 @@ public ResultCode export(Collection<SpanData> spans) {
* @return the result of the operation
*/
@Override
public ResultCode flush() {
ResultCode resultCode = ResultCode.SUCCESS;
public CompletableResultCode flush() {
CompletableResultCode resultCode = new CompletableResultCode();
for (Handler handler : logger.getHandlers()) {
try {
handler.flush();
} catch (Throwable t) {
resultCode = ResultCode.FAILURE;
resultCode.fail();
}
}
return resultCode;
return resultCode.succeed();
}

@Override
Expand Down
7 changes: 3 additions & 4 deletions ...ers/logging/src/test/java/io/opentelemetry/exporters/logging/LoggingSpanExporterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,13 @@

import static java.util.Collections.singletonList;
import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.jupiter.api.Assertions.assertEquals;

import io.opentelemetry.common.AttributeValue;
import io.opentelemetry.common.Attributes;
import io.opentelemetry.sdk.common.export.CompletableResultCode;
import io.opentelemetry.sdk.trace.TestSpanData;
import io.opentelemetry.sdk.trace.data.EventImpl;
import io.opentelemetry.sdk.trace.data.SpanData;
import io.opentelemetry.sdk.trace.export.SpanExporter.ResultCode;
import io.opentelemetry.trace.Span.Kind;
import io.opentelemetry.trace.SpanId;
import io.opentelemetry.trace.Status;
Expand Down Expand Up @@ -77,8 +76,8 @@ void returnCode() {
.setTotalRecordedEvents(1)
.setTotalRecordedLinks(0)
.build();
ResultCode resultCode = exporter.export(singletonList(spanData));
assertEquals(ResultCode.SUCCESS, resultCode);
CompletableResultCode resultCode = exporter.export(singletonList(spanData));
assertThat(resultCode.isSuccess()).isTrue();
}

@Test
Expand Down
Loading