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

Fix for the flaky OTel log test - by synchronizing the evictions #5363

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix for the flaky OTel log test - by synchronizing the evictions #5363

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions data-prepper-plugins/otel-trace-raw-processor/build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ dependencies {
implementation 'com.fasterxml.jackson.dataformat:jackson-dataformat-yaml'
implementation libs.caffeine
testImplementation 'org.assertj:assertj-core:3.25.3'
testImplementation project(':data-prepper-test-common')
}

jacocoTestCoverageVerification {
Expand Down
110 changes: 61 additions & 49 deletions ...ava/org/opensearch/dataprepper/plugins/processor/oteltrace/OTelTraceRawProcessorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.github.benmanes.caffeine.cache.Cache;
import com.github.benmanes.caffeine.cache.Caffeine;
import org.assertj.core.api.Assertions;
import org.hamcrest.MatcherAssert;
import org.junit.jupiter.api.AfterEach;
Expand All @@ -22,6 +24,8 @@
import org.opensearch.dataprepper.model.trace.JacksonSpan;
import org.opensearch.dataprepper.model.trace.Span;
import org.opensearch.dataprepper.model.trace.TraceGroupFields;
import org.opensearch.dataprepper.plugins.processor.oteltrace.model.TraceGroup;
import org.opensearch.dataprepper.test.helper.ReflectivelySetField;

import java.io.IOException;
import java.io.InputStream;
Expand Down Expand Up @@ -65,27 +69,67 @@ class OTelTraceRawProcessorTest {
private static final String TEST_TRACE_GROUP_2_ROOT_SPAN_JSON_FILE = "trace-group-2-root-span.json";
private static final String TEST_TRACE_GROUP_2_CHILD_SPAN_1_JSON_FILE = "trace-group-2-child-span-1.json";
private static final String TEST_TRACE_GROUP_2_CHILD_SPAN_2_JSON_FILE = "trace-group-2-child-span-2.json";

public OTelTraceRawProcessor oTelTraceRawProcessor;
public ExecutorService executorService;
private Span TEST_TRACE_GROUP_1_ROOT_SPAN;
private Span TEST_TRACE_GROUP_1_CHILD_SPAN_1;
private Span TEST_TRACE_GROUP_1_CHILD_SPAN_2;
private Span TEST_TRACE_GROUP_2_ROOT_SPAN;
private Span TEST_TRACE_GROUP_2_CHILD_SPAN_1;
private Span TEST_TRACE_GROUP_2_CHILD_SPAN_2;

private List<Record<Span>> TEST_ONE_FULL_TRACE_GROUP_RECORDS;
private List<Record<Span>> TEST_ONE_TRACE_GROUP_MISSING_ROOT_RECORDS;
private List<Record<Span>> TEST_TWO_FULL_TRACE_GROUP_RECORDS;
private List<Record<Span>> TEST_TWO_TRACE_GROUP_INTERLEAVED_PART_1_RECORDS;
private List<Record<Span>> TEST_TWO_TRACE_GROUP_INTERLEAVED_PART_2_RECORDS;
private List<Record<Span>> TEST_TWO_TRACE_GROUP_MISSING_ROOT_RECORDS;

private OtelTraceRawProcessorConfig config;
private PluginMetrics pluginMetrics;
public OTelTraceRawProcessor oTelTraceRawProcessor;
public ExecutorService executorService;
private PipelineDescription pipelineDescription;

private static Span buildSpanFromJsonFile(final String jsonFileName) {
JacksonSpan.Builder spanBuilder = JacksonSpan.builder();
try (final InputStream inputStream = Objects.requireNonNull(
OTelTraceRawProcessorTest.class.getClassLoader().getResourceAsStream(jsonFileName))) {
final Map<String, Object> spanMap = OBJECT_MAPPER.readValue(inputStream, new TypeReference<Map<String, Object>>() {
});
final String traceId = (String) spanMap.get("traceId");
final String spanId = (String) spanMap.get("spanId");
final String parentSpanId = (String) spanMap.get("parentSpanId");
final String traceState = (String) spanMap.get("traceState");
final String name = (String) spanMap.get("name");
final String kind = (String) spanMap.get("kind");
final Long durationInNanos = ((Number) spanMap.get("durationInNanos")).longValue();
final String startTime = (String) spanMap.get("startTime");
final String endTime = (String) spanMap.get("endTime");
spanBuilder = spanBuilder
.withTraceId(traceId)
.withSpanId(spanId)
.withParentSpanId(parentSpanId)
.withTraceState(traceState)
.withName(name)
.withKind(kind)
.withDurationInNanos(durationInNanos)
.withStartTime(startTime)
.withEndTime(endTime)
.withTraceGroup(null);
DefaultTraceGroupFields.Builder traceGroupFieldsBuilder = DefaultTraceGroupFields.builder();
if (parentSpanId.isEmpty()) {
final Integer statusCode = (Integer) ((Map<String, Object>) spanMap.get("traceGroupFields")).get("statusCode");
traceGroupFieldsBuilder = traceGroupFieldsBuilder
.withStatusCode(statusCode)
.withEndTime(endTime)
.withDurationInNanos(durationInNanos);
final String traceGroup = (String) spanMap.get("traceGroup");
spanBuilder = spanBuilder.withTraceGroup(traceGroup);
}
spanBuilder.withTraceGroupFields(traceGroupFieldsBuilder.build());
} catch (IOException e) {
throw new RuntimeException(e);
}
return spanBuilder.build();
}

@BeforeEach
void setup() {
TEST_TRACE_GROUP_1_ROOT_SPAN = buildSpanFromJsonFile(TEST_TRACE_GROUP_1_ROOT_SPAN_JSON_FILE);
Expand Down Expand Up @@ -255,13 +299,23 @@ void testMetricsOnSpanSet() {
"1, 4",
"2, 6"
})
void traceGroupCacheMaxSize_provides_an_upper_bound(final long cacheMaxSize, final int expectedProcessedRecords) {
void traceGroupCacheMaxSize_provides_an_upper_bound(final long cacheMaxSize, final int expectedProcessedRecords)
throws NoSuchFieldException, IllegalAccessException {
reset(config);
when(config.getTraceFlushIntervalSeconds()).thenReturn(TEST_TRACE_FLUSH_INTERVAL);
when(config.getTraceGroupCacheMaxSize()).thenReturn(cacheMaxSize);
when(config.getTraceGroupCacheTimeToLive()).thenReturn(OtelTraceRawProcessorConfig.DEFAULT_TRACE_ID_TTL);

oTelTraceRawProcessor = new OTelTraceRawProcessor(config, pipelineDescription, pluginMetrics);
// By default Caffeine evictions are async so not guaranteed to happen within the test execution
// by adding executor(Runnable::run) makes the operations synchronous
final Cache<String, TraceGroup> traceIdTraceGroupCache = Caffeine.newBuilder()
.maximumSize(cacheMaxSize)
.executor(Runnable::run)
.expireAfterWrite(OtelTraceRawProcessorConfig.DEFAULT_TRACE_ID_TTL.toMillis(), TimeUnit.MILLISECONDS)
.build();
ReflectivelySetField.setField(OTelTraceRawProcessor.class, oTelTraceRawProcessor,
"traceIdTraceGroupCache", traceIdTraceGroupCache);

final Collection<Record<Span>> processedRecords = new ArrayList<>();
processedRecords.addAll(oTelTraceRawProcessor.doExecute(TEST_TWO_TRACE_GROUP_INTERLEAVED_PART_1_RECORDS));
Expand Down Expand Up @@ -293,48 +347,6 @@ void traceGroupCacheTimeToLive_causes_trace_group_expiry(final long traceIdTtlMi
MatcherAssert.assertThat(getMissingTraceGroupFieldsSpanCount(processedRecords), equalTo(0));
}

private static Span buildSpanFromJsonFile(final String jsonFileName) {
JacksonSpan.Builder spanBuilder = JacksonSpan.builder();
try (final InputStream inputStream = Objects.requireNonNull(
OTelTraceRawProcessorTest.class.getClassLoader().getResourceAsStream(jsonFileName))){
final Map<String, Object> spanMap = OBJECT_MAPPER.readValue(inputStream, new TypeReference<Map<String, Object>>() {});
final String traceId = (String) spanMap.get("traceId");
final String spanId = (String) spanMap.get("spanId");
final String parentSpanId = (String) spanMap.get("parentSpanId");
final String traceState = (String) spanMap.get("traceState");
final String name = (String) spanMap.get("name");
final String kind = (String) spanMap.get("kind");
final Long durationInNanos = ((Number) spanMap.get("durationInNanos")).longValue();
final String startTime = (String) spanMap.get("startTime");
final String endTime = (String) spanMap.get("endTime");
spanBuilder = spanBuilder
.withTraceId(traceId)
.withSpanId(spanId)
.withParentSpanId(parentSpanId)
.withTraceState(traceState)
.withName(name)
.withKind(kind)
.withDurationInNanos(durationInNanos)
.withStartTime(startTime)
.withEndTime(endTime)
.withTraceGroup(null);
DefaultTraceGroupFields.Builder traceGroupFieldsBuilder = DefaultTraceGroupFields.builder();
if (parentSpanId.isEmpty()) {
final Integer statusCode = (Integer) ((Map<String, Object>) spanMap.get("traceGroupFields")).get("statusCode");
traceGroupFieldsBuilder = traceGroupFieldsBuilder
.withStatusCode(statusCode)
.withEndTime(endTime)
.withDurationInNanos(durationInNanos);
final String traceGroup = (String) spanMap.get("traceGroup");
spanBuilder = spanBuilder.withTraceGroup(traceGroup);
}
spanBuilder.withTraceGroupFields(traceGroupFieldsBuilder.build());
} catch (IOException e) {
throw new RuntimeException(e);
}
return spanBuilder.build();
}

private List<Future<Collection<Record<Span>>>> submitRecords(Collection<Record<Span>> records) {
final List<Future<Collection<Record<Span>>>> futures = new ArrayList<>();
futures.add(executorService.submit(() -> oTelTraceRawProcessor.doExecute(records)));
Expand All @@ -343,7 +355,7 @@ private List<Future<Collection<Record<Span>>>> submitRecords(Collection<Record<S

private int getMissingTraceGroupFieldsSpanCount(final Collection<Record<Span>> records) {
int count = 0;
for (Record<Span> record: records) {
for (Record<Span> record : records) {
final Span span = record.getData();
final String traceGroup = span.getTraceGroup();
final TraceGroupFields traceGroupFields = span.getTraceGroupFields();
Expand Down
Loading