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

Add meaningful tests for OTEL client #13831

Merged
merged 3 commits into from
Jun 16, 2022
Merged

Add meaningful tests for OTEL client #13831

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
60279a5
Add meaningful tests for OTEL client
xiaohansong Jun 15, 2022
3c6d8a4
PR comment fix
xiaohansong Jun 16, 2022
862f1a0
code clean ups
xiaohansong Jun 16, 2022
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
2 changes: 2 additions & 0 deletions airbyte-metrics/metrics-lib/build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ dependencies {
implementation project(':airbyte-db:db-lib')

implementation libs.otel.semconv
implementation libs.otel.sdk
implementation libs.otel.sdk.testing
implementation platform(libs.otel.bom)
implementation("io.opentelemetry:opentelemetry-api")
implementation("io.opentelemetry:opentelemetry-sdk")
Expand Down
33 changes: 31 additions & 2 deletions ...e-metrics/metrics-lib/src/main/java/io/airbyte/metrics/lib/OpenTelemetryMetricClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
import static io.opentelemetry.api.common.AttributeKey.stringKey;
import static io.opentelemetry.semconv.resource.attributes.ResourceAttributes.SERVICE_NAME;

import com.google.common.annotations.VisibleForTesting;
import io.opentelemetry.api.OpenTelemetry;
import io.opentelemetry.api.common.Attributes;
import io.opentelemetry.api.common.AttributesBuilder;
Expand All @@ -20,14 +21,18 @@
import io.opentelemetry.exporter.otlp.trace.OtlpGrpcSpanExporter;
import io.opentelemetry.sdk.OpenTelemetrySdk;
import io.opentelemetry.sdk.metrics.SdkMeterProvider;
import io.opentelemetry.sdk.metrics.export.MetricExporter;
import io.opentelemetry.sdk.metrics.export.PeriodicMetricReader;
import io.opentelemetry.sdk.resources.Resource;
import io.opentelemetry.sdk.testing.exporter.InMemoryMetricExporter;
import io.opentelemetry.sdk.trace.SdkTracerProvider;
import io.opentelemetry.sdk.trace.export.BatchSpanProcessor;

public class OpenTelemetryMetricClient implements MetricClient {

private Meter meter;
private MetricExporter metricExporter;
private SdkMeterProvider meterProvider;

@Override
public void count(MetricsRegistry metric, long val, String... tags) {
Expand Down Expand Up @@ -75,9 +80,33 @@ public void initialize(MetricEmittingApp metricEmittingApp, String otelEndpoint)
.build())
.setResource(resource)
.build();
OtlpGrpcMetricExporter metricExporter = OtlpGrpcMetricExporter.builder()
Copy link
Contributor

Choose a reason for hiding this comment

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

nice rename

metricExporter = OtlpGrpcMetricExporter.builder()
.setEndpoint(otelEndpoint).build();
SdkMeterProvider meterProvider = SdkMeterProvider.builder()
initialize(metricEmittingApp, sdkTracerProvider, resource);
}

@VisibleForTesting
void initializeWithInMemoryExporter(MetricEmittingApp metricEmittingApp) {
Copy link
Contributor

Choose a reason for hiding this comment

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

if this is only for testing, it is worth moving this out and placing it in the test class?

Copy link
Contributor Author

@xiaohansong xiaohansong Jun 16, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

Sure - good call. moved

Resource resource = Resource.getDefault().toBuilder().put(SERVICE_NAME, metricEmittingApp.getApplicationName()).build();
metricExporter = InMemoryMetricExporter.create();
SdkTracerProvider sdkTracerProvider = SdkTracerProvider.builder()
.setResource(resource)
.build();
initialize(metricEmittingApp, sdkTracerProvider, resource);
}

@VisibleForTesting
InMemoryMetricExporter getInMemoryMetricExporter() {
Copy link
Contributor

Choose a reason for hiding this comment

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

is there a reason to explicitly return InMemoryMetricExporter instead of the generic MetricExporter?

can we make a generic getter function getMetricExporter similar to getSdkMeterProvider?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure - moved the casting in the test class

return (InMemoryMetricExporter) metricExporter;
}

@VisibleForTesting
SdkMeterProvider getSdkMeterProvider() {
return meterProvider;
}

private void initialize(MetricEmittingApp metricEmittingApp, SdkTracerProvider sdkTracerProvider, Resource resource) {
meterProvider = SdkMeterProvider.builder()
.registerMetricReader(PeriodicMetricReader.builder(metricExporter).build())
.setResource(resource)
.build();
Expand Down
81 changes: 64 additions & 17 deletions ...trics/metrics-lib/src/test/java/io/airbyte/metrics/lib/OpenTelemetryMetricClientTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,32 @@

package io.airbyte.metrics.lib;

import static org.assertj.core.api.AssertionsForClassTypes.assertThat;

import com.google.common.collect.Iterables;
import io.opentelemetry.api.common.AttributeKey;
import io.opentelemetry.sdk.metrics.SdkMeterProvider;
import io.opentelemetry.sdk.metrics.data.MetricData;
import io.opentelemetry.sdk.testing.exporter.InMemoryMetricExporter;
import java.util.List;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;

class OpenTelemetryMetricClientTest {

OpenTelemetryMetricClient openTelemetryMetricClient;
private final static String EXPORTER_ENDPOINT = "http://localhost:4322";
private final static String TAG = "tag1";
private InMemoryMetricExporter metricExporter;
private SdkMeterProvider metricProvider;

@BeforeEach
void setUp() {
openTelemetryMetricClient = new OpenTelemetryMetricClient();
openTelemetryMetricClient.initialize(MetricEmittingApps.WORKER, EXPORTER_ENDPOINT);
openTelemetryMetricClient.initializeWithInMemoryExporter(MetricEmittingApps.WORKER);
metricExporter = openTelemetryMetricClient.getInMemoryMetricExporter();
metricProvider = openTelemetryMetricClient.getSdkMeterProvider();
}

@AfterEach
Expand All @@ -27,27 +38,63 @@ void tearDown() {
}

@Test
@DisplayName("there should be no exception if we attempt to emit metrics while publish is false")
public void testPublishTrueNoEmitError() {
Assertions.assertDoesNotThrow(() -> {
openTelemetryMetricClient.gauge(OssMetricsRegistry.KUBE_POD_PROCESS_CREATE_TIME_MILLISECS, 1);
});
@DisplayName("Should send out count metric with correct metric name, description and value")
public void testCountSuccess() {
openTelemetryMetricClient.count(OssMetricsRegistry.KUBE_POD_PROCESS_CREATE_TIME_MILLISECS, 1);

metricProvider.forceFlush();
List<MetricData> metricDataList = metricExporter.getFinishedMetricItems();
MetricData data = Iterables.getOnlyElement(metricDataList);

assertThat(data.getName()).isEqualTo(OssMetricsRegistry.KUBE_POD_PROCESS_CREATE_TIME_MILLISECS.getMetricName());
assertThat(data.getDescription()).isEqualTo(OssMetricsRegistry.KUBE_POD_PROCESS_CREATE_TIME_MILLISECS.getMetricDescription());
assertThat(data.getLongSumData().getPoints().stream().anyMatch(longPointData -> longPointData.getValue() == 1L));
}

@Test
@DisplayName("Tags should be passed into metrics")
public void testCountWithTagSuccess() {
openTelemetryMetricClient.count(OssMetricsRegistry.KUBE_POD_PROCESS_CREATE_TIME_MILLISECS, 1, TAG);

metricProvider.forceFlush();
List<MetricData> metricDataList = metricExporter.getFinishedMetricItems();
MetricData data = Iterables.getOnlyElement(metricDataList);

assertThat(data.getName()).isEqualTo(OssMetricsRegistry.KUBE_POD_PROCESS_CREATE_TIME_MILLISECS.getMetricName());
assertThat(data.getDescription()).isEqualTo(OssMetricsRegistry.KUBE_POD_PROCESS_CREATE_TIME_MILLISECS.getMetricDescription());
assertThat(data.getLongSumData().getPoints().stream()
.anyMatch(
longPointData -> longPointData.getValue() == 1L && longPointData.getAttributes().get(AttributeKey.stringKey(TAG)).equals(TAG)));
}

@Test
@DisplayName("there should be no exception if we attempt to emit metrics while publish is true")
public void testPublishFalseNoEmitError() {
Assertions.assertDoesNotThrow(() -> {
openTelemetryMetricClient.gauge(OssMetricsRegistry.KUBE_POD_PROCESS_CREATE_TIME_MILLISECS, 1);
});
@DisplayName("Should send out gauge metric with correct metric name, description and value")
public void testGaugeSuccess() throws Exception {
openTelemetryMetricClient.gauge(OssMetricsRegistry.KUBE_POD_PROCESS_CREATE_TIME_MILLISECS, 1);

metricProvider.forceFlush();
List<MetricData> metricDataList = metricExporter.getFinishedMetricItems();
MetricData data = Iterables.getOnlyElement(metricDataList);

assertThat(data.getName()).isEqualTo(OssMetricsRegistry.KUBE_POD_PROCESS_CREATE_TIME_MILLISECS.getMetricName());
assertThat(data.getDescription()).isEqualTo(OssMetricsRegistry.KUBE_POD_PROCESS_CREATE_TIME_MILLISECS.getMetricDescription());
assertThat(data.getDoubleGaugeData().getPoints().stream().anyMatch(doublePointData -> doublePointData.getValue() == 1.0));
}

@Test
@DisplayName("there should be no exception if we attempt to emit metrics without initializing")
@DisplayName("Should send out histogram metric with correct metric name, description and value")
public void testNoInitializeNoEmitError() {
Copy link
Contributor

Choose a reason for hiding this comment

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

should this function name be changed?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

oops sure, fixed

Assertions.assertDoesNotThrow(() -> {
openTelemetryMetricClient.gauge(OssMetricsRegistry.KUBE_POD_PROCESS_CREATE_TIME_MILLISECS, 1);
});
openTelemetryMetricClient.distribution(OssMetricsRegistry.KUBE_POD_PROCESS_CREATE_TIME_MILLISECS, 10);
openTelemetryMetricClient.distribution(OssMetricsRegistry.KUBE_POD_PROCESS_CREATE_TIME_MILLISECS, 30);

metricProvider.forceFlush();
List<MetricData> metricDataList = metricExporter.getFinishedMetricItems();
MetricData data = Iterables.getOnlyElement(metricDataList);

assertThat(data.getName()).isEqualTo(OssMetricsRegistry.KUBE_POD_PROCESS_CREATE_TIME_MILLISECS.getMetricName());
assertThat(data.getDescription()).isEqualTo(OssMetricsRegistry.KUBE_POD_PROCESS_CREATE_TIME_MILLISECS.getMetricDescription());
assertThat(data.getHistogramData().getPoints().stream().anyMatch(histogramPointData -> histogramPointData.getMax() == 30.0));
assertThat(data.getHistogramData().getPoints().stream().anyMatch(histogramPointData -> histogramPointData.getMin() == 10.0));
}

}
2 changes: 2 additions & 0 deletions deps.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,8 @@ findsecbugs-plugin = { module = "com.h3xstream.findsecbugs:findsecbugs-plugin",
spotbugs-annotations = { module = "com.github.spotbugs:spotbugs-annotations", version = "4.6.0" }
otel-bom = {module = "io.opentelemetry:opentelemetry-bom", version = "1.14.0"}
otel-semconv = {module = "io.opentelemetry:opentelemetry-semconv", version = "1.14.0-alpha"}
otel-sdk = {module = "io.opentelemetry:opentelemetry-sdk-metrics", version = "1.14.0"}
otel-sdk-testing = {module = "io.opentelemetry:opentelemetry-sdk-metrics-testing", version = "1.13.0-alpha"}

[bundles]
jackson = ["jackson-databind", "jackson-annotations", "jackson-dataformat", "jackson-datatype"]
Expand Down