Skip to content

Honor single-trace WebSocket configuration for locally initiated spans #12391

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

Draft
lrwh wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Honor single-trace WebSocket configuration for locally initiated spans #12391

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
13 changes: 6 additions & 7 deletions ...p/src/main/java/datadog/trace/bootstrap/instrumentation/decorator/WebsocketDecorator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,8 +151,8 @@ private AgentSpan onFrameStart(
final AgentSpan handshakeSpan = handlerContext.getHandshakeSpan();
boolean inheritSampling = config.isWebsocketMessagesInheritSampling();
boolean useDedicatedTraces = config.isWebsocketMessagesSeparateTraces();
if (traceStarter) {
if (useDedicatedTraces) {
if (useDedicatedTraces) {
if (traceStarter) {
wsSpan = startSpan(WEBSOCKET.toString(), operationName, null);
if (inheritSampling) {
wsSpan.copyPropagationAndBaggage(handshakeSpan);
Expand All @@ -161,10 +161,10 @@ private AgentSpan onFrameStart(
wsSpan.setTag(DECISION_MAKER_RESOURCE, handshakeSpan.getResourceName());
}
} else {
wsSpan = startSpan(WEBSOCKET.toString(), operationName, handshakeSpan.spanContext());
wsSpan = startSpan(WEBSOCKET.toString(), operationName);
}
} else {
wsSpan = startSpan(WEBSOCKET.toString(), operationName);
wsSpan = startSpan(WEBSOCKET.toString(), operationName, handshakeSpan.spanContext());
}
handlerContext.setWebsocketSpan(wsSpan);
afterStart(wsSpan);
Expand All @@ -178,9 +178,8 @@ private AgentSpan onFrameStart(
if (config.isWebsocketTagSessionId()) {
wsSpan.setTag(WEBSOCKET_SESSION_ID, handlerContext.getSessionId());
}
if (useDedicatedTraces || !traceStarter) {
// the link is not added if the user wants to have receive frames on the same trace as the
// handshake
if (useDedicatedTraces) {
// The link is not added if the user wants all frames on the same trace as the handshake.
wsSpan.addLink(
SpanLink.from(
inheritSampling
Expand Down
4 changes: 3 additions & 1 deletion ...strumentation-testing/src/main/groovy/datadog/trace/agent/test/base/HttpServerTest.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2462,6 +2462,8 @@ abstract class HttpServerTest<SERVER> extends WithHttpServer<SERVER> {
}
if (traceStarter && Config.get().isWebsocketMessagesSeparateTraces()) {
parent()
} else if (!Config.get().isWebsocketMessagesSeparateTraces()) {
childOf(handshake)
} else {
if (parentSpan != null) {
childOf(parentSpan)
Expand All @@ -2470,7 +2472,7 @@ abstract class HttpServerTest<SERVER> extends WithHttpServer<SERVER> {
}
}
spanType(DDSpanTypes.WEBSOCKET)
if (Config.get().isWebsocketMessagesSeparateTraces() || !traceStarter) {
if (Config.get().isWebsocketMessagesSeparateTraces()) {
links {
link(handshake, linkFlags, linkAttributes)
}
Expand Down
18 changes: 10 additions & 8 deletions ...gent/instrumentation/websocket/jakarta-websocket-2.0/src/test/groovy/WebsocketTest.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -431,7 +431,7 @@ class WebsocketTest extends InstrumentationSpecification {
}
}

def "test close and receive on same handshake trace"() {
def "test all messages and close on same handshake trace"() {
setup:
injectSysConfig(TRACE_WEBSOCKET_MESSAGES_SEPARATE_TRACES, "false")
when:
Expand All @@ -446,14 +446,19 @@ class WebsocketTest extends InstrumentationSpecification {
session.close()
}
then:
// in reality we have 3 traces but since the handshake finishes soon, the trace structure writer is collecting 5 chunks
assertTraces(5, {
// In reality we have 3 traces, but finished handshake traces are reported in separate chunks.
assertTraces(7, {
DDSpan serverHandshake, clientHandshake
trace(1) {
basicSpan(it, "http.request", "GET /test", null, null, handshakeTags(url))
clientHandshake = span(0)
}

trace(1) {
websocketSendSpan(it, clientHandshake, "text", 5, 1, clientHandshake)
}
trace(1) {
websocketCloseSpan(it, clientHandshake, true, 1000, null, clientHandshake)
}
trace(1) {
basicSpan(it, "servlet.request", "GET /test", null, null, handshakeTags(url))
serverHandshake = span(0)
Expand All @@ -464,11 +469,8 @@ class WebsocketTest extends InstrumentationSpecification {
trace(1) {
websocketCloseSpan(it, serverHandshake, false, 1000, { it == null || it == 'no reason given' }, serverHandshake)
}
trace(3) {
sortSpansByStart()
trace(1) {
basicSpan(it, "parent")
websocketSendSpan(it, clientHandshake, "text", 5, 1, span(0))
websocketCloseSpan(it, clientHandshake, true, 1000, null, span(0))
}
})
}
Expand Down
18 changes: 10 additions & 8 deletions ...-agent/instrumentation/websocket/javax-websocket-1.0/src/test/groovy/WebsocketTest.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -434,7 +434,7 @@ class WebsocketTest extends InstrumentationSpecification {
}
}

def "test close and receive on same handshake trace"() {
def "test all messages and close on same handshake trace"() {
setup:
injectSysConfig(TRACE_WEBSOCKET_MESSAGES_SEPARATE_TRACES, "false")
when:
Expand All @@ -449,14 +449,19 @@ class WebsocketTest extends InstrumentationSpecification {
session.close()
}
then:
// in reality we have 3 traces but since the handshake finishes soon, the trace structure writer is collecting 5 chunks
assertTraces(5, {
// In reality we have 3 traces, but finished handshake traces are reported in separate chunks.
assertTraces(7, {
DDSpan serverHandshake, clientHandshake
trace(1) {
basicSpan(it, "http.request", "GET /test", null, null, handshakeTags(url))
clientHandshake = span(0)
}

trace(1) {
websocketSendSpan(it, clientHandshake, "text", 5, 1, clientHandshake)
}
trace(1) {
websocketCloseSpan(it, clientHandshake, true, 1000, null, clientHandshake)
}
trace(1) {
basicSpan(it, "servlet.request", "GET /test", null, null, handshakeTags(url))
serverHandshake = span(0)
Expand All @@ -467,11 +472,8 @@ class WebsocketTest extends InstrumentationSpecification {
trace(1) {
websocketCloseSpan(it, serverHandshake, false, 1000, { it == null || it == 'no reason given' }, serverHandshake)
}
trace(3) {
sortSpansByStart()
trace(1) {
basicSpan(it, "parent")
websocketSendSpan(it, clientHandshake, "text", 5, 1, span(0))
websocketCloseSpan(it, clientHandshake, true, 1000, null, span(0))
}
})
}
Expand Down