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

EventHubs: Fix Span links on send #28951

Merged
merged 5 commits into from
May 23, 2022
Merged

EventHubs: Fix Span links on send #28951

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5e36bf0
Fix link population on send
lmolkova May 19, 2022
9e44afc
tests
lmolkova May 19, 2022
1b3e7c9
oops
lmolkova May 19, 2022
eacc79f
review
lmolkova May 23, 2022
b8748d4
changelog and link issue
lmolkova May 23, 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
8 changes: 4 additions & 4 deletions ...azure-messaging-eventhubs/src/main/java/com/azure/messaging/eventhubs/EventDataBatch.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,13 +155,13 @@ private EventData traceMessageSpan(EventData eventData) {
.addData(AZ_TRACING_NAMESPACE_KEY, AZ_NAMESPACE_VALUE)
.addData(ENTITY_PATH_KEY, this.entityPath)
.addData(HOST_NAME_KEY, this.hostname);
Context eventSpanContext = tracerProvider.startSpan(AZ_TRACING_SERVICE_NAME, eventContext,
eventContext = tracerProvider.startSpan(AZ_TRACING_SERVICE_NAME, eventContext,
ProcessKind.MESSAGE);
Optional<Object> eventDiagnosticIdOptional = eventSpanContext.getData(DIAGNOSTIC_ID_KEY);
Optional<Object> eventDiagnosticIdOptional = eventContext.getData(DIAGNOSTIC_ID_KEY);
if (eventDiagnosticIdOptional.isPresent()) {
eventData.getProperties().put(DIAGNOSTIC_ID_KEY, eventDiagnosticIdOptional.get().toString());
tracerProvider.endSpan(eventSpanContext, Signal.complete());
eventData.addContext(SPAN_CONTEXT_KEY, eventSpanContext);
tracerProvider.endSpan(eventContext, Signal.complete());
eventData.addContext(SPAN_CONTEXT_KEY, eventContext.getData(SPAN_CONTEXT_KEY).orElse(Context.NONE));
lmolkova marked this conversation as resolved.
Show resolved Hide resolved
}
}

Expand Down
24 changes: 13 additions & 11 deletions ...ng-eventhubs/src/main/java/com/azure/messaging/eventhubs/EventHubProducerAsyncClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -539,13 +539,21 @@ public Mono<Void> send(EventDataBatch batch) {
for (int i = 0; i < batch.getEvents().size(); i++) {
final EventData event = batch.getEvents().get(i);
if (isTracingEnabled) {
parentContext.set(event.getContext());
if (i == 0) {
sharedContext = tracerProvider.getSharedSpanBuilder(ClientConstants.AZ_TRACING_SERVICE_NAME,
parentContext.get());
sharedContext = event.getContext()
.addData(AZ_TRACING_NAMESPACE_KEY, AZ_NAMESPACE_VALUE)
.addData(ENTITY_PATH_KEY, eventHubName)
.addData(HOST_NAME_KEY, fullyQualifiedNamespace);

sharedContext = tracerProvider.getSharedSpanBuilder(ClientConstants.AZ_TRACING_SERVICE_NAME, sharedContext);
tracerProvider.addSpanLinks(sharedContext);
} else {
// TODO (lmolkova) we need better addSpanLinks(Context shared, Context link)
lmolkova marked this conversation as resolved.
Show resolved Hide resolved
Object eventSpanContext = event.getContext().getData(SPAN_CONTEXT_KEY).orElse(Context.NONE);
tracerProvider.addSpanLinks(sharedContext.addData(SPAN_CONTEXT_KEY, eventSpanContext));
}
tracerProvider.addSpanLinks(sharedContext.addData(SPAN_CONTEXT_KEY, event.getContext()));
}

final Message message = messageSerializer.serialize(event);

if (!CoreUtils.isNullOrEmpty(partitionKey)) {
Expand All @@ -559,14 +567,8 @@ public Mono<Void> send(EventDataBatch batch) {
}

if (isTracingEnabled) {
final Context finalSharedContext = sharedContext == null
? Context.NONE
: sharedContext
.addData(ENTITY_PATH_KEY, eventHubName)
.addData(HOST_NAME_KEY, fullyQualifiedNamespace)
.addData(AZ_TRACING_NAMESPACE_KEY, AZ_NAMESPACE_VALUE);
// Start send span and store updated context
parentContext.set(tracerProvider.startSpan(AZ_TRACING_SERVICE_NAME, finalSharedContext, ProcessKind.SEND));
parentContext.set(tracerProvider.startSpan(AZ_TRACING_SERVICE_NAME, sharedContext, ProcessKind.SEND));
}

final Mono<Void> sendMessage = getSendLink(batch.getPartitionId())
Expand Down
150 changes: 99 additions & 51 deletions ...venthubs/src/test/java/com/azure/messaging/eventhubs/EventHubProducerAsyncClientTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,22 +58,26 @@
import java.util.concurrent.Semaphore;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.concurrent.atomic.AtomicReference;

import static com.azure.core.util.tracing.Tracer.AZ_TRACING_NAMESPACE_KEY;
import static com.azure.core.util.tracing.Tracer.DIAGNOSTIC_ID_KEY;
import static com.azure.core.util.tracing.Tracer.ENTITY_PATH_KEY;
import static com.azure.core.util.tracing.Tracer.HOST_NAME_KEY;
import static com.azure.core.util.tracing.Tracer.PARENT_SPAN_KEY;
import static com.azure.core.util.tracing.Tracer.PARENT_TRACE_CONTEXT_KEY;
import static com.azure.core.util.tracing.Tracer.SPAN_BUILDER_KEY;
import static com.azure.core.util.tracing.Tracer.SPAN_CONTEXT_KEY;
import static com.azure.messaging.eventhubs.implementation.ClientConstants.AZ_NAMESPACE_VALUE;
import static java.nio.charset.StandardCharsets.UTF_8;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.anyList;
import static org.mockito.ArgumentMatchers.anyString;
import static org.mockito.ArgumentMatchers.argThat;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.ArgumentMatchers.isNull;
import static org.mockito.Mockito.doAnswer;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.times;
Expand Down Expand Up @@ -318,60 +322,69 @@ void partitionProducerCannotSendWithPartitionKey() {
*/
@Test
void sendStartSpanSingleMessage() {
final Flux<EventData> testData = Flux.just(
new EventData(TEST_CONTENTS.getBytes(UTF_8)));
final SendOptions sendOptions = new SendOptions();

// Arrange
final Tracer tracer1 = mock(Tracer.class);
final List<Tracer> tracers = Collections.singletonList(tracer1);
TracerProvider tracerProvider = new TracerProvider(tracers);
final Flux<EventData> testData = Flux.just(
new EventData(TEST_CONTENTS.getBytes(UTF_8)),
new EventData(TEST_CONTENTS.getBytes(UTF_8)));

final String partitionId = "my-partition-id";
final SendOptions sendOptions = new SendOptions()
.setPartitionId(partitionId);
final EventHubProducerAsyncClient asyncProducer = new EventHubProducerAsyncClient(HOSTNAME, EVENT_HUB_NAME,
connectionProcessor, retryOptions, tracerProvider, messageSerializer, Schedulers.parallel(),
false, onClientClosed);

when(connection.createSendLink(
argThat(name -> name.endsWith(partitionId)), argThat(name -> name.endsWith(partitionId)), eq(retryOptions)))
when(connection.createSendLink(eq(EVENT_HUB_NAME), eq(EVENT_HUB_NAME), any()))
.thenReturn(Mono.just(sendLink));

when(sendLink.getHostname()).thenReturn(HOSTNAME);
when(sendLink.getEntityPath()).thenReturn(EVENT_HUB_NAME);
when(sendLink.send(anyList())).thenReturn(Mono.empty());
when(sendLink.send(any(Message.class))).thenReturn(Mono.empty());

when(tracer1.start(eq("EventHubs.send"), any(), eq(ProcessKind.SEND))).thenAnswer(
invocation -> {
Context passed = invocation.getArgument(1, Context.class);
assertEquals(passed.getData(AZ_TRACING_NAMESPACE_KEY).get(), AZ_NAMESPACE_VALUE);
return passed.addData(PARENT_SPAN_KEY, "value");
return passed.addData(PARENT_TRACE_CONTEXT_KEY, "value");
}
);

when(tracer1.start(eq("EventHubs.message"), any(), eq(ProcessKind.MESSAGE))).thenAnswer(
invocation -> {
Context passed = invocation.getArgument(1, Context.class);
assertEquals(passed.getData(AZ_TRACING_NAMESPACE_KEY).get(), AZ_NAMESPACE_VALUE);
return passed.addData(PARENT_SPAN_KEY, "value").addData(DIAGNOSTIC_ID_KEY, "value2");
return passed.addData(PARENT_TRACE_CONTEXT_KEY, "value")
.addData(DIAGNOSTIC_ID_KEY, "diag-id")
.addData(SPAN_CONTEXT_KEY, "span-context");
}
);

when(tracer1.getSharedSpanBuilder(eq("EventHubs.send"), any())).thenAnswer(
invocation -> {
Context passed = invocation.getArgument(1, Context.class);
return passed.addData(SPAN_BUILDER_KEY, "value");
return passed.addData(SPAN_BUILDER_KEY, "span-builder");
}
);

doAnswer(
invocation -> {
Context passed = invocation.getArgument(0, Context.class);
assertEquals("span-builder", passed.getData(SPAN_BUILDER_KEY).orElseGet(null));
assertEquals("span-context", passed.getData(SPAN_CONTEXT_KEY).orElseGet(null));
return null;
}).when(tracer1).addLink(any());

// Act
StepVerifier.create(asyncProducer.send(testData, sendOptions))
.verifyComplete();

// Assert
//Assert
verify(tracer1, times(1))
.start(eq("EventHubs.send"), any(), eq(ProcessKind.SEND));
verify(tracer1, times(2))
verify(tracer1, times(1))
.start(eq("EventHubs.message"), any(), eq(ProcessKind.MESSAGE));
verify(tracer1, times(3)).end(eq("success"), isNull(), any());
verify(tracer1, times(2)).end(eq("success"), isNull(), any());
verify(tracer1, times(1)).getSharedSpanBuilder(eq("EventHubs.send"), any());
verify(tracer1, times(1)).addLink(any());

verifyNoInteractions(onClientClosed);
}
Expand All @@ -391,29 +404,25 @@ void sendMessageRetrySpanTest() {
tracerProvider, messageSerializer, Schedulers.parallel(), false, onClientClosed);

final String failureKey = "fail";
final EventData testData = new EventData("test");
final EventData testData = new EventData("test")
.addContext(SPAN_CONTEXT_KEY, "span-context");
testData.getProperties().put(failureKey, "true");

when(tracer1.start(eq("EventHubs.send"), any(), eq(ProcessKind.SEND))).thenAnswer(
invocation -> {
Context passed = invocation.getArgument(1, Context.class);
assertEquals(passed.getData(AZ_TRACING_NAMESPACE_KEY).get(), AZ_NAMESPACE_VALUE);
return passed.addData(PARENT_SPAN_KEY, "value").addData(HOST_NAME_KEY, "value2");
}
);

when(tracer1.start(eq("EventHubs.message"), any(), eq(ProcessKind.MESSAGE))).thenAnswer(
invocation -> {
Context passed = invocation.getArgument(1, Context.class);
assertEquals(passed.getData(AZ_TRACING_NAMESPACE_KEY).get(), AZ_NAMESPACE_VALUE);
return passed.addData(PARENT_SPAN_KEY, "value").addData(DIAGNOSTIC_ID_KEY, "value2");
assertEquals(AZ_NAMESPACE_VALUE, passed.getData(AZ_TRACING_NAMESPACE_KEY).get());
assertEquals(HOSTNAME, passed.getData(HOST_NAME_KEY).get());
assertEquals(EVENT_HUB_NAME, passed.getData(ENTITY_PATH_KEY).get());
return passed.addData(PARENT_TRACE_CONTEXT_KEY, "trace-context");
}
);

when(tracer1.getSharedSpanBuilder(eq("EventHubs.send"), any())).thenAnswer(
invocation -> {
Context passed = invocation.getArgument(1, Context.class);
return passed.addData(SPAN_BUILDER_KEY, "value");
assertEquals("span-context", passed.getData("span-context").orElseGet(null));
return passed.addData(SPAN_BUILDER_KEY, "span-builder");
}
);

Expand All @@ -432,14 +441,15 @@ void sendMessageRetrySpanTest() {
.thenReturn(Mono.empty());

producer.send(testData).block();
assertFalse(testData.getProperties().containsKey(DIAGNOSTIC_ID_KEY));

//Assert
verify(tracer1, times(1))
.start(eq("EventHubs.send"), any(), eq(ProcessKind.SEND));
verify(tracer1, times(1))
.start(eq("EventHubs.message"), any(), eq(ProcessKind.MESSAGE));
verify(tracer1, times(1)).start(eq("EventHubs.send"), any(), eq(ProcessKind.SEND));
verify(tracer1, never()).start(eq("EventHubs.message"), any(), eq(ProcessKind.MESSAGE));
verify(tracer1, times(1)).addLink(any());
verify(tracer1, times(2)).end(eq("success"), isNull(), any());
verify(tracer1, times(1)).getSharedSpanBuilder(eq("EventHubs.send"), any());
verify(tracer1, times(1)).end(eq("success"), isNull(), any());


verifyNoMoreInteractions(onClientClosed);
}
Expand Down Expand Up @@ -529,37 +539,75 @@ void startMessageSpansOnCreateBatch() {
final EventHubProducerAsyncClient asyncProducer = new EventHubProducerAsyncClient(HOSTNAME, EVENT_HUB_NAME,
connectionProcessor, retryOptions, tracerProvider, messageSerializer, Schedulers.parallel(),
false, onClientClosed);
final AmqpSendLink link = mock(AmqpSendLink.class);

when(link.getLinkSize()).thenReturn(Mono.just(ClientConstants.MAX_MESSAGE_LENGTH_BYTES));
when(link.getHostname()).thenReturn(HOSTNAME);
when(link.getEntityPath()).thenReturn(ENTITY_PATH);

// EC is the prefix they use when creating a link that sends to the service round-robin.
when(connection.createSendLink(eq(EVENT_HUB_NAME), eq(EVENT_HUB_NAME), eq(retryOptions)))
.thenReturn(Mono.just(link));
.thenReturn(Mono.just(sendLink));
when(sendLink.getHostname()).thenReturn(HOSTNAME);
when(sendLink.getEntityPath()).thenReturn(EVENT_HUB_NAME);
when(sendLink.send(anyList())).thenReturn(Mono.empty());
when(sendLink.send(any(Message.class))).thenReturn(Mono.empty());

final AtomicReference<Integer> eventInd = new AtomicReference<>(0);
when(tracer1.start(eq("EventHubs.message"), any(), eq(ProcessKind.MESSAGE))).thenAnswer(
invocation -> {
Context passed = invocation.getArgument(1, Context.class);
assertEquals(passed.getData(AZ_TRACING_NAMESPACE_KEY).get(), AZ_NAMESPACE_VALUE);
assertEquals(passed.getData(ENTITY_PATH_KEY).get(), ENTITY_PATH);
assertEquals(passed.getData(HOST_NAME_KEY).get(), HOSTNAME);
return passed.addData(PARENT_TRACE_CONTEXT_KEY, "span")
.addData(DIAGNOSTIC_ID_KEY, eventInd.get().toString())
.addData(SPAN_CONTEXT_KEY, eventInd.get());
}
);

when(tracer1.getSharedSpanBuilder(eq("EventHubs.send"), any())).thenAnswer(
invocation -> {
Context passed = invocation.getArgument(1, Context.class);
assertEquals(0, passed.getData(SPAN_CONTEXT_KEY).orElseGet(null));
return passed.addData(SPAN_BUILDER_KEY, "span-builder");
}
);

return passed.addData(PARENT_SPAN_KEY, "value").addData(DIAGNOSTIC_ID_KEY, "value2");
final AtomicReference<Integer> linkNumber = new AtomicReference<>(0);
doAnswer(
invocation -> {
Context passed = invocation.getArgument(0, Context.class);
assertEquals("span-builder", passed.getData(SPAN_BUILDER_KEY).orElseGet(null));
assertEquals(linkNumber.get(), passed.getData(SPAN_CONTEXT_KEY).orElseGet(null));
linkNumber.set(linkNumber.get() + 1);
return null;
}).when(tracer1).addLink(any());

when(tracer1.start(eq("EventHubs.send"), any(), eq(ProcessKind.SEND))).thenAnswer(
invocation -> {
Context passed = invocation.getArgument(1, Context.class);
assertEquals(EVENT_HUB_NAME, passed.getData(ENTITY_PATH_KEY).orElseGet(null));
assertEquals(HOSTNAME, passed.getData(HOST_NAME_KEY).orElseGet(null));
assertEquals(AZ_NAMESPACE_VALUE, passed.getData(AZ_TRACING_NAMESPACE_KEY).orElseGet(null));
return passed.addData(PARENT_TRACE_CONTEXT_KEY, "span");
}
);

// Act & Assert
StepVerifier.create(asyncProducer.createBatch())
.assertNext(batch -> {
Assertions.assertTrue(batch.tryAdd(new EventData("Hello World".getBytes(UTF_8))));
})
StepVerifier.create(asyncProducer.createBatch()
.flatMap(batch -> {
final EventData data0 = new EventData("Hello World".getBytes(UTF_8));
Assertions.assertTrue(batch.tryAdd(data0));
assertEquals("0", data0.getProperties().get(DIAGNOSTIC_ID_KEY));

eventInd.set(1);
final EventData data1 = new EventData("Hello World".getBytes(UTF_8));
Assertions.assertTrue(batch.tryAdd(data1));
assertEquals("1", data1.getProperties().get(DIAGNOSTIC_ID_KEY));
return asyncProducer.send(batch);
}))
.verifyComplete();

verify(tracer1, times(1))
verify(tracer1, times(2))
.start(eq("EventHubs.message"), any(), eq(ProcessKind.MESSAGE));
verify(tracer1, times(1)).end(eq("success"), isNull(), any());
verify(tracer1, times(1)).getSharedSpanBuilder(eq("EventHubs.send"), any());
verify(tracer1, times(2)).addLink(any());
verify(tracer1, times(1)).start(eq("EventHubs.send"), any(), eq(ProcessKind.SEND));
verify(tracer1, times(2)).start(eq("EventHubs.message"), any(), eq(ProcessKind.MESSAGE));
verify(tracer1, times(3)).end(eq("success"), isNull(), any());

verifyNoInteractions(onClientClosed);
}
Expand Down
Loading