Skip to content

Shorten tracing span names #6810

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

Merged
samvaity merged 11 commits into from
Dec 13, 2019
Merged

Shorten tracing span names #6810

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
9e9951b
update samples and package versions
samvaity Nov 22, 2019
c07f9cc
Revert "update samples and package versions"
samvaity Nov 22, 2019
51797be
Merge remote-tracking branch 'upstream/master'
samvaity Dec 9, 2019
d1cbd7d
Merge remote-tracking branch 'upstream/master'
samvaity Dec 10, 2019
b30a79d
Merge remote-tracking branch 'upstream/master'
samvaity Dec 11, 2019
e5a5cfa
Merge remote-tracking branch 'upstream/master'
samvaity Dec 12, 2019
991890e
remove Azure prefix from span names
samvaity Dec 12, 2019
70a6bff
update naming for http
samvaity Dec 12, 2019
3cc5f60
update changelog
samvaity Dec 12, 2019
25cae4a
update amqp core dependency version
samvaity Dec 12, 2019
8ada580
update for EventHubs
samvaity Dec 13, 2019
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: 1 addition & 1 deletion eng/versioning/version_client.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ com.azure:azure-sdk-all;1.0.0;1.0.0
com.azure:azure-sdk-parent;1.6.0;1.6.0
com.azure:azure-client-sdk-parent;1.7.0;1.7.0
com.azure:azure-core;1.2.0-beta.1;1.2.0-beta.1
com.azure:azure-core-amqp;1.0.0-beta.8;1.0.0-beta.9
com.azure:azure-core-amqp;1.0.0-beta.9;1.0.0-beta.9
com.azure:azure-core-http-netty;1.1.0;1.2.0-beta.1
com.azure:azure-core-http-okhttp;1.1.0-beta.1;1.1.0-beta.1
com.azure:azure-core-management;1.0.0-beta.8;1.0.0-beta.8
Expand Down
2 changes: 1 addition & 1 deletion ...core/azure-core-amqp/src/main/java/com/azure/core/amqp/implementation/TracerProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ private void end(String statusMessage, Throwable throwable, Context context) {
}

private String getSpanName(ProcessKind processKind) {
String spanName = "Azure.eventhubs.";
String spanName = "EventHubs.";
switch (processKind) {
case SEND:
spanName += "send";
Expand Down
2 changes: 1 addition & 1 deletion .../azure-core-amqp/src/test/java/com/azure/core/amqp/implementation/TracerProviderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
import static org.mockito.Mockito.when;

public class TracerProviderTest {
private static final String METHOD_NAME = "Azure.eventhubs.send";
private static final String METHOD_NAME = "EventHubs.send";

@Mock
private Tracer tracer;
Expand Down
5 changes: 2 additions & 3 deletions ...-tracing-opencensus/src/main/java/com/azure/core/tracing/opencensus/OpenCensusTracer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,10 +256,9 @@ private void addSpanRequestAttributes(Span span, Context context, String spanNam
*/
private static String parseComponentValue(String spanName) {
if (spanName != null && spanName.length() > 0) {
int componentNameStartIndex = spanName.indexOf(".");
int componentNameEndIndex = spanName.lastIndexOf(".");
if (componentNameStartIndex != -1 && componentNameEndIndex != -1) {
return spanName.substring(componentNameStartIndex + 1, componentNameEndIndex);
if (componentNameEndIndex != -1) {
return spanName.substring(0, componentNameEndIndex);
}
}
return "";
Expand Down
4 changes: 2 additions & 2 deletions ...cing-opencensus/src/test/java/com/azure/core/tracing/opencensus/OpenCensusTracerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,10 @@
* Tests OpenCensus tracing package using opencensus-impl
*/
public class OpenCensusTracerTest {
private static final String METHOD_NAME = "Azure.eventhubs.send";
private static final String METHOD_NAME = "EventHubs.send";
private static final String HOSTNAME_VALUE = "testEventDataNameSpace.servicebus.windows.net";
private static final String ENTITY_PATH_VALUE = "test";
private static final String COMPONENT_VALUE = "eventhubs";
private static final String COMPONENT_VALUE = "EventHubs";
private OpenCensusTracer openCensusTracer;
private Tracer tracer;
private Context tracingContext;
Expand Down
1 change: 1 addition & 0 deletions sdk/core/azure-core-tracing-opentelemetry/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Release History
## Version 1.0.0-beta.2 (2020-01-03)
- Add eventhub properties to attributes of processing spans.
- Remove `Azure` prefix from convenience layer span names.

This package's
[documentation](https://github.com/Azure/azure-sdk-for-java/blob/azure-core-tracing-opentelemetry_1.0.0-beta.2/sdk/core/azure-core-tracing-opentelemetry/README.md)
Expand Down
7 changes: 3 additions & 4 deletions ...opentelemetry/src/main/java/com/azure/core/tracing/opentelemetry/OpenTelemetryTracer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,15 +247,14 @@ private void addSpanRequestAttributes(Span span, Context context, String spanNam
/**
* Extracts the component name from the given span name.
*
* @param spanName The spanName containing the component name i.e spanName = "Azure.eventhubs.send"
* @param spanName The spanName containing the component name i.e spanName = "EventHubs.send"
* @return The component name contained in the context i.e "eventhubs"
*/
private static String parseComponentValue(String spanName) {
if (spanName != null && !spanName.isEmpty()) {
int componentNameStartIndex = spanName.indexOf(".");
int componentNameEndIndex = spanName.lastIndexOf(".");
if (componentNameStartIndex != -1 && componentNameEndIndex != -1) {
return spanName.substring(componentNameStartIndex + 1, componentNameEndIndex);
if (componentNameEndIndex != -1) {
return spanName.substring(0, componentNameEndIndex);
}
}
return "";
Expand Down
4 changes: 2 additions & 2 deletions ...telemetry/src/test/java/com/azure/core/tracing/opentelemetry/OpenTelemetryTracerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,10 @@
* Tests Azure-OpenTelemetry tracing package using opentelemetry-sdk
*/
public class OpenTelemetryTracerTest {
private static final String METHOD_NAME = "Azure.eventhubs.send";
private static final String METHOD_NAME = "EventHubs.send";
private static final String HOSTNAME_VALUE = "testEventDataNameSpace.servicebus.windows.net";
private static final String ENTITY_PATH_VALUE = "test";
private static final String COMPONENT_VALUE = "eventhubs";
private static final String COMPONENT_VALUE = "EventHubs";
private OpenTelemetryTracer openTelemetryTracer;
private Tracer tracer;
private Context tracingContext;
Expand Down
2 changes: 1 addition & 1 deletion sdk/core/azure-core/src/main/java/com/azure/core/http/rest/RestProxy.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ private Method determineResumeMethod(Method method, String resumeMethodName) {
* @return The updated context containing the span context.
*/
private Context startTracingSpan(Method method, Context context) {
String spanName = String.format("Azure.%s/%s", interfaceParser.getServiceName(), method.getName());
String spanName = String.format("%s.%s", interfaceParser.getServiceName(), method.getName());
context = TracerProxy.setSpanName(spanName, context);
return TracerProxy.start(spanName, context);
}
Expand Down
2 changes: 1 addition & 1 deletion sdk/eventhubs/azure-messaging-eventhubs/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-core-amqp</artifactId>
<version>1.0.0-beta.8</version> <!-- {x-version-update;com.azure:azure-core-amqp;dependency} -->
<version>1.0.0-beta.9</version> <!-- {x-version-update;com.azure:azure-core-amqp;dependency} -->
</dependency>

<!-- Test dependencies -->
Expand Down
18 changes: 9 additions & 9 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 @@ -230,14 +230,14 @@ public void sendStartSpanSingleMessage() {
.thenReturn(Mono.just(sendLink));
when(sendLink.send(anyList())).thenReturn(Mono.empty());

when(tracer1.start(eq("Azure.eventhubs.send"), any(), eq(ProcessKind.SEND))).thenAnswer(
when(tracer1.start(eq("EventHubs.send"), any(), eq(ProcessKind.SEND))).thenAnswer(
invocation -> {
Context passed = invocation.getArgument(1, Context.class);
return passed.addData(PARENT_SPAN_KEY, "value");
}
);

when(tracer1.start(eq("Azure.eventhubs.message"), any(), eq(ProcessKind.MESSAGE))).thenAnswer(
when(tracer1.start(eq("EventHubs.message"), any(), eq(ProcessKind.MESSAGE))).thenAnswer(
invocation -> {
Context passed = invocation.getArgument(1, Context.class);
return passed.addData(PARENT_SPAN_KEY, "value").addData(DIAGNOSTIC_ID_KEY, "value2");
Expand All @@ -250,9 +250,9 @@ public void sendStartSpanSingleMessage() {

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

Expand Down Expand Up @@ -287,7 +287,7 @@ public void sendMessageRetrySpanTest() {
.thenReturn(Mono.just(sendLink));
when(sendLink.send(anyList())).thenReturn(Mono.empty());

when(tracer1.start(eq("Azure.eventhubs.send"), any(), eq(ProcessKind.SEND))).thenAnswer(
when(tracer1.start(eq("EventHubs.send"), any(), eq(ProcessKind.SEND))).thenAnswer(
invocation -> {
Context passed = invocation.getArgument(1, Context.class);
return passed.addData(PARENT_SPAN_KEY, "value");
Expand All @@ -299,8 +299,8 @@ public void sendMessageRetrySpanTest() {

//Assert
verify(tracer1, times(1))
.start(eq("Azure.eventhubs.send"), any(), eq(ProcessKind.SEND));
verify(tracer1, never()).start(eq("Azure.eventhubs.message"), any(), eq(ProcessKind.MESSAGE));
.start(eq("EventHubs.send"), any(), eq(ProcessKind.SEND));
verify(tracer1, never()).start(eq("EventHubs.message"), any(), eq(ProcessKind.MESSAGE));
verify(tracer1, never()).addLink(any());
verify(tracer1, times(1)).end(eq("success"), isNull(), any());
}
Expand Down Expand Up @@ -404,7 +404,7 @@ public void startMessageSpansOnCreateBatch() {
eq(retryOptions.getTryTimeout()), any()))
.thenReturn(Mono.just(link));

when(tracer1.start(eq("Azure.eventhubs.message"), any(), eq(ProcessKind.MESSAGE))).thenAnswer(
when(tracer1.start(eq("EventHubs.message"), any(), eq(ProcessKind.MESSAGE))).thenAnswer(
invocation -> {
Context passed = invocation.getArgument(1, Context.class);
return passed.addData(PARENT_SPAN_KEY, "value").addData(DIAGNOSTIC_ID_KEY, "value2");
Expand All @@ -419,7 +419,7 @@ public void startMessageSpansOnCreateBatch() {
.verifyComplete();

verify(tracer1, times(1))
.start(eq("Azure.eventhubs.message"), any(), eq(ProcessKind.MESSAGE));
.start(eq("EventHubs.message"), any(), eq(ProcessKind.MESSAGE));
verify(tracer1, times(1)).end(eq("success"), isNull(), any());
}

Expand Down
18 changes: 9 additions & 9 deletions ...ing-eventhubs/src/test/java/com/azure/messaging/eventhubs/EventHubProducerClientTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,13 +156,13 @@ public void sendStartSpanSingleMessage() {
eq(retryOptions.getTryTimeout()), any()))
.thenReturn(Mono.just(sendLink));

when(tracer1.start(eq("Azure.eventhubs.send"), any(), eq(ProcessKind.SEND))).thenAnswer(
when(tracer1.start(eq("EventHubs.send"), any(), eq(ProcessKind.SEND))).thenAnswer(
invocation -> {
Context passed = invocation.getArgument(1, Context.class);
return passed.addData(PARENT_SPAN_KEY, "value");
}
);
when(tracer1.start(eq("Azure.eventhubs.message"), any(), eq(ProcessKind.MESSAGE))).thenAnswer(
when(tracer1.start(eq("EventHubs.message"), any(), eq(ProcessKind.MESSAGE))).thenAnswer(
invocation -> {
Context passed = invocation.getArgument(1, Context.class);
return passed.addData(PARENT_SPAN_KEY, "value").addData(DIAGNOSTIC_ID_KEY, "value2");
Expand All @@ -173,9 +173,9 @@ public void sendStartSpanSingleMessage() {

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

Expand All @@ -202,7 +202,7 @@ public void sendMessageRetrySpanTest() {
final EventData eventData = new EventData("hello-world".getBytes(UTF_8))
.addContext(SPAN_CONTEXT_KEY, Context.NONE);

when(tracer1.start(eq("Azure.eventhubs.send"), any(), eq(ProcessKind.SEND))).thenAnswer(
when(tracer1.start(eq("EventHubs.send"), any(), eq(ProcessKind.SEND))).thenAnswer(
invocation -> {
Context passed = invocation.getArgument(1, Context.class);
return passed.addData(PARENT_SPAN_KEY, "value");
Expand All @@ -213,8 +213,8 @@ public void sendMessageRetrySpanTest() {
producer.send(eventData);

//Assert
verify(tracer1, times(1)).start(eq("Azure.eventhubs.send"), any(), eq(ProcessKind.SEND));
verify(tracer1, never()).start(eq("Azure.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, never()).addLink(any());
verify(tracer1, times(1)).end(eq("success"), isNull(), any());
}
Expand Down Expand Up @@ -317,7 +317,7 @@ public void startsMessageSpanOnEventBatch() {
eq(retryOptions.getTryTimeout()), any()))
.thenReturn(Mono.just(link));

when(tracer1.start(eq("Azure.eventhubs.message"), any(), eq(ProcessKind.MESSAGE))).thenAnswer(
when(tracer1.start(eq("EventHubs.message"), any(), eq(ProcessKind.MESSAGE))).thenAnswer(
invocation -> {
Context passed = invocation.getArgument(1, Context.class);
return passed.addData(PARENT_SPAN_KEY, "value").addData(DIAGNOSTIC_ID_KEY, "value2");
Expand All @@ -330,7 +330,7 @@ public void startsMessageSpanOnEventBatch() {
Assertions.assertTrue(batch.tryAdd(new EventData("Test World".getBytes(UTF_8))));

verify(tracer1, times(2))
.start(eq("Azure.eventhubs.message"), any(), eq(ProcessKind.MESSAGE));
.start(eq("EventHubs.message"), any(), eq(ProcessKind.MESSAGE));
verify(tracer1, times(2)).end(eq("success"), isNull(), any());
}

Expand Down
12 changes: 6 additions & 6 deletions ...aging-eventhubs/src/test/java/com/azure/messaging/eventhubs/EventProcessorClientTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ public void testWithSimplePartitionProcessor() throws Exception {
return passed.addData(SPAN_CONTEXT_KEY, "value");
}
);
when(tracer1.start(eq("Azure.eventhubs.process"), any(), eq(ProcessKind.PROCESS))).thenAnswer(
when(tracer1.start(eq("EventHubs.process"), any(), eq(ProcessKind.PROCESS))).thenAnswer(
invocation -> {
Context passed = invocation.getArgument(1, Context.class);
return passed.addData(SPAN_CONTEXT_KEY, "value1")
Expand Down Expand Up @@ -200,7 +200,7 @@ public void testWithFaultyPartitionProcessor() throws Exception {
return passed.addData(SPAN_CONTEXT_KEY, "value");
}
);
when(tracer1.start(eq("Azure.eventhubs.process"), any(), eq(ProcessKind.PROCESS))).thenAnswer(
when(tracer1.start(eq("EventHubs.process"), any(), eq(ProcessKind.PROCESS))).thenAnswer(
invocation -> {
Context passed = invocation.getArgument(1, Context.class);
return passed.addData(SPAN_CONTEXT_KEY, "value1")
Expand Down Expand Up @@ -256,7 +256,7 @@ public void testErrorProcessSpans() throws Exception {
return passed.addData(SPAN_CONTEXT_KEY, "value");
}
);
when(tracer1.start(eq("Azure.eventhubs.process"), any(), eq(ProcessKind.PROCESS))).thenAnswer(
when(tracer1.start(eq("EventHubs.process"), any(), eq(ProcessKind.PROCESS))).thenAnswer(
invocation -> {
Context passed = invocation.getArgument(1, Context.class);
return passed.addData(SPAN_CONTEXT_KEY, "value1")
Expand All @@ -277,7 +277,7 @@ public void testErrorProcessSpans() throws Exception {

//Assert
verify(tracer1, times(1)).extractContext(eq(diagnosticId), any());
verify(tracer1, times(1)).start(eq("Azure.eventhubs.process"), any(), eq(ProcessKind.PROCESS));
verify(tracer1, times(1)).start(eq("EventHubs.process"), any(), eq(ProcessKind.PROCESS));
verify(tracer1, times(1)).end(eq(""), any(IllegalStateException.class), any());
}

Expand Down Expand Up @@ -316,7 +316,7 @@ public void testProcessSpans() throws Exception {
return passed.addData(SPAN_CONTEXT_KEY, "value");
}
);
when(tracer1.start(eq("Azure.eventhubs.process"), any(), eq(ProcessKind.PROCESS))).thenAnswer(
when(tracer1.start(eq("EventHubs.process"), any(), eq(ProcessKind.PROCESS))).thenAnswer(
invocation -> {
Context passed = invocation.getArgument(1, Context.class);
return passed.addData(SPAN_CONTEXT_KEY, "value1").addData("scope", (Closeable) () -> {
Expand All @@ -337,7 +337,7 @@ public void testProcessSpans() throws Exception {

//Assert
verify(tracer1, times(1)).extractContext(eq(diagnosticId), any());
verify(tracer1, times(1)).start(eq("Azure.eventhubs.process"), any(), eq(ProcessKind.PROCESS));
verify(tracer1, times(1)).start(eq("EventHubs.process"), any(), eq(ProcessKind.PROCESS));
verify(tracer1, times(1)).end(eq("success"), isNull(), any());
}

Expand Down