[improvement] Correctly nest spans when tracing okhttp requests#1069

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

Closed
robert3005 wants to merge 3 commits into from
Closed

[improvement] Correctly nest spans when tracing okhttp requests #1069

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a88c32b
Correctly nest spans when tracing okhttp requests
Apr 18, 2019
49f243a
imports
Apr 18, 2019
ed3f6f3
correct condition
Apr 18, 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
52 changes: 31 additions & 21 deletions ...re-java-jaxrs-client/src/test/java/com/palantir/conjure/java/client/jaxrs/TracerTest.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,22 +16,17 @@

package com.palantir.conjure.java.client.jaxrs;

import static org.hamcrest.Matchers.contains;
import static org.hamcrest.Matchers.hasSize;
import static org.hamcrest.Matchers.is;
import static org.hamcrest.Matchers.not;
import static org.junit.Assert.assertThat;
import static org.assertj.core.api.Assertions.assertThat;

import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
import com.google.common.collect.Sets;
import com.palantir.conjure.java.okhttp.HostMetricsRegistry;
import com.palantir.tracing.Tracer;
import com.palantir.tracing.api.OpenSpan;
import com.palantir.tracing.api.Span;
import com.palantir.tracing.api.SpanType;
import com.palantir.tracing.api.TraceHttpHeaders;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import java.util.concurrent.CompletableFuture;
Expand DownExpand Up@@ -61,25 +56,40 @@ public void before() {
public void testClientIsInstrumentedWithTracer() throws InterruptedException {
server.enqueue(new MockResponse().setBody("\"server\""));
OpenSpan parentTrace = Tracer.startSpan("");
List<Map.Entry<SpanType, String>> observedSpans = Lists.newArrayList();
Tracer.subscribe(TracerTest.class.getName(),
span -> observedSpans.add(Maps.immutableEntry(span.type(), span.getOperation())));
List<Span> observedSpans = Lists.newArrayList();
Tracer.subscribe(TracerTest.class.getName(), observedSpans::add);

String traceId = Tracer.getTraceId();
service.param("somevalue");

Tracer.unsubscribe(TracerTest.class.getName());
assertThat(observedSpans, contains(
Maps.immutableEntry(SpanType.LOCAL, "OkHttp: acquire-limiter-enqueue"),
Maps.immutableEntry(SpanType.LOCAL, "OkHttp: acquire-limiter-run"),
Maps.immutableEntry(SpanType.LOCAL, "OkHttp: execute-enqueue"),
Maps.immutableEntry(SpanType.CLIENT_OUTGOING, "OkHttp: GET /{param}"),
Maps.immutableEntry(SpanType.LOCAL, "OkHttp: execute-run"),
Maps.immutableEntry(SpanType.LOCAL, "OkHttp: dispatcher")));
Span executeRunSpan = observedSpans.stream()
.filter(s -> s.getOperation().equals("OkHttp: execute-run"))
.findFirst()
.get();

assertThat(observedSpans).allSatisfy(span -> {
if (span.getOperation().equals("OkHttp: GET /{param}")) {
assertThat(span.type()).isEqualTo(SpanType.CLIENT_OUTGOING);
assertThat(span.getParentSpanId().get()).isEqualTo(executeRunSpan.getSpanId());
} else {
assertThat(span.type()).isEqualTo(SpanType.LOCAL);
assertThat(span.getParentSpanId().get()).isEqualTo(parentTrace.getSpanId());
}
});
assertThat(observedSpans)
.extracting(Span::getOperation)
.containsExactly(
"OkHttp: acquire-limiter-enqueue",
"OkHttp: acquire-limiter-run",
"ignored-span",
"OkHttp: execute-enqueue",
"OkHttp: GET /{param}",
"OkHttp: execute-run");

RecordedRequest request = server.takeRequest();
assertThat(request.getHeader(TraceHttpHeaders.TRACE_ID), is(traceId));
assertThat(request.getHeader(TraceHttpHeaders.SPAN_ID), is(not(parentTrace.getSpanId())));
assertThat(request.getHeader(TraceHttpHeaders.TRACE_ID)).isEqualTo(traceId);
assertThat(request.getHeader(TraceHttpHeaders.SPAN_ID)).isNotEqualTo(parentTrace.getSpanId());
}

@Test
Expand All@@ -89,7 +99,7 @@ public void testLimiterAcquisitionMultiThread() {
addTraceSubscriber(observedTraceIds);
runTwoRequestsInParallel();
removeTraceSubscriber();
assertThat(observedTraceIds, hasSize(2));
assertThat(observedTraceIds).containsExactly("first", "second");
}

private void runTwoRequestsInParallel() {
Expand DownExpand Up@@ -130,7 +140,7 @@ private void reduceConcurrencyLimitTo1() {
server.enqueue(new MockResponse().setResponseCode(429));
});
server.enqueue(new MockResponse().setBody("\"server\""));
assertThat(service.string(), is("server"));
assertThat(service.string()).isEqualTo("server");
}
}
}
32 changes: 32 additions & 0 deletions okhttp-clients/src/main/java/com/palantir/conjure/java/okhttp/AsyncTracerTag.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
/*
* (c) Copyright 2019 Palantir Technologies Inc. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package com.palantir.conjure.java.okhttp;

import com.palantir.conjure.java.client.config.ImmutablesStyle;
import com.palantir.tracing.AsyncTracer;
import org.immutables.value.Value;

@Value.Modifiable
@ImmutablesStyle
public interface AsyncTracerTag {
AsyncTracer asyncTracer();
AsyncTracerTag setAsyncTracer(AsyncTracer asyncTracer);

static AsyncTracerTag create() {
return ModifiableAsyncTracerTag.create();
}
}
7 changes: 3 additions & 4 deletions ...src/main/java/com/palantir/conjure/java/okhttp/DispatcherTraceTerminatingInterceptor.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,19 +16,18 @@

package com.palantir.conjure.java.okhttp;

import com.palantir.tracing.AsyncTracer;
import java.io.IOException;
import okhttp3.Interceptor;
import okhttp3.Response;

public final class DispatcherTraceTerminatingInterceptor implements Interceptor {
@Override
public Response intercept(Chain chain) throws IOException {
AsyncTracer tracerTag = chain.request().tag(AsyncTracer.class);
if (tracerTag == null) {
AsyncTracerTag tracerTag = chain.request().tag(AsyncTracerTag.class);
if (tracerTag == null || tracerTag.asyncTracer() == null) {
return chain.proceed(chain.request());
}

return tracerTag.withTrace(() -> chain.proceed(chain.request()));
return tracerTag.asyncTracer().withTrace(() -> chain.proceed(chain.request()));
}
}
3 changes: 1 addition & 2 deletions okhttp-clients/src/main/java/com/palantir/conjure/java/okhttp/OkHttpClients.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -81,8 +81,7 @@ public final class OkHttpClients {
* </li>
* </ol>
*/
private static final ExecutorService executionExecutor =
Tracers.wrap("OkHttp: dispatcher", Executors.newCachedThreadPool(executionThreads));
private static final ExecutorService executionExecutor = Executors.newCachedThreadPool(executionThreads);

/** Shared dispatcher with static executor service. */
private static final Dispatcher dispatcher;
Expand Down
12 changes: 10 additions & 2 deletions okhttp-clients/src/main/java/com/palantir/conjure/java/okhttp/RemotingOkHttpCall.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,7 @@
import com.palantir.logsafe.exceptions.SafeIllegalStateException;
import com.palantir.logsafe.exceptions.SafeIoException;
import com.palantir.tracing.AsyncTracer;
import com.palantir.tracing.Tracer;
import java.io.IOException;
import java.io.InterruptedIOException;
import java.net.SocketTimeoutException;
Expand DownExpand Up@@ -165,8 +166,15 @@ public void enqueue(Callback callback) {
Futures.addCallback(limiterListener, new FutureCallback<Limiter.Listener>() {
@Override
public void onSuccess(Limiter.Listener listener) {
tracer.withTrace(() -> null);
enqueueInternal(callback);
tracer.withTrace(() -> {

@iamdanfoxiamdanfoxApr 18, 2019•
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think before merging this it would be nice to come up with a solution that doesn't require us to include the acquire-limiter-run and ignore span hacks

@robert3005robert3005Apr 18, 2019

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That was my thought as well - this pr is here to point to intended behaviour

@carterkozakcarterkozakApr 18, 2019

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

palantir/tracing-java#124

@diogoholandadiogoholandaApr 22, 2019

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why was the hack here needed?
It seems like leaving the old behavior would suffice to leave the acquire-limiter-run span empty and the other spans with the appropriate parents:

tracer.withTrace(() -> null);
enqueueInternal(callback);

@robert3005robert3005Apr 23, 2019

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It won't work - the callback is executed on different thread and different trace. You need to add spans to the original trace

// terminate acquire-limiter-run span
Tracer.fastCompleteSpan();
request().tag(AsyncTracerTag.class).setAsyncTracer(new AsyncTracer("OkHttp: execute"));
enqueueInternal(callback);
// Need to recreate a span to make sure withTrace will not close parent spans
Tracer.startSpan("ignored-span");
return null;
});
}

@Override
Expand Down
3 changes: 1 addition & 2 deletions okhttp-clients/src/main/java/com/palantir/conjure/java/okhttp/RemotingOkHttpClient.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,6 @@
import com.palantir.logsafe.SafeArg;
import com.palantir.logsafe.exceptions.SafeIllegalStateException;
import com.palantir.logsafe.exceptions.SafeRuntimeException;
import com.palantir.tracing.AsyncTracer;
import java.util.Optional;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.ScheduledExecutorService;
Expand DownExpand Up@@ -102,7 +101,7 @@ private Request createNewRequest(Request request) {
return request.newBuilder()
.url(getNewRequestUrl(request.url()))
.tag(ConcurrencyLimiterListener.class, ConcurrencyLimiterListener.create())
.tag(AsyncTracer.class, new AsyncTracer("OkHttp: execute"))
.tag(AsyncTracerTag.class, AsyncTracerTag.create())
.build();
}

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
[improvement] Correctly nest spans when tracing okhttp requests#1069

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

 Closed

robert3005
wants to merge
3
commits into

from

 Closed


[improvement] Correctly nest spans when tracing okhttp requests
#1069
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
a88c32b

Correctly nest spans when tracing okhttp requests

Apr 18, 2019
49f243a

imports

Apr 18, 2019
ed3f6f3

correct condition

Apr 18, 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


52 changes: 31 additions & 21 deletions
...re-java-jaxrs-client/src/test/java/com/palantir/conjure/java/client/jaxrs/TracerTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,22 +16,17 @@

package com.palantir.conjure.java.client.jaxrs;

import static org.hamcrest.Matchers.contains;
import static org.hamcrest.Matchers.hasSize;
import static org.hamcrest.Matchers.is;
import static org.hamcrest.Matchers.not;
import static org.junit.Assert.assertThat;
import static org.assertj.core.api.Assertions.assertThat;

import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
import com.google.common.collect.Sets;
import com.palantir.conjure.java.okhttp.HostMetricsRegistry;
import com.palantir.tracing.Tracer;
import com.palantir.tracing.api.OpenSpan;
import com.palantir.tracing.api.Span;
import com.palantir.tracing.api.SpanType;
import com.palantir.tracing.api.TraceHttpHeaders;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import java.util.concurrent.CompletableFuture;
Expand DownExpand Up@@ -61,25 +56,40 @@ public void before() {
 public void testClientIsInstrumentedWithTracer() throws InterruptedException {
 server.enqueue(new MockResponse().setBody("\"server\""));
 OpenSpan parentTrace = Tracer.startSpan("");
 List<Map.Entry<SpanType, String>> observedSpans = Lists.newArrayList();
 Tracer.subscribe(TracerTest.class.getName(),
 span -> observedSpans.add(Maps.immutableEntry(span.type(), span.getOperation())));
 List<Span> observedSpans = Lists.newArrayList();
 Tracer.subscribe(TracerTest.class.getName(), observedSpans::add);

 String traceId = Tracer.getTraceId();
 service.param("somevalue");

 Tracer.unsubscribe(TracerTest.class.getName());
 assertThat(observedSpans, contains(
 Maps.immutableEntry(SpanType.LOCAL, "OkHttp: acquire-limiter-enqueue"),
 Maps.immutableEntry(SpanType.LOCAL, "OkHttp: acquire-limiter-run"),
 Maps.immutableEntry(SpanType.LOCAL, "OkHttp: execute-enqueue"),
 Maps.immutableEntry(SpanType.CLIENT_OUTGOING, "OkHttp: GET /{param}"),
 Maps.immutableEntry(SpanType.LOCAL, "OkHttp: execute-run"),
 Maps.immutableEntry(SpanType.LOCAL, "OkHttp: dispatcher")));
 Span executeRunSpan = observedSpans.stream()
 .filter(s -> s.getOperation().equals("OkHttp: execute-run"))
 .findFirst()
 .get();

 assertThat(observedSpans).allSatisfy(span -> {
 if (span.getOperation().equals("OkHttp: GET /{param}")) {
 assertThat(span.type()).isEqualTo(SpanType.CLIENT_OUTGOING);
 assertThat(span.getParentSpanId().get()).isEqualTo(executeRunSpan.getSpanId());
 } else {
 assertThat(span.type()).isEqualTo(SpanType.LOCAL);
 assertThat(span.getParentSpanId().get()).isEqualTo(parentTrace.getSpanId());
 }
 });
 assertThat(observedSpans)
 .extracting(Span::getOperation)
 .containsExactly(
 "OkHttp: acquire-limiter-enqueue",
 "OkHttp: acquire-limiter-run",
 "ignored-span",
 "OkHttp: execute-enqueue",
 "OkHttp: GET /{param}",
 "OkHttp: execute-run");

 RecordedRequest request = server.takeRequest();
 assertThat(request.getHeader(TraceHttpHeaders.TRACE_ID), is(traceId));
 assertThat(request.getHeader(TraceHttpHeaders.SPAN_ID), is(not(parentTrace.getSpanId())));
 assertThat(request.getHeader(TraceHttpHeaders.TRACE_ID)).isEqualTo(traceId);
 assertThat(request.getHeader(TraceHttpHeaders.SPAN_ID)).isNotEqualTo(parentTrace.getSpanId());
 }

 @Test
Expand All@@ -89,7 +99,7 @@ public void testLimiterAcquisitionMultiThread() {
 addTraceSubscriber(observedTraceIds);
 runTwoRequestsInParallel();
 removeTraceSubscriber();
 assertThat(observedTraceIds, hasSize(2));
 assertThat(observedTraceIds).containsExactly("first", "second");
 }

 private void runTwoRequestsInParallel() {
Expand DownExpand Up@@ -130,7 +140,7 @@ private void reduceConcurrencyLimitTo1() {
 server.enqueue(new MockResponse().setResponseCode(429));
 });
 server.enqueue(new MockResponse().setBody("\"server\""));
 assertThat(service.string(), is("server"));
 assertThat(service.string()).isEqualTo("server");
 }
 }
}

32 changes: 32 additions & 0 deletions
okhttp-clients/src/main/java/com/palantir/conjure/java/okhttp/AsyncTracerTag.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
/*
 * (c) Copyright 2019 Palantir Technologies Inc. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.palantir.conjure.java.okhttp;

import com.palantir.conjure.java.client.config.ImmutablesStyle;
import com.palantir.tracing.AsyncTracer;
import org.immutables.value.Value;

@Value.Modifiable
@ImmutablesStyle
public interface AsyncTracerTag {
 AsyncTracer asyncTracer();
 AsyncTracerTag setAsyncTracer(AsyncTracer asyncTracer);

 static AsyncTracerTag create() {
 return ModifiableAsyncTracerTag.create();
 }
}

7 changes: 3 additions & 4 deletions
...src/main/java/com/palantir/conjure/java/okhttp/DispatcherTraceTerminatingInterceptor.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,19 +16,18 @@

package com.palantir.conjure.java.okhttp;

import com.palantir.tracing.AsyncTracer;
import java.io.IOException;
import okhttp3.Interceptor;
import okhttp3.Response;

public final class DispatcherTraceTerminatingInterceptor implements Interceptor {
 @Override
 public Response intercept(Chain chain) throws IOException {
AsyncTracer tracerTag = chain.request().tag(AsyncTracer.class);
 if (tracerTag == null) {
AsyncTracerTag tracerTag = chain.request().tag(AsyncTracerTag.class);
 if (tracerTag == null || tracerTag.asyncTracer() == null) {
 return chain.proceed(chain.request());
 }

 return tracerTag.withTrace(() -> chain.proceed(chain.request()));
 return tracerTag.asyncTracer().withTrace(() -> chain.proceed(chain.request()));
 }
}

3 changes: 1 addition & 2 deletions
okhttp-clients/src/main/java/com/palantir/conjure/java/okhttp/OkHttpClients.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,8 +81,7 @@ public final class OkHttpClients {
 * </li>
 * </ol>
 */
 private static final ExecutorService executionExecutor =
 Tracers.wrap("OkHttp: dispatcher", Executors.newCachedThreadPool(executionThreads));
 private static final ExecutorService executionExecutor = Executors.newCachedThreadPool(executionThreads);

 /** Shared dispatcher with static executor service. */
 private static final Dispatcher dispatcher;
Expand Down

12 changes: 10 additions & 2 deletions
okhttp-clients/src/main/java/com/palantir/conjure/java/okhttp/RemotingOkHttpCall.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,7 @@
import com.palantir.logsafe.exceptions.SafeIllegalStateException;
import com.palantir.logsafe.exceptions.SafeIoException;
import com.palantir.tracing.AsyncTracer;
import com.palantir.tracing.Tracer;
import java.io.IOException;
import java.io.InterruptedIOException;
import java.net.SocketTimeoutException;
Expand DownExpand Up@@ -165,8 +166,15 @@ public void enqueue(Callback callback) {
 Futures.addCallback(limiterListener, new FutureCallback<Limiter.Listener>() {
 @Override
 public void onSuccess(Limiter.Listener listener) {
 tracer.withTrace(() -> null);
 enqueueInternal(callback);
 tracer.withTrace(() -> {
@iamdanfoxiamdanfoxApr 18, 2019•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think before merging this it would be nice to come up with a solution that doesn't require us to include the acquire-limiter-run and ignore span hacks
@robert3005robert3005Apr 18, 2019

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That was my thought as well - this pr is here to point to intended behaviour
@carterkozakcarterkozakApr 18, 2019

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

palantir/tracing-java#124
@diogoholandadiogoholandaApr 22, 2019

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why was the hack here needed?

It seems like leaving the old behavior would suffice to leave the acquire-limiter-run span empty and the other spans with the appropriate parents:
tracer.withTrace(() -> null);
enqueueInternal(callback);

@robert3005robert3005Apr 23, 2019

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It won't work - the callback is executed on different thread and different trace. You need to add spans to the original trace
 // terminate acquire-limiter-run span
 Tracer.fastCompleteSpan();
 request().tag(AsyncTracerTag.class).setAsyncTracer(new AsyncTracer("OkHttp: execute"));
 enqueueInternal(callback);
 // Need to recreate a span to make sure withTrace will not close parent spans
 Tracer.startSpan("ignored-span");
 return null;
 });
 }

 @Override
Expand Down

3 changes: 1 addition & 2 deletions
okhttp-clients/src/main/java/com/palantir/conjure/java/okhttp/RemotingOkHttpClient.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,6 @@
import com.palantir.logsafe.SafeArg;
import com.palantir.logsafe.exceptions.SafeIllegalStateException;
import com.palantir.logsafe.exceptions.SafeRuntimeException;
import com.palantir.tracing.AsyncTracer;
import java.util.Optional;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.ScheduledExecutorService;
Expand DownExpand Up@@ -102,7 +101,7 @@ private Request createNewRequest(Request request) {
 return request.newBuilder()
 .url(getNewRequestUrl(request.url()))
 .tag(ConcurrencyLimiterListener.class, ConcurrencyLimiterListener.create())
 .tag(AsyncTracer.class, new AsyncTracer("OkHttp: execute"))
 .tag(AsyncTracerTag.class, AsyncTracerTag.create())
 .build();
 }

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
[improvement] Correctly nest spans when tracing okhttp requests#1069

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

 Closed

robert3005
wants to merge
3
commits into

from

 Closed


[improvement] Correctly nest spans when tracing okhttp requests
#1069
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
a88c32b

Correctly nest spans when tracing okhttp requests

Apr 18, 2019
49f243a

imports

Apr 18, 2019
ed3f6f3

correct condition

Apr 18, 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


52 changes: 31 additions & 21 deletions
...re-java-jaxrs-client/src/test/java/com/palantir/conjure/java/client/jaxrs/TracerTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,22 +16,17 @@

package com.palantir.conjure.java.client.jaxrs;

import static org.hamcrest.Matchers.contains;
import static org.hamcrest.Matchers.hasSize;
import static org.hamcrest.Matchers.is;
import static org.hamcrest.Matchers.not;
import static org.junit.Assert.assertThat;
import static org.assertj.core.api.Assertions.assertThat;

import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
import com.google.common.collect.Sets;
import com.palantir.conjure.java.okhttp.HostMetricsRegistry;
import com.palantir.tracing.Tracer;
import com.palantir.tracing.api.OpenSpan;
import com.palantir.tracing.api.Span;
import com.palantir.tracing.api.SpanType;
import com.palantir.tracing.api.TraceHttpHeaders;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import java.util.concurrent.CompletableFuture;
Expand DownExpand Up@@ -61,25 +56,40 @@ public void before() {
 public void testClientIsInstrumentedWithTracer() throws InterruptedException {
 server.enqueue(new MockResponse().setBody("\"server\""));
 OpenSpan parentTrace = Tracer.startSpan("");
 List<Map.Entry<SpanType, String>> observedSpans = Lists.newArrayList();
 Tracer.subscribe(TracerTest.class.getName(),
 span -> observedSpans.add(Maps.immutableEntry(span.type(), span.getOperation())));
 List<Span> observedSpans = Lists.newArrayList();
 Tracer.subscribe(TracerTest.class.getName(), observedSpans::add);

 String traceId = Tracer.getTraceId();
 service.param("somevalue");

 Tracer.unsubscribe(TracerTest.class.getName());
 assertThat(observedSpans, contains(
 Maps.immutableEntry(SpanType.LOCAL, "OkHttp: acquire-limiter-enqueue"),
 Maps.immutableEntry(SpanType.LOCAL, "OkHttp: acquire-limiter-run"),
 Maps.immutableEntry(SpanType.LOCAL, "OkHttp: execute-enqueue"),
 Maps.immutableEntry(SpanType.CLIENT_OUTGOING, "OkHttp: GET /{param}"),
 Maps.immutableEntry(SpanType.LOCAL, "OkHttp: execute-run"),
 Maps.immutableEntry(SpanType.LOCAL, "OkHttp: dispatcher")));
 Span executeRunSpan = observedSpans.stream()
 .filter(s -> s.getOperation().equals("OkHttp: execute-run"))
 .findFirst()
 .get();

 assertThat(observedSpans).allSatisfy(span -> {
 if (span.getOperation().equals("OkHttp: GET /{param}")) {
 assertThat(span.type()).isEqualTo(SpanType.CLIENT_OUTGOING);
 assertThat(span.getParentSpanId().get()).isEqualTo(executeRunSpan.getSpanId());
 } else {
 assertThat(span.type()).isEqualTo(SpanType.LOCAL);
 assertThat(span.getParentSpanId().get()).isEqualTo(parentTrace.getSpanId());
 }
 });
 assertThat(observedSpans)
 .extracting(Span::getOperation)
 .containsExactly(
 "OkHttp: acquire-limiter-enqueue",
 "OkHttp: acquire-limiter-run",
 "ignored-span",
 "OkHttp: execute-enqueue",
 "OkHttp: GET /{param}",
 "OkHttp: execute-run");

 RecordedRequest request = server.takeRequest();
 assertThat(request.getHeader(TraceHttpHeaders.TRACE_ID), is(traceId));
 assertThat(request.getHeader(TraceHttpHeaders.SPAN_ID), is(not(parentTrace.getSpanId())));
 assertThat(request.getHeader(TraceHttpHeaders.TRACE_ID)).isEqualTo(traceId);
 assertThat(request.getHeader(TraceHttpHeaders.SPAN_ID)).isNotEqualTo(parentTrace.getSpanId());
 }

 @Test
Expand All@@ -89,7 +99,7 @@ public void testLimiterAcquisitionMultiThread() {
 addTraceSubscriber(observedTraceIds);
 runTwoRequestsInParallel();
 removeTraceSubscriber();
 assertThat(observedTraceIds, hasSize(2));
 assertThat(observedTraceIds).containsExactly("first", "second");
 }

 private void runTwoRequestsInParallel() {
Expand DownExpand Up@@ -130,7 +140,7 @@ private void reduceConcurrencyLimitTo1() {
 server.enqueue(new MockResponse().setResponseCode(429));
 });
 server.enqueue(new MockResponse().setBody("\"server\""));
 assertThat(service.string(), is("server"));
 assertThat(service.string()).isEqualTo("server");
 }
 }
}

32 changes: 32 additions & 0 deletions
okhttp-clients/src/main/java/com/palantir/conjure/java/okhttp/AsyncTracerTag.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
/*
 * (c) Copyright 2019 Palantir Technologies Inc. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.palantir.conjure.java.okhttp;

import com.palantir.conjure.java.client.config.ImmutablesStyle;
import com.palantir.tracing.AsyncTracer;
import org.immutables.value.Value;

@Value.Modifiable
@ImmutablesStyle
public interface AsyncTracerTag {
 AsyncTracer asyncTracer();
 AsyncTracerTag setAsyncTracer(AsyncTracer asyncTracer);

 static AsyncTracerTag create() {
 return ModifiableAsyncTracerTag.create();
 }
}

7 changes: 3 additions & 4 deletions
...src/main/java/com/palantir/conjure/java/okhttp/DispatcherTraceTerminatingInterceptor.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,19 +16,18 @@

package com.palantir.conjure.java.okhttp;

import com.palantir.tracing.AsyncTracer;
import java.io.IOException;
import okhttp3.Interceptor;
import okhttp3.Response;

public final class DispatcherTraceTerminatingInterceptor implements Interceptor {
 @Override
 public Response intercept(Chain chain) throws IOException {
AsyncTracer tracerTag = chain.request().tag(AsyncTracer.class);
 if (tracerTag == null) {
AsyncTracerTag tracerTag = chain.request().tag(AsyncTracerTag.class);
 if (tracerTag == null || tracerTag.asyncTracer() == null) {
 return chain.proceed(chain.request());
 }

 return tracerTag.withTrace(() -> chain.proceed(chain.request()));
 return tracerTag.asyncTracer().withTrace(() -> chain.proceed(chain.request()));
 }
}

3 changes: 1 addition & 2 deletions
okhttp-clients/src/main/java/com/palantir/conjure/java/okhttp/OkHttpClients.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,8 +81,7 @@ public final class OkHttpClients {
 * </li>
 * </ol>
 */
 private static final ExecutorService executionExecutor =
 Tracers.wrap("OkHttp: dispatcher", Executors.newCachedThreadPool(executionThreads));
 private static final ExecutorService executionExecutor = Executors.newCachedThreadPool(executionThreads);

 /** Shared dispatcher with static executor service. */
 private static final Dispatcher dispatcher;
Expand Down

12 changes: 10 additions & 2 deletions
okhttp-clients/src/main/java/com/palantir/conjure/java/okhttp/RemotingOkHttpCall.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,7 @@
import com.palantir.logsafe.exceptions.SafeIllegalStateException;
import com.palantir.logsafe.exceptions.SafeIoException;
import com.palantir.tracing.AsyncTracer;
import com.palantir.tracing.Tracer;
import java.io.IOException;
import java.io.InterruptedIOException;
import java.net.SocketTimeoutException;
Expand DownExpand Up@@ -165,8 +166,15 @@ public void enqueue(Callback callback) {
 Futures.addCallback(limiterListener, new FutureCallback<Limiter.Listener>() {
 @Override
 public void onSuccess(Limiter.Listener listener) {
 tracer.withTrace(() -> null);
 enqueueInternal(callback);
 tracer.withTrace(() -> {
@iamdanfoxiamdanfoxApr 18, 2019•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think before merging this it would be nice to come up with a solution that doesn't require us to include the acquire-limiter-run and ignore span hacks
@robert3005robert3005Apr 18, 2019

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That was my thought as well - this pr is here to point to intended behaviour
@carterkozakcarterkozakApr 18, 2019

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

palantir/tracing-java#124
@diogoholandadiogoholandaApr 22, 2019

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why was the hack here needed?

It seems like leaving the old behavior would suffice to leave the acquire-limiter-run span empty and the other spans with the appropriate parents:
tracer.withTrace(() -> null);
enqueueInternal(callback);

@robert3005robert3005Apr 23, 2019

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It won't work - the callback is executed on different thread and different trace. You need to add spans to the original trace
 // terminate acquire-limiter-run span
 Tracer.fastCompleteSpan();
 request().tag(AsyncTracerTag.class).setAsyncTracer(new AsyncTracer("OkHttp: execute"));
 enqueueInternal(callback);
 // Need to recreate a span to make sure withTrace will not close parent spans
 Tracer.startSpan("ignored-span");
 return null;
 });
 }

 @Override
Expand Down

3 changes: 1 addition & 2 deletions
okhttp-clients/src/main/java/com/palantir/conjure/java/okhttp/RemotingOkHttpClient.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,6 @@
import com.palantir.logsafe.SafeArg;
import com.palantir.logsafe.exceptions.SafeIllegalStateException;
import com.palantir.logsafe.exceptions.SafeRuntimeException;
import com.palantir.tracing.AsyncTracer;
import java.util.Optional;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.ScheduledExecutorService;
Expand DownExpand Up@@ -102,7 +101,7 @@ private Request createNewRequest(Request request) {
 return request.newBuilder()
 .url(getNewRequestUrl(request.url()))
 .tag(ConcurrencyLimiterListener.class, ConcurrencyLimiterListener.create())
 .tag(AsyncTracer.class, new AsyncTracer("OkHttp: execute"))
 .tag(AsyncTracerTag.class, AsyncTracerTag.create())
 .build();
 }

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
[improvement] Correctly nest spans when tracing okhttp requests#1069

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

 Closed

robert3005
wants to merge
3
commits into

from

 Closed


[improvement] Correctly nest spans when tracing okhttp requests
#1069
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
a88c32b

Correctly nest spans when tracing okhttp requests

Apr 18, 2019
49f243a

imports

Apr 18, 2019
ed3f6f3

correct condition

Apr 18, 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


52 changes: 31 additions & 21 deletions
...re-java-jaxrs-client/src/test/java/com/palantir/conjure/java/client/jaxrs/TracerTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,22 +16,17 @@

package com.palantir.conjure.java.client.jaxrs;

import static org.hamcrest.Matchers.contains;
import static org.hamcrest.Matchers.hasSize;
import static org.hamcrest.Matchers.is;
import static org.hamcrest.Matchers.not;
import static org.junit.Assert.assertThat;
import static org.assertj.core.api.Assertions.assertThat;

import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
import com.google.common.collect.Sets;
import com.palantir.conjure.java.okhttp.HostMetricsRegistry;
import com.palantir.tracing.Tracer;
import com.palantir.tracing.api.OpenSpan;
import com.palantir.tracing.api.Span;
import com.palantir.tracing.api.SpanType;
import com.palantir.tracing.api.TraceHttpHeaders;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import java.util.concurrent.CompletableFuture;
Expand DownExpand Up@@ -61,25 +56,40 @@ public void before() {
 public void testClientIsInstrumentedWithTracer() throws InterruptedException {
 server.enqueue(new MockResponse().setBody("\"server\""));
 OpenSpan parentTrace = Tracer.startSpan("");
 List<Map.Entry<SpanType, String>> observedSpans = Lists.newArrayList();
 Tracer.subscribe(TracerTest.class.getName(),
 span -> observedSpans.add(Maps.immutableEntry(span.type(), span.getOperation())));
 List<Span> observedSpans = Lists.newArrayList();
 Tracer.subscribe(TracerTest.class.getName(), observedSpans::add);

 String traceId = Tracer.getTraceId();
 service.param("somevalue");

 Tracer.unsubscribe(TracerTest.class.getName());
 assertThat(observedSpans, contains(
 Maps.immutableEntry(SpanType.LOCAL, "OkHttp: acquire-limiter-enqueue"),
 Maps.immutableEntry(SpanType.LOCAL, "OkHttp: acquire-limiter-run"),
 Maps.immutableEntry(SpanType.LOCAL, "OkHttp: execute-enqueue"),
 Maps.immutableEntry(SpanType.CLIENT_OUTGOING, "OkHttp: GET /{param}"),
 Maps.immutableEntry(SpanType.LOCAL, "OkHttp: execute-run"),
 Maps.immutableEntry(SpanType.LOCAL, "OkHttp: dispatcher")));
 Span executeRunSpan = observedSpans.stream()
 .filter(s -> s.getOperation().equals("OkHttp: execute-run"))
 .findFirst()
 .get();

 assertThat(observedSpans).allSatisfy(span -> {
 if (span.getOperation().equals("OkHttp: GET /{param}")) {
 assertThat(span.type()).isEqualTo(SpanType.CLIENT_OUTGOING);
 assertThat(span.getParentSpanId().get()).isEqualTo(executeRunSpan.getSpanId());
 } else {
 assertThat(span.type()).isEqualTo(SpanType.LOCAL);
 assertThat(span.getParentSpanId().get()).isEqualTo(parentTrace.getSpanId());
 }
 });
 assertThat(observedSpans)
 .extracting(Span::getOperation)
 .containsExactly(
 "OkHttp: acquire-limiter-enqueue",
 "OkHttp: acquire-limiter-run",
 "ignored-span",
 "OkHttp: execute-enqueue",
 "OkHttp: GET /{param}",
 "OkHttp: execute-run");

 RecordedRequest request = server.takeRequest();
 assertThat(request.getHeader(TraceHttpHeaders.TRACE_ID), is(traceId));
 assertThat(request.getHeader(TraceHttpHeaders.SPAN_ID), is(not(parentTrace.getSpanId())));
 assertThat(request.getHeader(TraceHttpHeaders.TRACE_ID)).isEqualTo(traceId);
 assertThat(request.getHeader(TraceHttpHeaders.SPAN_ID)).isNotEqualTo(parentTrace.getSpanId());
 }

 @Test
Expand All@@ -89,7 +99,7 @@ public void testLimiterAcquisitionMultiThread() {
 addTraceSubscriber(observedTraceIds);
 runTwoRequestsInParallel();
 removeTraceSubscriber();
 assertThat(observedTraceIds, hasSize(2));
 assertThat(observedTraceIds).containsExactly("first", "second");
 }

 private void runTwoRequestsInParallel() {
Expand DownExpand Up@@ -130,7 +140,7 @@ private void reduceConcurrencyLimitTo1() {
 server.enqueue(new MockResponse().setResponseCode(429));
 });
 server.enqueue(new MockResponse().setBody("\"server\""));
 assertThat(service.string(), is("server"));
 assertThat(service.string()).isEqualTo("server");
 }
 }
}

32 changes: 32 additions & 0 deletions
okhttp-clients/src/main/java/com/palantir/conjure/java/okhttp/AsyncTracerTag.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
/*
 * (c) Copyright 2019 Palantir Technologies Inc. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.palantir.conjure.java.okhttp;

import com.palantir.conjure.java.client.config.ImmutablesStyle;
import com.palantir.tracing.AsyncTracer;
import org.immutables.value.Value;

@Value.Modifiable
@ImmutablesStyle
public interface AsyncTracerTag {
 AsyncTracer asyncTracer();
 AsyncTracerTag setAsyncTracer(AsyncTracer asyncTracer);

 static AsyncTracerTag create() {
 return ModifiableAsyncTracerTag.create();
 }
}

7 changes: 3 additions & 4 deletions
...src/main/java/com/palantir/conjure/java/okhttp/DispatcherTraceTerminatingInterceptor.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,19 +16,18 @@

package com.palantir.conjure.java.okhttp;

import com.palantir.tracing.AsyncTracer;
import java.io.IOException;
import okhttp3.Interceptor;
import okhttp3.Response;

public final class DispatcherTraceTerminatingInterceptor implements Interceptor {
 @Override
 public Response intercept(Chain chain) throws IOException {
AsyncTracer tracerTag = chain.request().tag(AsyncTracer.class);
 if (tracerTag == null) {
AsyncTracerTag tracerTag = chain.request().tag(AsyncTracerTag.class);
 if (tracerTag == null || tracerTag.asyncTracer() == null) {
 return chain.proceed(chain.request());
 }

 return tracerTag.withTrace(() -> chain.proceed(chain.request()));
 return tracerTag.asyncTracer().withTrace(() -> chain.proceed(chain.request()));
 }
}

3 changes: 1 addition & 2 deletions
okhttp-clients/src/main/java/com/palantir/conjure/java/okhttp/OkHttpClients.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,8 +81,7 @@ public final class OkHttpClients {
 * </li>
 * </ol>
 */
 private static final ExecutorService executionExecutor =
 Tracers.wrap("OkHttp: dispatcher", Executors.newCachedThreadPool(executionThreads));
 private static final ExecutorService executionExecutor = Executors.newCachedThreadPool(executionThreads);

 /** Shared dispatcher with static executor service. */
 private static final Dispatcher dispatcher;
Expand Down

12 changes: 10 additions & 2 deletions
okhttp-clients/src/main/java/com/palantir/conjure/java/okhttp/RemotingOkHttpCall.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,7 @@
import com.palantir.logsafe.exceptions.SafeIllegalStateException;
import com.palantir.logsafe.exceptions.SafeIoException;
import com.palantir.tracing.AsyncTracer;
import com.palantir.tracing.Tracer;
import java.io.IOException;
import java.io.InterruptedIOException;
import java.net.SocketTimeoutException;
Expand DownExpand Up@@ -165,8 +166,15 @@ public void enqueue(Callback callback) {
 Futures.addCallback(limiterListener, new FutureCallback<Limiter.Listener>() {
 @Override
 public void onSuccess(Limiter.Listener listener) {
 tracer.withTrace(() -> null);
 enqueueInternal(callback);
 tracer.withTrace(() -> {
@iamdanfoxiamdanfoxApr 18, 2019•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think before merging this it would be nice to come up with a solution that doesn't require us to include the acquire-limiter-run and ignore span hacks
@robert3005robert3005Apr 18, 2019

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That was my thought as well - this pr is here to point to intended behaviour
@carterkozakcarterkozakApr 18, 2019

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

palantir/tracing-java#124
@diogoholandadiogoholandaApr 22, 2019

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why was the hack here needed?

It seems like leaving the old behavior would suffice to leave the acquire-limiter-run span empty and the other spans with the appropriate parents:
tracer.withTrace(() -> null);
enqueueInternal(callback);

@robert3005robert3005Apr 23, 2019

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It won't work - the callback is executed on different thread and different trace. You need to add spans to the original trace
 // terminate acquire-limiter-run span
 Tracer.fastCompleteSpan();
 request().tag(AsyncTracerTag.class).setAsyncTracer(new AsyncTracer("OkHttp: execute"));
 enqueueInternal(callback);
 // Need to recreate a span to make sure withTrace will not close parent spans
 Tracer.startSpan("ignored-span");
 return null;
 });
 }

 @Override
Expand Down

3 changes: 1 addition & 2 deletions
okhttp-clients/src/main/java/com/palantir/conjure/java/okhttp/RemotingOkHttpClient.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,6 @@
import com.palantir.logsafe.SafeArg;
import com.palantir.logsafe.exceptions.SafeIllegalStateException;
import com.palantir.logsafe.exceptions.SafeRuntimeException;
import com.palantir.tracing.AsyncTracer;
import java.util.Optional;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.ScheduledExecutorService;
Expand DownExpand Up@@ -102,7 +101,7 @@ private Request createNewRequest(Request request) {
 return request.newBuilder()
 .url(getNewRequestUrl(request.url()))
 .tag(ConcurrencyLimiterListener.class, ConcurrencyLimiterListener.create())
 .tag(AsyncTracer.class, new AsyncTracer("OkHttp: execute"))
 .tag(AsyncTracerTag.class, AsyncTracerTag.create())
 .build();
 }

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
[improvement] Correctly nest spans when tracing okhttp requests#1069

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

 Closed

robert3005
wants to merge
3
commits into

from

 Closed


[improvement] Correctly nest spans when tracing okhttp requests
#1069
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
a88c32b

Correctly nest spans when tracing okhttp requests

Apr 18, 2019
49f243a

imports

Apr 18, 2019
ed3f6f3

correct condition

Apr 18, 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


52 changes: 31 additions & 21 deletions
...re-java-jaxrs-client/src/test/java/com/palantir/conjure/java/client/jaxrs/TracerTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,22 +16,17 @@

package com.palantir.conjure.java.client.jaxrs;

import static org.hamcrest.Matchers.contains;
import static org.hamcrest.Matchers.hasSize;
import static org.hamcrest.Matchers.is;
import static org.hamcrest.Matchers.not;
import static org.junit.Assert.assertThat;
import static org.assertj.core.api.Assertions.assertThat;

import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
import com.google.common.collect.Sets;
import com.palantir.conjure.java.okhttp.HostMetricsRegistry;
import com.palantir.tracing.Tracer;
import com.palantir.tracing.api.OpenSpan;
import com.palantir.tracing.api.Span;
import com.palantir.tracing.api.SpanType;
import com.palantir.tracing.api.TraceHttpHeaders;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import java.util.concurrent.CompletableFuture;
Expand DownExpand Up@@ -61,25 +56,40 @@ public void before() {
 public void testClientIsInstrumentedWithTracer() throws InterruptedException {
 server.enqueue(new MockResponse().setBody("\"server\""));
 OpenSpan parentTrace = Tracer.startSpan("");
 List<Map.Entry<SpanType, String>> observedSpans = Lists.newArrayList();
 Tracer.subscribe(TracerTest.class.getName(),
 span -> observedSpans.add(Maps.immutableEntry(span.type(), span.getOperation())));
 List<Span> observedSpans = Lists.newArrayList();
 Tracer.subscribe(TracerTest.class.getName(), observedSpans::add);

 String traceId = Tracer.getTraceId();
 service.param("somevalue");

 Tracer.unsubscribe(TracerTest.class.getName());
 assertThat(observedSpans, contains(
 Maps.immutableEntry(SpanType.LOCAL, "OkHttp: acquire-limiter-enqueue"),
 Maps.immutableEntry(SpanType.LOCAL, "OkHttp: acquire-limiter-run"),
 Maps.immutableEntry(SpanType.LOCAL, "OkHttp: execute-enqueue"),
 Maps.immutableEntry(SpanType.CLIENT_OUTGOING, "OkHttp: GET /{param}"),
 Maps.immutableEntry(SpanType.LOCAL, "OkHttp: execute-run"),
 Maps.immutableEntry(SpanType.LOCAL, "OkHttp: dispatcher")));
 Span executeRunSpan = observedSpans.stream()
 .filter(s -> s.getOperation().equals("OkHttp: execute-run"))
 .findFirst()
 .get();

 assertThat(observedSpans).allSatisfy(span -> {
 if (span.getOperation().equals("OkHttp: GET /{param}")) {
 assertThat(span.type()).isEqualTo(SpanType.CLIENT_OUTGOING);
 assertThat(span.getParentSpanId().get()).isEqualTo(executeRunSpan.getSpanId());
 } else {
 assertThat(span.type()).isEqualTo(SpanType.LOCAL);
 assertThat(span.getParentSpanId().get()).isEqualTo(parentTrace.getSpanId());
 }
 });
 assertThat(observedSpans)
 .extracting(Span::getOperation)
 .containsExactly(
 "OkHttp: acquire-limiter-enqueue",
 "OkHttp: acquire-limiter-run",
 "ignored-span",
 "OkHttp: execute-enqueue",
 "OkHttp: GET /{param}",
 "OkHttp: execute-run");

 RecordedRequest request = server.takeRequest();
 assertThat(request.getHeader(TraceHttpHeaders.TRACE_ID), is(traceId));
 assertThat(request.getHeader(TraceHttpHeaders.SPAN_ID), is(not(parentTrace.getSpanId())));
 assertThat(request.getHeader(TraceHttpHeaders.TRACE_ID)).isEqualTo(traceId);
 assertThat(request.getHeader(TraceHttpHeaders.SPAN_ID)).isNotEqualTo(parentTrace.getSpanId());
 }

 @Test
Expand All@@ -89,7 +99,7 @@ public void testLimiterAcquisitionMultiThread() {
 addTraceSubscriber(observedTraceIds);
 runTwoRequestsInParallel();
 removeTraceSubscriber();
 assertThat(observedTraceIds, hasSize(2));
 assertThat(observedTraceIds).containsExactly("first", "second");
 }

 private void runTwoRequestsInParallel() {
Expand DownExpand Up@@ -130,7 +140,7 @@ private void reduceConcurrencyLimitTo1() {
 server.enqueue(new MockResponse().setResponseCode(429));
 });
 server.enqueue(new MockResponse().setBody("\"server\""));
 assertThat(service.string(), is("server"));
 assertThat(service.string()).isEqualTo("server");
 }
 }
}

32 changes: 32 additions & 0 deletions
okhttp-clients/src/main/java/com/palantir/conjure/java/okhttp/AsyncTracerTag.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
/*
 * (c) Copyright 2019 Palantir Technologies Inc. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.palantir.conjure.java.okhttp;

import com.palantir.conjure.java.client.config.ImmutablesStyle;
import com.palantir.tracing.AsyncTracer;
import org.immutables.value.Value;

@Value.Modifiable
@ImmutablesStyle
public interface AsyncTracerTag {
 AsyncTracer asyncTracer();
 AsyncTracerTag setAsyncTracer(AsyncTracer asyncTracer);

 static AsyncTracerTag create() {
 return ModifiableAsyncTracerTag.create();
 }
}

7 changes: 3 additions & 4 deletions
...src/main/java/com/palantir/conjure/java/okhttp/DispatcherTraceTerminatingInterceptor.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,19 +16,18 @@

package com.palantir.conjure.java.okhttp;

import com.palantir.tracing.AsyncTracer;
import java.io.IOException;
import okhttp3.Interceptor;
import okhttp3.Response;

public final class DispatcherTraceTerminatingInterceptor implements Interceptor {
 @Override
 public Response intercept(Chain chain) throws IOException {
AsyncTracer tracerTag = chain.request().tag(AsyncTracer.class);
 if (tracerTag == null) {
AsyncTracerTag tracerTag = chain.request().tag(AsyncTracerTag.class);
 if (tracerTag == null || tracerTag.asyncTracer() == null) {
 return chain.proceed(chain.request());
 }

 return tracerTag.withTrace(() -> chain.proceed(chain.request()));
 return tracerTag.asyncTracer().withTrace(() -> chain.proceed(chain.request()));
 }
}

3 changes: 1 addition & 2 deletions
okhttp-clients/src/main/java/com/palantir/conjure/java/okhttp/OkHttpClients.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,8 +81,7 @@ public final class OkHttpClients {
 * </li>
 * </ol>
 */
 private static final ExecutorService executionExecutor =
 Tracers.wrap("OkHttp: dispatcher", Executors.newCachedThreadPool(executionThreads));
 private static final ExecutorService executionExecutor = Executors.newCachedThreadPool(executionThreads);

 /** Shared dispatcher with static executor service. */
 private static final Dispatcher dispatcher;
Expand Down

12 changes: 10 additions & 2 deletions
okhttp-clients/src/main/java/com/palantir/conjure/java/okhttp/RemotingOkHttpCall.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,7 @@
import com.palantir.logsafe.exceptions.SafeIllegalStateException;
import com.palantir.logsafe.exceptions.SafeIoException;
import com.palantir.tracing.AsyncTracer;
import com.palantir.tracing.Tracer;
import java.io.IOException;
import java.io.InterruptedIOException;
import java.net.SocketTimeoutException;
Expand DownExpand Up@@ -165,8 +166,15 @@ public void enqueue(Callback callback) {
 Futures.addCallback(limiterListener, new FutureCallback<Limiter.Listener>() {
 @Override
 public void onSuccess(Limiter.Listener listener) {
 tracer.withTrace(() -> null);
 enqueueInternal(callback);
 tracer.withTrace(() -> {
@iamdanfoxiamdanfoxApr 18, 2019•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think before merging this it would be nice to come up with a solution that doesn't require us to include the acquire-limiter-run and ignore span hacks
@robert3005robert3005Apr 18, 2019

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That was my thought as well - this pr is here to point to intended behaviour
@carterkozakcarterkozakApr 18, 2019

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

palantir/tracing-java#124
@diogoholandadiogoholandaApr 22, 2019

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why was the hack here needed?

It seems like leaving the old behavior would suffice to leave the acquire-limiter-run span empty and the other spans with the appropriate parents:
tracer.withTrace(() -> null);
enqueueInternal(callback);

@robert3005robert3005Apr 23, 2019

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It won't work - the callback is executed on different thread and different trace. You need to add spans to the original trace
 // terminate acquire-limiter-run span
 Tracer.fastCompleteSpan();
 request().tag(AsyncTracerTag.class).setAsyncTracer(new AsyncTracer("OkHttp: execute"));
 enqueueInternal(callback);
 // Need to recreate a span to make sure withTrace will not close parent spans
 Tracer.startSpan("ignored-span");
 return null;
 });
 }

 @Override
Expand Down

3 changes: 1 addition & 2 deletions
okhttp-clients/src/main/java/com/palantir/conjure/java/okhttp/RemotingOkHttpClient.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,6 @@
import com.palantir.logsafe.SafeArg;
import com.palantir.logsafe.exceptions.SafeIllegalStateException;
import com.palantir.logsafe.exceptions.SafeRuntimeException;
import com.palantir.tracing.AsyncTracer;
import java.util.Optional;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.ScheduledExecutorService;
Expand DownExpand Up@@ -102,7 +101,7 @@ private Request createNewRequest(Request request) {
 return request.newBuilder()
 .url(getNewRequestUrl(request.url()))
 .tag(ConcurrencyLimiterListener.class, ConcurrencyLimiterListener.create())
 .tag(AsyncTracer.class, new AsyncTracer("OkHttp: execute"))
 .tag(AsyncTracerTag.class, AsyncTracerTag.create())
 .build();
 }

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
[improvement] Correctly nest spans when tracing okhttp requests#1069

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

 Closed

robert3005
wants to merge
3
commits into

from

 Closed


[improvement] Correctly nest spans when tracing okhttp requests
#1069
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
a88c32b

Correctly nest spans when tracing okhttp requests

Apr 18, 2019
49f243a

imports

Apr 18, 2019
ed3f6f3

correct condition

Apr 18, 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


52 changes: 31 additions & 21 deletions
...re-java-jaxrs-client/src/test/java/com/palantir/conjure/java/client/jaxrs/TracerTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,22 +16,17 @@

package com.palantir.conjure.java.client.jaxrs;

import static org.hamcrest.Matchers.contains;
import static org.hamcrest.Matchers.hasSize;
import static org.hamcrest.Matchers.is;
import static org.hamcrest.Matchers.not;
import static org.junit.Assert.assertThat;
import static org.assertj.core.api.Assertions.assertThat;

import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
import com.google.common.collect.Sets;
import com.palantir.conjure.java.okhttp.HostMetricsRegistry;
import com.palantir.tracing.Tracer;
import com.palantir.tracing.api.OpenSpan;
import com.palantir.tracing.api.Span;
import com.palantir.tracing.api.SpanType;
import com.palantir.tracing.api.TraceHttpHeaders;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import java.util.concurrent.CompletableFuture;
Expand DownExpand Up@@ -61,25 +56,40 @@ public void before() {
 public void testClientIsInstrumentedWithTracer() throws InterruptedException {
 server.enqueue(new MockResponse().setBody("\"server\""));
 OpenSpan parentTrace = Tracer.startSpan("");
 List<Map.Entry<SpanType, String>> observedSpans = Lists.newArrayList();
 Tracer.subscribe(TracerTest.class.getName(),
 span -> observedSpans.add(Maps.immutableEntry(span.type(), span.getOperation())));
 List<Span> observedSpans = Lists.newArrayList();
 Tracer.subscribe(TracerTest.class.getName(), observedSpans::add);

 String traceId = Tracer.getTraceId();
 service.param("somevalue");

 Tracer.unsubscribe(TracerTest.class.getName());
 assertThat(observedSpans, contains(
 Maps.immutableEntry(SpanType.LOCAL, "OkHttp: acquire-limiter-enqueue"),
 Maps.immutableEntry(SpanType.LOCAL, "OkHttp: acquire-limiter-run"),
 Maps.immutableEntry(SpanType.LOCAL, "OkHttp: execute-enqueue"),
 Maps.immutableEntry(SpanType.CLIENT_OUTGOING, "OkHttp: GET /{param}"),
 Maps.immutableEntry(SpanType.LOCAL, "OkHttp: execute-run"),
 Maps.immutableEntry(SpanType.LOCAL, "OkHttp: dispatcher")));
 Span executeRunSpan = observedSpans.stream()
 .filter(s -> s.getOperation().equals("OkHttp: execute-run"))
 .findFirst()
 .get();

 assertThat(observedSpans).allSatisfy(span -> {
 if (span.getOperation().equals("OkHttp: GET /{param}")) {
 assertThat(span.type()).isEqualTo(SpanType.CLIENT_OUTGOING);
 assertThat(span.getParentSpanId().get()).isEqualTo(executeRunSpan.getSpanId());
 } else {
 assertThat(span.type()).isEqualTo(SpanType.LOCAL);
 assertThat(span.getParentSpanId().get()).isEqualTo(parentTrace.getSpanId());
 }
 });
 assertThat(observedSpans)
 .extracting(Span::getOperation)
 .containsExactly(
 "OkHttp: acquire-limiter-enqueue",
 "OkHttp: acquire-limiter-run",
 "ignored-span",
 "OkHttp: execute-enqueue",
 "OkHttp: GET /{param}",
 "OkHttp: execute-run");

 RecordedRequest request = server.takeRequest();
 assertThat(request.getHeader(TraceHttpHeaders.TRACE_ID), is(traceId));
 assertThat(request.getHeader(TraceHttpHeaders.SPAN_ID), is(not(parentTrace.getSpanId())));
 assertThat(request.getHeader(TraceHttpHeaders.TRACE_ID)).isEqualTo(traceId);
 assertThat(request.getHeader(TraceHttpHeaders.SPAN_ID)).isNotEqualTo(parentTrace.getSpanId());
 }

 @Test
Expand All@@ -89,7 +99,7 @@ public void testLimiterAcquisitionMultiThread() {
 addTraceSubscriber(observedTraceIds);
 runTwoRequestsInParallel();
 removeTraceSubscriber();
 assertThat(observedTraceIds, hasSize(2));
 assertThat(observedTraceIds).containsExactly("first", "second");
 }

 private void runTwoRequestsInParallel() {
Expand DownExpand Up@@ -130,7 +140,7 @@ private void reduceConcurrencyLimitTo1() {
 server.enqueue(new MockResponse().setResponseCode(429));
 });
 server.enqueue(new MockResponse().setBody("\"server\""));
 assertThat(service.string(), is("server"));
 assertThat(service.string()).isEqualTo("server");
 }
 }
}

32 changes: 32 additions & 0 deletions
okhttp-clients/src/main/java/com/palantir/conjure/java/okhttp/AsyncTracerTag.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
/*
 * (c) Copyright 2019 Palantir Technologies Inc. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.palantir.conjure.java.okhttp;

import com.palantir.conjure.java.client.config.ImmutablesStyle;
import com.palantir.tracing.AsyncTracer;
import org.immutables.value.Value;

@Value.Modifiable
@ImmutablesStyle
public interface AsyncTracerTag {
 AsyncTracer asyncTracer();
 AsyncTracerTag setAsyncTracer(AsyncTracer asyncTracer);

 static AsyncTracerTag create() {
 return ModifiableAsyncTracerTag.create();
 }
}

7 changes: 3 additions & 4 deletions
...src/main/java/com/palantir/conjure/java/okhttp/DispatcherTraceTerminatingInterceptor.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,19 +16,18 @@

package com.palantir.conjure.java.okhttp;

import com.palantir.tracing.AsyncTracer;
import java.io.IOException;
import okhttp3.Interceptor;
import okhttp3.Response;

public final class DispatcherTraceTerminatingInterceptor implements Interceptor {
 @Override
 public Response intercept(Chain chain) throws IOException {
AsyncTracer tracerTag = chain.request().tag(AsyncTracer.class);
 if (tracerTag == null) {
AsyncTracerTag tracerTag = chain.request().tag(AsyncTracerTag.class);
 if (tracerTag == null || tracerTag.asyncTracer() == null) {
 return chain.proceed(chain.request());
 }

 return tracerTag.withTrace(() -> chain.proceed(chain.request()));
 return tracerTag.asyncTracer().withTrace(() -> chain.proceed(chain.request()));
 }
}

3 changes: 1 addition & 2 deletions
okhttp-clients/src/main/java/com/palantir/conjure/java/okhttp/OkHttpClients.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,8 +81,7 @@ public final class OkHttpClients {
 * </li>
 * </ol>
 */
 private static final ExecutorService executionExecutor =
 Tracers.wrap("OkHttp: dispatcher", Executors.newCachedThreadPool(executionThreads));
 private static final ExecutorService executionExecutor = Executors.newCachedThreadPool(executionThreads);

 /** Shared dispatcher with static executor service. */
 private static final Dispatcher dispatcher;
Expand Down

12 changes: 10 additions & 2 deletions
okhttp-clients/src/main/java/com/palantir/conjure/java/okhttp/RemotingOkHttpCall.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,7 @@
import com.palantir.logsafe.exceptions.SafeIllegalStateException;
import com.palantir.logsafe.exceptions.SafeIoException;
import com.palantir.tracing.AsyncTracer;
import com.palantir.tracing.Tracer;
import java.io.IOException;
import java.io.InterruptedIOException;
import java.net.SocketTimeoutException;
Expand DownExpand Up@@ -165,8 +166,15 @@ public void enqueue(Callback callback) {
 Futures.addCallback(limiterListener, new FutureCallback<Limiter.Listener>() {
 @Override
 public void onSuccess(Limiter.Listener listener) {
 tracer.withTrace(() -> null);
 enqueueInternal(callback);
 tracer.withTrace(() -> {
@iamdanfoxiamdanfoxApr 18, 2019•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think before merging this it would be nice to come up with a solution that doesn't require us to include the acquire-limiter-run and ignore span hacks
@robert3005robert3005Apr 18, 2019

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That was my thought as well - this pr is here to point to intended behaviour
@carterkozakcarterkozakApr 18, 2019

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

palantir/tracing-java#124
@diogoholandadiogoholandaApr 22, 2019

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why was the hack here needed?

It seems like leaving the old behavior would suffice to leave the acquire-limiter-run span empty and the other spans with the appropriate parents:
tracer.withTrace(() -> null);
enqueueInternal(callback);

@robert3005robert3005Apr 23, 2019

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It won't work - the callback is executed on different thread and different trace. You need to add spans to the original trace
 // terminate acquire-limiter-run span
 Tracer.fastCompleteSpan();
 request().tag(AsyncTracerTag.class).setAsyncTracer(new AsyncTracer("OkHttp: execute"));
 enqueueInternal(callback);
 // Need to recreate a span to make sure withTrace will not close parent spans
 Tracer.startSpan("ignored-span");
 return null;
 });
 }

 @Override
Expand Down

3 changes: 1 addition & 2 deletions
okhttp-clients/src/main/java/com/palantir/conjure/java/okhttp/RemotingOkHttpClient.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,6 @@
import com.palantir.logsafe.SafeArg;
import com.palantir.logsafe.exceptions.SafeIllegalStateException;
import com.palantir.logsafe.exceptions.SafeRuntimeException;
import com.palantir.tracing.AsyncTracer;
import java.util.Optional;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.ScheduledExecutorService;
Expand DownExpand Up@@ -102,7 +101,7 @@ private Request createNewRequest(Request request) {
 return request.newBuilder()
 .url(getNewRequestUrl(request.url()))
 .tag(ConcurrencyLimiterListener.class, ConcurrencyLimiterListener.create())
 .tag(AsyncTracer.class, new AsyncTracer("OkHttp: execute"))
 .tag(AsyncTracerTag.class, AsyncTracerTag.create())
 .build();
 }

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
[improvement] Correctly nest spans when tracing okhttp requests#1069

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

 Closed

robert3005
wants to merge
3
commits into

from

 Closed


[improvement] Correctly nest spans when tracing okhttp requests
#1069
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
a88c32b

Correctly nest spans when tracing okhttp requests

Apr 18, 2019
49f243a

imports

Apr 18, 2019
ed3f6f3

correct condition

Apr 18, 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


52 changes: 31 additions & 21 deletions
...re-java-jaxrs-client/src/test/java/com/palantir/conjure/java/client/jaxrs/TracerTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,22 +16,17 @@

package com.palantir.conjure.java.client.jaxrs;

import static org.hamcrest.Matchers.contains;
import static org.hamcrest.Matchers.hasSize;
import static org.hamcrest.Matchers.is;
import static org.hamcrest.Matchers.not;
import static org.junit.Assert.assertThat;
import static org.assertj.core.api.Assertions.assertThat;

import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
import com.google.common.collect.Sets;
import com.palantir.conjure.java.okhttp.HostMetricsRegistry;
import com.palantir.tracing.Tracer;
import com.palantir.tracing.api.OpenSpan;
import com.palantir.tracing.api.Span;
import com.palantir.tracing.api.SpanType;
import com.palantir.tracing.api.TraceHttpHeaders;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import java.util.concurrent.CompletableFuture;
Expand DownExpand Up@@ -61,25 +56,40 @@ public void before() {
 public void testClientIsInstrumentedWithTracer() throws InterruptedException {
 server.enqueue(new MockResponse().setBody("\"server\""));
 OpenSpan parentTrace = Tracer.startSpan("");
 List<Map.Entry<SpanType, String>> observedSpans = Lists.newArrayList();
 Tracer.subscribe(TracerTest.class.getName(),
 span -> observedSpans.add(Maps.immutableEntry(span.type(), span.getOperation())));
 List<Span> observedSpans = Lists.newArrayList();
 Tracer.subscribe(TracerTest.class.getName(), observedSpans::add);

 String traceId = Tracer.getTraceId();
 service.param("somevalue");

 Tracer.unsubscribe(TracerTest.class.getName());
 assertThat(observedSpans, contains(
 Maps.immutableEntry(SpanType.LOCAL, "OkHttp: acquire-limiter-enqueue"),
 Maps.immutableEntry(SpanType.LOCAL, "OkHttp: acquire-limiter-run"),
 Maps.immutableEntry(SpanType.LOCAL, "OkHttp: execute-enqueue"),
 Maps.immutableEntry(SpanType.CLIENT_OUTGOING, "OkHttp: GET /{param}"),
 Maps.immutableEntry(SpanType.LOCAL, "OkHttp: execute-run"),
 Maps.immutableEntry(SpanType.LOCAL, "OkHttp: dispatcher")));
 Span executeRunSpan = observedSpans.stream()
 .filter(s -> s.getOperation().equals("OkHttp: execute-run"))
 .findFirst()
 .get();

 assertThat(observedSpans).allSatisfy(span -> {
 if (span.getOperation().equals("OkHttp: GET /{param}")) {
 assertThat(span.type()).isEqualTo(SpanType.CLIENT_OUTGOING);
 assertThat(span.getParentSpanId().get()).isEqualTo(executeRunSpan.getSpanId());
 } else {
 assertThat(span.type()).isEqualTo(SpanType.LOCAL);
 assertThat(span.getParentSpanId().get()).isEqualTo(parentTrace.getSpanId());
 }
 });
 assertThat(observedSpans)
 .extracting(Span::getOperation)
 .containsExactly(
 "OkHttp: acquire-limiter-enqueue",
 "OkHttp: acquire-limiter-run",
 "ignored-span",
 "OkHttp: execute-enqueue",
 "OkHttp: GET /{param}",
 "OkHttp: execute-run");

 RecordedRequest request = server.takeRequest();
 assertThat(request.getHeader(TraceHttpHeaders.TRACE_ID), is(traceId));
 assertThat(request.getHeader(TraceHttpHeaders.SPAN_ID), is(not(parentTrace.getSpanId())));
 assertThat(request.getHeader(TraceHttpHeaders.TRACE_ID)).isEqualTo(traceId);
 assertThat(request.getHeader(TraceHttpHeaders.SPAN_ID)).isNotEqualTo(parentTrace.getSpanId());
 }

 @Test
Expand All@@ -89,7 +99,7 @@ public void testLimiterAcquisitionMultiThread() {
 addTraceSubscriber(observedTraceIds);
 runTwoRequestsInParallel();
 removeTraceSubscriber();
 assertThat(observedTraceIds, hasSize(2));
 assertThat(observedTraceIds).containsExactly("first", "second");
 }

 private void runTwoRequestsInParallel() {
Expand DownExpand Up@@ -130,7 +140,7 @@ private void reduceConcurrencyLimitTo1() {
 server.enqueue(new MockResponse().setResponseCode(429));
 });
 server.enqueue(new MockResponse().setBody("\"server\""));
 assertThat(service.string(), is("server"));
 assertThat(service.string()).isEqualTo("server");
 }
 }
}

32 changes: 32 additions & 0 deletions
okhttp-clients/src/main/java/com/palantir/conjure/java/okhttp/AsyncTracerTag.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
/*
 * (c) Copyright 2019 Palantir Technologies Inc. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.palantir.conjure.java.okhttp;

import com.palantir.conjure.java.client.config.ImmutablesStyle;
import com.palantir.tracing.AsyncTracer;
import org.immutables.value.Value;

@Value.Modifiable
@ImmutablesStyle
public interface AsyncTracerTag {
 AsyncTracer asyncTracer();
 AsyncTracerTag setAsyncTracer(AsyncTracer asyncTracer);

 static AsyncTracerTag create() {
 return ModifiableAsyncTracerTag.create();
 }
}

7 changes: 3 additions & 4 deletions
...src/main/java/com/palantir/conjure/java/okhttp/DispatcherTraceTerminatingInterceptor.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,19 +16,18 @@

package com.palantir.conjure.java.okhttp;

import com.palantir.tracing.AsyncTracer;
import java.io.IOException;
import okhttp3.Interceptor;
import okhttp3.Response;

public final class DispatcherTraceTerminatingInterceptor implements Interceptor {
 @Override
 public Response intercept(Chain chain) throws IOException {
AsyncTracer tracerTag = chain.request().tag(AsyncTracer.class);
 if (tracerTag == null) {
AsyncTracerTag tracerTag = chain.request().tag(AsyncTracerTag.class);
 if (tracerTag == null || tracerTag.asyncTracer() == null) {
 return chain.proceed(chain.request());
 }

 return tracerTag.withTrace(() -> chain.proceed(chain.request()));
 return tracerTag.asyncTracer().withTrace(() -> chain.proceed(chain.request()));
 }
}

3 changes: 1 addition & 2 deletions
okhttp-clients/src/main/java/com/palantir/conjure/java/okhttp/OkHttpClients.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,8 +81,7 @@ public final class OkHttpClients {
 * </li>
 * </ol>
 */
 private static final ExecutorService executionExecutor =
 Tracers.wrap("OkHttp: dispatcher", Executors.newCachedThreadPool(executionThreads));
 private static final ExecutorService executionExecutor = Executors.newCachedThreadPool(executionThreads);

 /** Shared dispatcher with static executor service. */
 private static final Dispatcher dispatcher;
Expand Down

12 changes: 10 additions & 2 deletions
okhttp-clients/src/main/java/com/palantir/conjure/java/okhttp/RemotingOkHttpCall.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,7 @@
import com.palantir.logsafe.exceptions.SafeIllegalStateException;
import com.palantir.logsafe.exceptions.SafeIoException;
import com.palantir.tracing.AsyncTracer;
import com.palantir.tracing.Tracer;
import java.io.IOException;
import java.io.InterruptedIOException;
import java.net.SocketTimeoutException;
Expand DownExpand Up@@ -165,8 +166,15 @@ public void enqueue(Callback callback) {
 Futures.addCallback(limiterListener, new FutureCallback<Limiter.Listener>() {
 @Override
 public void onSuccess(Limiter.Listener listener) {
 tracer.withTrace(() -> null);
 enqueueInternal(callback);
 tracer.withTrace(() -> {
@iamdanfoxiamdanfoxApr 18, 2019•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think before merging this it would be nice to come up with a solution that doesn't require us to include the acquire-limiter-run and ignore span hacks
@robert3005robert3005Apr 18, 2019

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That was my thought as well - this pr is here to point to intended behaviour
@carterkozakcarterkozakApr 18, 2019

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

palantir/tracing-java#124
@diogoholandadiogoholandaApr 22, 2019

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why was the hack here needed?

It seems like leaving the old behavior would suffice to leave the acquire-limiter-run span empty and the other spans with the appropriate parents:
tracer.withTrace(() -> null);
enqueueInternal(callback);

@robert3005robert3005Apr 23, 2019

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It won't work - the callback is executed on different thread and different trace. You need to add spans to the original trace
 // terminate acquire-limiter-run span
 Tracer.fastCompleteSpan();
 request().tag(AsyncTracerTag.class).setAsyncTracer(new AsyncTracer("OkHttp: execute"));
 enqueueInternal(callback);
 // Need to recreate a span to make sure withTrace will not close parent spans
 Tracer.startSpan("ignored-span");
 return null;
 });
 }

 @Override
Expand Down

3 changes: 1 addition & 2 deletions
okhttp-clients/src/main/java/com/palantir/conjure/java/okhttp/RemotingOkHttpClient.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,6 @@
import com.palantir.logsafe.SafeArg;
import com.palantir.logsafe.exceptions.SafeIllegalStateException;
import com.palantir.logsafe.exceptions.SafeRuntimeException;
import com.palantir.tracing.AsyncTracer;
import java.util.Optional;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.ScheduledExecutorService;
Expand DownExpand Up@@ -102,7 +101,7 @@ private Request createNewRequest(Request request) {
 return request.newBuilder()
 .url(getNewRequestUrl(request.url()))
 .tag(ConcurrencyLimiterListener.class, ConcurrencyLimiterListener.create())
 .tag(AsyncTracer.class, new AsyncTracer("OkHttp: execute"))
 .tag(AsyncTracerTag.class, AsyncTracerTag.create())
 .build();
 }

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
[improvement] Correctly nest spans when tracing okhttp requests#1069

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

 Closed

robert3005
wants to merge
3
commits into

from

 Closed


[improvement] Correctly nest spans when tracing okhttp requests
#1069
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
a88c32b

Correctly nest spans when tracing okhttp requests

Apr 18, 2019
49f243a

imports

Apr 18, 2019
ed3f6f3

correct condition

Apr 18, 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


52 changes: 31 additions & 21 deletions
...re-java-jaxrs-client/src/test/java/com/palantir/conjure/java/client/jaxrs/TracerTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,22 +16,17 @@

package com.palantir.conjure.java.client.jaxrs;

import static org.hamcrest.Matchers.contains;
import static org.hamcrest.Matchers.hasSize;
import static org.hamcrest.Matchers.is;
import static org.hamcrest.Matchers.not;
import static org.junit.Assert.assertThat;
import static org.assertj.core.api.Assertions.assertThat;

import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
import com.google.common.collect.Sets;
import com.palantir.conjure.java.okhttp.HostMetricsRegistry;
import com.palantir.tracing.Tracer;
import com.palantir.tracing.api.OpenSpan;
import com.palantir.tracing.api.Span;
import com.palantir.tracing.api.SpanType;
import com.palantir.tracing.api.TraceHttpHeaders;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import java.util.concurrent.CompletableFuture;
Expand DownExpand Up@@ -61,25 +56,40 @@ public void before() {
 public void testClientIsInstrumentedWithTracer() throws InterruptedException {
 server.enqueue(new MockResponse().setBody("\"server\""));
 OpenSpan parentTrace = Tracer.startSpan("");
 List<Map.Entry<SpanType, String>> observedSpans = Lists.newArrayList();
 Tracer.subscribe(TracerTest.class.getName(),
 span -> observedSpans.add(Maps.immutableEntry(span.type(), span.getOperation())));
 List<Span> observedSpans = Lists.newArrayList();
 Tracer.subscribe(TracerTest.class.getName(), observedSpans::add);

 String traceId = Tracer.getTraceId();
 service.param("somevalue");

 Tracer.unsubscribe(TracerTest.class.getName());
 assertThat(observedSpans, contains(
 Maps.immutableEntry(SpanType.LOCAL, "OkHttp: acquire-limiter-enqueue"),
 Maps.immutableEntry(SpanType.LOCAL, "OkHttp: acquire-limiter-run"),
 Maps.immutableEntry(SpanType.LOCAL, "OkHttp: execute-enqueue"),
 Maps.immutableEntry(SpanType.CLIENT_OUTGOING, "OkHttp: GET /{param}"),
 Maps.immutableEntry(SpanType.LOCAL, "OkHttp: execute-run"),
 Maps.immutableEntry(SpanType.LOCAL, "OkHttp: dispatcher")));
 Span executeRunSpan = observedSpans.stream()
 .filter(s -> s.getOperation().equals("OkHttp: execute-run"))
 .findFirst()
 .get();

 assertThat(observedSpans).allSatisfy(span -> {
 if (span.getOperation().equals("OkHttp: GET /{param}")) {
 assertThat(span.type()).isEqualTo(SpanType.CLIENT_OUTGOING);
 assertThat(span.getParentSpanId().get()).isEqualTo(executeRunSpan.getSpanId());
 } else {
 assertThat(span.type()).isEqualTo(SpanType.LOCAL);
 assertThat(span.getParentSpanId().get()).isEqualTo(parentTrace.getSpanId());
 }
 });
 assertThat(observedSpans)
 .extracting(Span::getOperation)
 .containsExactly(
 "OkHttp: acquire-limiter-enqueue",
 "OkHttp: acquire-limiter-run",
 "ignored-span",
 "OkHttp: execute-enqueue",
 "OkHttp: GET /{param}",
 "OkHttp: execute-run");

 RecordedRequest request = server.takeRequest();
 assertThat(request.getHeader(TraceHttpHeaders.TRACE_ID), is(traceId));
 assertThat(request.getHeader(TraceHttpHeaders.SPAN_ID), is(not(parentTrace.getSpanId())));
 assertThat(request.getHeader(TraceHttpHeaders.TRACE_ID)).isEqualTo(traceId);
 assertThat(request.getHeader(TraceHttpHeaders.SPAN_ID)).isNotEqualTo(parentTrace.getSpanId());
 }

 @Test
Expand All@@ -89,7 +99,7 @@ public void testLimiterAcquisitionMultiThread() {
 addTraceSubscriber(observedTraceIds);
 runTwoRequestsInParallel();
 removeTraceSubscriber();
 assertThat(observedTraceIds, hasSize(2));
 assertThat(observedTraceIds).containsExactly("first", "second");
 }

 private void runTwoRequestsInParallel() {
Expand DownExpand Up@@ -130,7 +140,7 @@ private void reduceConcurrencyLimitTo1() {
 server.enqueue(new MockResponse().setResponseCode(429));
 });
 server.enqueue(new MockResponse().setBody("\"server\""));
 assertThat(service.string(), is("server"));
 assertThat(service.string()).isEqualTo("server");
 }
 }
}

32 changes: 32 additions & 0 deletions
okhttp-clients/src/main/java/com/palantir/conjure/java/okhttp/AsyncTracerTag.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
/*
 * (c) Copyright 2019 Palantir Technologies Inc. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.palantir.conjure.java.okhttp;

import com.palantir.conjure.java.client.config.ImmutablesStyle;
import com.palantir.tracing.AsyncTracer;
import org.immutables.value.Value;

@Value.Modifiable
@ImmutablesStyle
public interface AsyncTracerTag {
 AsyncTracer asyncTracer();
 AsyncTracerTag setAsyncTracer(AsyncTracer asyncTracer);

 static AsyncTracerTag create() {
 return ModifiableAsyncTracerTag.create();
 }
}

7 changes: 3 additions & 4 deletions
...src/main/java/com/palantir/conjure/java/okhttp/DispatcherTraceTerminatingInterceptor.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,19 +16,18 @@

package com.palantir.conjure.java.okhttp;

import com.palantir.tracing.AsyncTracer;
import java.io.IOException;
import okhttp3.Interceptor;
import okhttp3.Response;

public final class DispatcherTraceTerminatingInterceptor implements Interceptor {
 @Override
 public Response intercept(Chain chain) throws IOException {
AsyncTracer tracerTag = chain.request().tag(AsyncTracer.class);
 if (tracerTag == null) {
AsyncTracerTag tracerTag = chain.request().tag(AsyncTracerTag.class);
 if (tracerTag == null || tracerTag.asyncTracer() == null) {
 return chain.proceed(chain.request());
 }

 return tracerTag.withTrace(() -> chain.proceed(chain.request()));
 return tracerTag.asyncTracer().withTrace(() -> chain.proceed(chain.request()));
 }
}

3 changes: 1 addition & 2 deletions
okhttp-clients/src/main/java/com/palantir/conjure/java/okhttp/OkHttpClients.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,8 +81,7 @@ public final class OkHttpClients {
 * </li>
 * </ol>
 */
 private static final ExecutorService executionExecutor =
 Tracers.wrap("OkHttp: dispatcher", Executors.newCachedThreadPool(executionThreads));
 private static final ExecutorService executionExecutor = Executors.newCachedThreadPool(executionThreads);

 /** Shared dispatcher with static executor service. */
 private static final Dispatcher dispatcher;
Expand Down

12 changes: 10 additions & 2 deletions
okhttp-clients/src/main/java/com/palantir/conjure/java/okhttp/RemotingOkHttpCall.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,7 @@
import com.palantir.logsafe.exceptions.SafeIllegalStateException;
import com.palantir.logsafe.exceptions.SafeIoException;
import com.palantir.tracing.AsyncTracer;
import com.palantir.tracing.Tracer;
import java.io.IOException;
import java.io.InterruptedIOException;
import java.net.SocketTimeoutException;
Expand DownExpand Up@@ -165,8 +166,15 @@ public void enqueue(Callback callback) {
 Futures.addCallback(limiterListener, new FutureCallback<Limiter.Listener>() {
 @Override
 public void onSuccess(Limiter.Listener listener) {
 tracer.withTrace(() -> null);
 enqueueInternal(callback);
 tracer.withTrace(() -> {
@iamdanfoxiamdanfoxApr 18, 2019•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think before merging this it would be nice to come up with a solution that doesn't require us to include the acquire-limiter-run and ignore span hacks
@robert3005robert3005Apr 18, 2019

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That was my thought as well - this pr is here to point to intended behaviour
@carterkozakcarterkozakApr 18, 2019

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

palantir/tracing-java#124
@diogoholandadiogoholandaApr 22, 2019

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why was the hack here needed?

It seems like leaving the old behavior would suffice to leave the acquire-limiter-run span empty and the other spans with the appropriate parents:
tracer.withTrace(() -> null);
enqueueInternal(callback);

@robert3005robert3005Apr 23, 2019

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It won't work - the callback is executed on different thread and different trace. You need to add spans to the original trace
 // terminate acquire-limiter-run span
 Tracer.fastCompleteSpan();
 request().tag(AsyncTracerTag.class).setAsyncTracer(new AsyncTracer("OkHttp: execute"));
 enqueueInternal(callback);
 // Need to recreate a span to make sure withTrace will not close parent spans
 Tracer.startSpan("ignored-span");
 return null;
 });
 }

 @Override
Expand Down

3 changes: 1 addition & 2 deletions
okhttp-clients/src/main/java/com/palantir/conjure/java/okhttp/RemotingOkHttpClient.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,6 @@
import com.palantir.logsafe.SafeArg;
import com.palantir.logsafe.exceptions.SafeIllegalStateException;
import com.palantir.logsafe.exceptions.SafeRuntimeException;
import com.palantir.tracing.AsyncTracer;
import java.util.Optional;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.ScheduledExecutorService;
Expand DownExpand Up@@ -102,7 +101,7 @@ private Request createNewRequest(Request request) {
 return request.newBuilder()
 .url(getNewRequestUrl(request.url()))
 .tag(ConcurrencyLimiterListener.class, ConcurrencyLimiterListener.create())
 .tag(AsyncTracer.class, new AsyncTracer("OkHttp: execute"))
 .tag(AsyncTracerTag.class, AsyncTracerTag.create())
 .build();
 }

Expand Down