Skip to content

Commit

Permalink
Add unit tests
Browse files Browse the repository at this point in the history 
Signed-off-by: Gagan Juneja <[email protected]>
  • Loading branch information
Gagan Juneja committed Oct 4, 2023
1 parent 75c246e commit 23cf7f4
Show file tree
Hide file tree
Showing 6 changed files with 57 additions and 30 deletions.
5 changes: 4 additions & 1 deletion plugins/telemetry-otel/src/main/java/org/opensearch/telemetry/OTelTelemetryPlugin.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,10 @@ public String getName() {

private Telemetry telemetry(TelemetrySettings telemetrySettings) {
final OpenTelemetrySdk openTelemetry = OTelResourceProvider.get(telemetrySettings, settings);
return new OTelTelemetry(new OTelTracingTelemetry(openTelemetry), new OTelMetricsTelemetry(openTelemetry));
return new OTelTelemetry(
new OTelTracingTelemetry(openTelemetry, () -> openTelemetry.getSdkTracerProvider().close()),
new OTelMetricsTelemetry(openTelemetry, () -> openTelemetry.getSdkMeterProvider().close())
);
}

}
14 changes: 8 additions & 6 deletions ...s/telemetry-otel/src/main/java/org/opensearch/telemetry/metrics/OTelMetricsTelemetry.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,29 +12,32 @@
import org.apache.logging.log4j.Logger;
import org.opensearch.telemetry.OTelTelemetryPlugin;

import java.io.Closeable;
import java.security.AccessController;
import java.security.PrivilegedAction;

import io.opentelemetry.api.OpenTelemetry;
import io.opentelemetry.api.metrics.DoubleCounter;
import io.opentelemetry.api.metrics.DoubleUpDownCounter;
import io.opentelemetry.api.metrics.Meter;
import io.opentelemetry.sdk.OpenTelemetrySdk;

/**
* OTel implementation for {@link MetricsTelemetry}
*/
public class OTelMetricsTelemetry implements MetricsTelemetry {
private static final Logger logger = LogManager.getLogger(OTelMetricsTelemetry.class);
private final OpenTelemetrySdk openTelemetry;
private final OpenTelemetry openTelemetry;
private final Meter otelMeter;
private final Closeable metricsProviderClosable;

/**
* Constructor.
* @param openTelemetry telemetry.
*/
public OTelMetricsTelemetry(OpenTelemetrySdk openTelemetry) {
public OTelMetricsTelemetry(OpenTelemetry openTelemetry, Closeable metricsProviderClosable) {
this.openTelemetry = openTelemetry;
this.otelMeter = openTelemetry.getMeter(OTelTelemetryPlugin.INSTRUMENTATION_SCOPE_NAME);
this.metricsProviderClosable = metricsProviderClosable;
}

@Override
Expand Down Expand Up @@ -63,11 +66,10 @@ public Counter createUpDownCounter(String name, String description, String unit)

@Override
public void close() {
// There is no harm closing the openTelemetry multiple times.
try {
openTelemetry.getSdkMeterProvider().close();
metricsProviderClosable.close();
} catch (Exception e) {
logger.warn("Error while closing Opentelemetry", e);
logger.warn("Error while closing Opentelemetry MeterProvider", e);
}
}
}
15 changes: 9 additions & 6 deletions ...s/telemetry-otel/src/main/java/org/opensearch/telemetry/tracing/OTelTracingTelemetry.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,34 +13,37 @@
import org.opensearch.telemetry.OTelAttributesConverter;
import org.opensearch.telemetry.OTelTelemetryPlugin;

import java.io.Closeable;

import io.opentelemetry.api.OpenTelemetry;
import io.opentelemetry.context.Context;
import io.opentelemetry.sdk.OpenTelemetrySdk;

/**
* OTel based Telemetry provider
*/
public class OTelTracingTelemetry implements TracingTelemetry {

private static final Logger logger = LogManager.getLogger(OTelTracingTelemetry.class);
private final OpenTelemetrySdk openTelemetry;
private final OpenTelemetry openTelemetry;
private final Closeable tracerProviderClosable;
private final io.opentelemetry.api.trace.Tracer otelTracer;

/**
* Creates OTel based Telemetry
* @param openTelemetry OpenTelemetry instance
*/
public OTelTracingTelemetry(OpenTelemetrySdk openTelemetry) {
public OTelTracingTelemetry(OpenTelemetry openTelemetry, Closeable tracerProviderClosable) {
this.openTelemetry = openTelemetry;
this.otelTracer = openTelemetry.getTracer(OTelTelemetryPlugin.INSTRUMENTATION_SCOPE_NAME);

this.tracerProviderClosable = tracerProviderClosable;
}

@Override
public void close() {
try {
openTelemetry.getSdkTracerProvider().close();
tracerProviderClosable.close();
} catch (Exception e) {
logger.warn("Error while closing Opentelemetry", e);
logger.warn("Error while closing Opentelemetry TracerProvider", e);
}
}

Expand Down
1 change: 1 addition & 0 deletions plugins/telemetry-otel/src/test/java/org/opensearch/telemetry/OTelTelemetryPluginTests.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -78,5 +78,6 @@ public void testGetTelemetry() {
@After
public void cleanup() {
tracingTelemetry.close();
metricsTelemetry.close();
}
}
24 changes: 17 additions & 7 deletions ...emetry-otel/src/test/java/org/opensearch/telemetry/metrics/OTelMetricsTelemetryTests.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,16 @@
import org.opensearch.telemetry.metrics.tags.Tags;
import org.opensearch.test.OpenSearchTestCase;

import java.util.concurrent.atomic.AtomicBoolean;

import io.opentelemetry.api.OpenTelemetry;
import io.opentelemetry.api.metrics.DoubleCounter;
import io.opentelemetry.api.metrics.DoubleCounterBuilder;
import io.opentelemetry.api.metrics.DoubleUpDownCounter;
import io.opentelemetry.api.metrics.DoubleUpDownCounterBuilder;
import io.opentelemetry.api.metrics.LongCounterBuilder;
import io.opentelemetry.api.metrics.LongUpDownCounterBuilder;
import io.opentelemetry.api.metrics.Meter;
import io.opentelemetry.sdk.OpenTelemetrySdk;

import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
Expand All @@ -32,14 +34,14 @@ public void testCounter() {
String counterName = "test-counter";
String description = "test";
String unit = "1";
OpenTelemetrySdk mockOpenTelemetry = mock(OpenTelemetrySdk.class);
OpenTelemetry mockOpenTelemetry = mock(OpenTelemetry.class);
Meter mockMeter = mock(Meter.class);
DoubleCounter mockOTelDoubleCounter = mock(DoubleCounter.class);
LongCounterBuilder mockOTelLongCounterBuilder = mock(LongCounterBuilder.class);
DoubleCounterBuilder mockOTelDoubleCounterBuilder = mock(DoubleCounterBuilder.class);

when(mockOpenTelemetry.getMeter(OTelTelemetryPlugin.INSTRUMENTATION_SCOPE_NAME)).thenReturn(mockMeter);
MetricsTelemetry metricsTelemetry = new OTelMetricsTelemetry(mockOpenTelemetry);
MetricsTelemetry metricsTelemetry = new OTelMetricsTelemetry(mockOpenTelemetry, () -> {});
when(mockMeter.counterBuilder(counterName)).thenReturn(mockOTelLongCounterBuilder);
when(mockOTelLongCounterBuilder.setDescription(description)).thenReturn(mockOTelLongCounterBuilder);
when(mockOTelLongCounterBuilder.setUnit(unit)).thenReturn(mockOTelLongCounterBuilder);
Expand All @@ -58,14 +60,14 @@ public void testCounterNegativeValue() {
String counterName = "test-counter";
String description = "test";
String unit = "1";
OpenTelemetrySdk mockOpenTelemetry = mock(OpenTelemetrySdk.class);
OpenTelemetry mockOpenTelemetry = mock(OpenTelemetry.class);
Meter mockMeter = mock(Meter.class);
DoubleCounter mockOTelDoubleCounter = mock(DoubleCounter.class);
LongCounterBuilder mockOTelLongCounterBuilder = mock(LongCounterBuilder.class);
DoubleCounterBuilder mockOTelDoubleCounterBuilder = mock(DoubleCounterBuilder.class);

when(mockOpenTelemetry.getMeter(OTelTelemetryPlugin.INSTRUMENTATION_SCOPE_NAME)).thenReturn(mockMeter);
MetricsTelemetry metricsTelemetry = new OTelMetricsTelemetry(mockOpenTelemetry);
MetricsTelemetry metricsTelemetry = new OTelMetricsTelemetry(mockOpenTelemetry, () -> {});
when(mockMeter.counterBuilder(counterName)).thenReturn(mockOTelLongCounterBuilder);
when(mockOTelLongCounterBuilder.setDescription(description)).thenReturn(mockOTelLongCounterBuilder);
when(mockOTelLongCounterBuilder.setUnit(unit)).thenReturn(mockOTelLongCounterBuilder);
Expand All @@ -81,14 +83,14 @@ public void testUpDownCounter() {
String counterName = "test-counter";
String description = "test";
String unit = "1";
OpenTelemetrySdk mockOpenTelemetry = mock(OpenTelemetrySdk.class);
OpenTelemetry mockOpenTelemetry = mock(OpenTelemetry.class);
Meter mockMeter = mock(Meter.class);
DoubleUpDownCounter mockOTelUpDownDoubleCounter = mock(DoubleUpDownCounter.class);
LongUpDownCounterBuilder mockOTelLongUpDownCounterBuilder = mock(LongUpDownCounterBuilder.class);
DoubleUpDownCounterBuilder mockOTelDoubleUpDownCounterBuilder = mock(DoubleUpDownCounterBuilder.class);

when(mockOpenTelemetry.getMeter(OTelTelemetryPlugin.INSTRUMENTATION_SCOPE_NAME)).thenReturn(mockMeter);
MetricsTelemetry metricsTelemetry = new OTelMetricsTelemetry(mockOpenTelemetry);
MetricsTelemetry metricsTelemetry = new OTelMetricsTelemetry(mockOpenTelemetry, () -> {});
when(mockMeter.upDownCounterBuilder(counterName)).thenReturn(mockOTelLongUpDownCounterBuilder);
when(mockOTelLongUpDownCounterBuilder.setDescription(description)).thenReturn(mockOTelLongUpDownCounterBuilder);
when(mockOTelLongUpDownCounterBuilder.setUnit(unit)).thenReturn(mockOTelLongUpDownCounterBuilder);
Expand All @@ -102,4 +104,12 @@ public void testUpDownCounter() {
counter.add(-2.0, tags);
verify(mockOTelUpDownDoubleCounter).add((-2.0), OTelAttributesConverter.convert(tags));
}

public void testClose() {
OpenTelemetry mockOpenTelemetry = mock(OpenTelemetry.class);
final AtomicBoolean closed = new AtomicBoolean(false);
MetricsTelemetry metricsTelemetry = new OTelMetricsTelemetry(mockOpenTelemetry, () -> closed.set(true));
metricsTelemetry.close();
assertTrue(closed.get());
}
}
28 changes: 18 additions & 10 deletions ...emetry-otel/src/test/java/org/opensearch/telemetry/tracing/OTelTracingTelemetryTests.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,12 @@

import java.util.Collections;
import java.util.Map;
import java.util.concurrent.atomic.AtomicBoolean;

import io.opentelemetry.api.OpenTelemetry;
import io.opentelemetry.api.common.AttributesBuilder;
import io.opentelemetry.api.trace.SpanBuilder;
import io.opentelemetry.api.trace.Tracer;
import io.opentelemetry.sdk.OpenTelemetrySdk;

import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.mock;
Expand All @@ -27,9 +28,8 @@
import static org.mockito.Mockito.when;

public class OTelTracingTelemetryTests extends OpenSearchTestCase {

public void testCreateSpanWithoutParent() {
OpenTelemetrySdk mockOpenTelemetry = mock(OpenTelemetrySdk.class);
OpenTelemetry mockOpenTelemetry = mock(OpenTelemetry.class);
Tracer mockTracer = mock(Tracer.class);
when(mockOpenTelemetry.getTracer(OTelTelemetryPlugin.INSTRUMENTATION_SCOPE_NAME)).thenReturn(mockTracer);
SpanBuilder mockSpanBuilder = mock(SpanBuilder.class);
Expand All @@ -39,15 +39,15 @@ public void testCreateSpanWithoutParent() {
when(mockSpanBuilder.setSpanKind(any(io.opentelemetry.api.trace.SpanKind.class))).thenReturn(mockSpanBuilder);
Map<String, String> attributeMap = Collections.singletonMap("name", "value");
Attributes attributes = Attributes.create().addAttribute("name", "value");
TracingTelemetry tracingTelemetry = new OTelTracingTelemetry(mockOpenTelemetry);
TracingTelemetry tracingTelemetry = new OTelTracingTelemetry(mockOpenTelemetry, () -> {});
Span span = tracingTelemetry.createSpan(SpanCreationContext.internal().name("span_name").attributes(attributes), null);
verify(mockSpanBuilder, never()).setParent(any());
verify(mockSpanBuilder).setAllAttributes(createAttribute(attributes));
assertNull(span.getParentSpan());
}

public void testCreateSpanWithParent() {
OpenTelemetrySdk mockOpenTelemetry = mock(OpenTelemetrySdk.class);
OpenTelemetry mockOpenTelemetry = mock(OpenTelemetry.class);
Tracer mockTracer = mock(Tracer.class);
when(mockOpenTelemetry.getTracer(OTelTelemetryPlugin.INSTRUMENTATION_SCOPE_NAME)).thenReturn(mockTracer);
SpanBuilder mockSpanBuilder = mock(SpanBuilder.class);
Expand All @@ -59,7 +59,7 @@ public void testCreateSpanWithParent() {

Span parentSpan = new OTelSpan("parent_span", mock(io.opentelemetry.api.trace.Span.class), null);

TracingTelemetry tracingTelemetry = new OTelTracingTelemetry(mockOpenTelemetry);
TracingTelemetry tracingTelemetry = new OTelTracingTelemetry(mockOpenTelemetry, () -> {});
Attributes attributes = Attributes.create().addAttribute("name", 1l);
Span span = tracingTelemetry.createSpan(SpanCreationContext.internal().name("span_name").attributes(attributes), parentSpan);

Expand All @@ -71,7 +71,7 @@ public void testCreateSpanWithParent() {
}

public void testCreateSpanWithParentWithMultipleAttributes() {
OpenTelemetrySdk mockOpenTelemetry = mock(OpenTelemetrySdk.class);
OpenTelemetry mockOpenTelemetry = mock(OpenTelemetry.class);
Tracer mockTracer = mock(Tracer.class);
when(mockOpenTelemetry.getTracer(OTelTelemetryPlugin.INSTRUMENTATION_SCOPE_NAME)).thenReturn(mockTracer);
SpanBuilder mockSpanBuilder = mock(SpanBuilder.class);
Expand All @@ -83,7 +83,7 @@ public void testCreateSpanWithParentWithMultipleAttributes() {

Span parentSpan = new OTelSpan("parent_span", mock(io.opentelemetry.api.trace.Span.class), null);

TracingTelemetry tracingTelemetry = new OTelTracingTelemetry(mockOpenTelemetry);
TracingTelemetry tracingTelemetry = new OTelTracingTelemetry(mockOpenTelemetry, () -> {});
Attributes attributes = Attributes.create()
.addAttribute("key1", 1l)
.addAttribute("key2", 2.0)
Expand Down Expand Up @@ -117,13 +117,21 @@ private io.opentelemetry.api.common.Attributes createAttributeLong(Attributes at
}

public void testGetContextPropagator() {
OpenTelemetrySdk mockOpenTelemetry = mock(OpenTelemetrySdk.class);
OpenTelemetry mockOpenTelemetry = mock(OpenTelemetry.class);
Tracer mockTracer = mock(Tracer.class);
when(mockOpenTelemetry.getTracer(OTelTelemetryPlugin.INSTRUMENTATION_SCOPE_NAME)).thenReturn(mockTracer);

TracingTelemetry tracingTelemetry = new OTelTracingTelemetry(mockOpenTelemetry);
TracingTelemetry tracingTelemetry = new OTelTracingTelemetry(mockOpenTelemetry, () -> {});

assertTrue(tracingTelemetry.getContextPropagator() instanceof OTelTracingContextPropagator);
}

public void testClose() {
OpenTelemetry mockOpenTelemetry = mock(OpenTelemetry.class);
final AtomicBoolean closed = new AtomicBoolean(false);
TracingTelemetry tracingTelemetry = new OTelTracingTelemetry(mockOpenTelemetry, () -> closed.set(true));
tracingTelemetry.close();
assertTrue(closed.get());
}

}

0 comments on commit 23cf7f4

Please sign in to comment.