[improvement] Tracer spans are inexpensive for unsampled operations#180

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bulldozer-bot merged 12 commits into from
Jun 24, 2019
Merged

[improvement] Tracer spans are inexpensive for unsampled operations #180

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
9ab758a
Split Tracer into Sampled+Unsampled types
carterkozak Jun 20, 2019
f08617b
error prone validation to prefer the fast path
carterkozak Jun 20, 2019
6063502
Refactor startSpan logic into Tracer to reduce duplication
carterkozak Jun 20, 2019
e1adc3c
Clean up TracingBenchmark a bit
carterkozak Jun 20, 2019
41896d4
Match default sample rate
carterkozak Jun 21, 2019
90e45fb
Annotate Trace internal methods with CheckReturnValue
carterkozak Jun 21, 2019
64e9214
s/depth/numberOfSpans
carterkozak Jun 21, 2019
752fb36
style
carterkozak Jun 21, 2019
1b57d51
class level design documentation
carterkozak Jun 21, 2019
80340a3
Trace.push is an internal concern
carterkozak Jun 23, 2019
9d06c36
rename validateDepth -> validateNumberOfSpans
carterkozak Jun 23, 2019
da00afb
popCurrentSpan takes a trace
carterkozak Jun 24, 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
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@ bin/
.idea/
out/
generated_src/
generated_testSrc/

# Codegen
.generated
Expand Down
20 changes: 10 additions & 10 deletions tracing-benchmarks/src/jmh/java/com/palantir/tracing/TracingBenchmark.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,7 @@

package com.palantir.tracing;

import com.google.common.util.concurrent.Runnables;
import java.util.concurrent.TimeUnit;
import org.openjdk.jmh.annotations.Benchmark;
import org.openjdk.jmh.annotations.BenchmarkMode;
Expand DownExpand Up@@ -47,13 +48,13 @@
@SuppressWarnings({"checkstyle:hideutilityclassconstructor", "checkstyle:VisibilityModifier"})
public class TracingBenchmark {

private static final Runnable nestedSpans = createnestedSpan(100);
private static final Runnable nestedSpans = createNestedSpan(100);

@SuppressWarnings("ImmutableEnumChecker")
public enum BenchmarkObservability {
SAMPLE(AlwaysSampler.INSTANCE),
DO_NOT_SAMPLE(() -> false),
UNDECIDED(new RandomSampler(0.1f));
UNDECIDED(new RandomSampler(0.01f));

private final TraceSampler traceSampler;

Expand DownExpand Up@@ -87,20 +88,19 @@ public static void nestedSpans() {
nestedSpans.run();
}

private static Runnable createnestedSpan(int depth) {
if (depth == 0) {
return () -> {
};
private static Runnable createNestedSpan(int depth) {
if (depth <= 0) {
return Runnables.doNothing();
} else {
return wrapWithSpan(createnestedSpan(depth - 1));
return wrapWithSpan("benchmark-span-" + depth, createNestedSpan(depth - 1));
}
}

private static Runnable wrapWithSpan(Runnable toBenNested) {
private static Runnable wrapWithSpan(String operation, Runnable next) {
return () -> {
Tracer.fastStartSpan(operation);
try {
Tracer.startSpan("span");
toBenNested.run();
next.run();
} finally {
Tracer.fastCompleteSpan();
}
Expand Down
49 changes: 43 additions & 6 deletions tracing-jaxrs/src/test/java/com/palantir/tracing/jaxrs/JaxRsTracersTest.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@

import static org.assertj.core.api.Assertions.assertThat;

import com.palantir.tracing.AlwaysSampler;
import com.palantir.tracing.Tracer;
import java.io.ByteArrayOutputStream;
import javax.ws.rs.core.StreamingOutput;
Expand All@@ -26,22 +27,58 @@
public final class JaxRsTracersTest {

@Test
public void testWrappingStreamingOutput_streamingOutputTraceIsIsolated() throws Exception {
Tracer.startSpan("outside");
public void testWrappingStreamingOutput_streamingOutputTraceIsIsolated_sampled() throws Exception {
Tracer.setSampler(AlwaysSampler.INSTANCE);
Tracer.getAndClearTrace();

Tracer.fastStartSpan("outside");
StreamingOutput streamingOutput = JaxRsTracers.wrap(os -> {
Tracer.startSpan("inside"); // never completed
Tracer.fastStartSpan("inside"); // never completed
});
streamingOutput.write(new ByteArrayOutputStream());
assertThat(Tracer.completeSpan().get().getOperation()).isEqualTo("outside");
}

@Test
public void testWrappingStreamingOutput_traceStateIsCapturedAtConstructionTime() throws Exception {
Tracer.startSpan("before-construction");
public void testWrappingStreamingOutput_streamingOutputTraceIsIsolated_unsampled() throws Exception {
Tracer.setSampler(() -> false);
Tracer.getAndClearTrace();

Tracer.fastStartSpan("outside");
StreamingOutput streamingOutput = JaxRsTracers.wrap(os -> {
Tracer.fastStartSpan("inside"); // never completed
});
streamingOutput.write(new ByteArrayOutputStream());
assertThat(Tracer.hasTraceId()).isTrue();
Tracer.fastCompleteSpan();
assertThat(Tracer.hasTraceId()).isFalse();
}

@Test
public void testWrappingStreamingOutput_traceStateIsCapturedAtConstructionTime_sampled() throws Exception {
Tracer.setSampler(AlwaysSampler.INSTANCE);
Tracer.getAndClearTrace();

Tracer.fastStartSpan("before-construction");
StreamingOutput streamingOutput = JaxRsTracers.wrap(os -> {
assertThat(Tracer.completeSpan().get().getOperation()).isEqualTo("streaming-output");
});
Tracer.startSpan("after-construction");
Tracer.fastStartSpan("after-construction");
streamingOutput.write(new ByteArrayOutputStream());
}

@Test
public void testWrappingStreamingOutput_traceStateIsCapturedAtConstructionTime_unsampled() throws Exception {
Tracer.setSampler(() -> false);
Tracer.getAndClearTrace();

Tracer.fastStartSpan("before-construction");
StreamingOutput streamingOutput = JaxRsTracers.wrap(os -> {
assertThat(Tracer.hasTraceId()).isTrue();
Tracer.fastCompleteSpan();
assertThat(Tracer.hasTraceId()).isFalse();
});
Tracer.fastStartSpan("after-construction");
streamingOutput.write(new ByteArrayOutputStream());
}
}
6 changes: 3 additions & 3 deletions tracing-jersey/src/main/java/com/palantir/tracing/jersey/TraceEnrichingFilter.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -68,14 +68,14 @@ public void filter(ContainerRequestContext requestContext) throws IOException {
if (Strings.isNullOrEmpty(traceId)) {
// HTTP request did not indicate a trace; initialize trace state and create a span.
Tracer.initTrace(getObservabilityFromHeader(requestContext), Tracers.randomId());
Tracer.startSpan(operation, SpanType.SERVER_INCOMING);
Tracer.fastStartSpan(operation, SpanType.SERVER_INCOMING);
} else {
Tracer.initTrace(getObservabilityFromHeader(requestContext), traceId);
if (spanId == null) {
Tracer.startSpan(operation, SpanType.SERVER_INCOMING);
Tracer.fastStartSpan(operation, SpanType.SERVER_INCOMING);
} else {
// caller's span is this span's parent.
Tracer.startSpan(operation, spanId, SpanType.SERVER_INCOMING);
Tracer.fastStartSpan(operation, spanId, SpanType.SERVER_INCOMING);
}
}

Expand Down
4 changes: 2 additions & 2 deletions tracing-servlet/src/test/java/com/palantir/tracing/servlet/LeakedTraceFilterTest.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -103,7 +103,7 @@ public void doFilter(ServletRequest request, ServletResponse response, FilterCha
throws IOException, ServletException {
// Open a span to simulate a thread from another request
// leaving bad data without the leaked trace filter applied.
Tracer.startSpan("previous request leaked");
Tracer.fastStartSpan("previous request leaked");
chain.doFilter(request, response);
}

Expand DownExpand Up@@ -140,7 +140,7 @@ public void destroy() {}
env.servlets().addServlet("alwaysLeaks", new HttpServlet() {
@Override
protected void service(HttpServletRequest req, HttpServletResponse resp) {
Tracer.startSpan("leaky");
Tracer.fastStartSpan("leaky");
resp.addHeader("Leaky-Invoked", "true");
}
}).addMapping("/leaky");
Expand Down
6 changes: 3 additions & 3 deletions tracing-undertow/src/main/java/com/palantir/tracing/undertow/TracedOperationHandler.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -103,10 +103,10 @@ private void initializeTraceFromExisting(HeaderMap headers, String traceId) {
Tracer.initTrace(getObservabilityFromHeader(headers), traceId);
String spanId = headers.getFirst(SPAN_ID); // nullable
if (spanId == null) {
Tracer.startSpan(operation, SpanType.SERVER_INCOMING);
Tracer.fastStartSpan(operation, SpanType.SERVER_INCOMING);
} else {
// caller's span is this span's parent.
Tracer.startSpan(operation, spanId, SpanType.SERVER_INCOMING);
Tracer.fastStartSpan(operation, spanId, SpanType.SERVER_INCOMING);
}
}

Expand All@@ -115,7 +115,7 @@ private String initializeNewTrace(HeaderMap headers) {
// HTTP request did not indicate a trace; initialize trace state and create a span.
String newTraceId = Tracers.randomId();
Tracer.initTrace(getObservabilityFromHeader(headers), newTraceId);
Tracer.startSpan(operation, SpanType.SERVER_INCOMING);
Tracer.fastStartSpan(operation, SpanType.SERVER_INCOMING);
return newTraceId;
}

Expand Down
4 changes: 2 additions & 2 deletions tracing/src/main/java/com/palantir/tracing/AsyncTracer.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -62,7 +62,7 @@ public AsyncTracer(String operation) {
*/
public AsyncTracer(Optional<String> operation) {
this.operation = operation.orElse(DEFAULT_OPERATION);
Tracer.startSpan(this.operation + "-enqueue");
Tracer.fastStartSpan(this.operation + "-enqueue");
deferredTrace = Tracer.copyTrace().get();
Tracer.fastDiscardSpan(); // span will completed in the deferred execution
}
Expand All@@ -76,7 +76,7 @@ public <T, E extends Throwable> T withTrace(Tracers.ThrowingCallable<T, E> inner
Tracer.setTrace(deferredTrace);
// Finish the enqueue span
Tracer.fastCompleteSpan();
Tracer.startSpan(operation + "-run");
Tracer.fastStartSpan(operation + "-run");
try {
return inner.call();
} finally {
Expand Down
2 changes: 1 addition & 1 deletion tracing/src/main/java/com/palantir/tracing/CloseableTracer.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,7 @@ public static CloseableTracer startSpan(String operation) {
* labeled with the provided operation.
*/
public static CloseableTracer startSpan(String operation, SpanType spanType) {
Tracer.startSpan(operation, spanType);
Tracer.fastStartSpan(operation, spanType);
return INSTANCE;
}

Expand Down
6 changes: 3 additions & 3 deletions tracing/src/main/java/com/palantir/tracing/DeferredTracer.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -104,11 +104,11 @@ public <T, E extends Throwable> T withTrace(Tracers.ThrowingCallable<T, E> inner

Optional<Trace> originalTrace = Tracer.copyTrace();

Tracer.setTrace(new Trace(isObservable, traceId));
Tracer.setTrace(Trace.of(isObservable, traceId));
if (parentSpanId != null) {
Tracer.startSpan(operation, parentSpanId, SpanType.LOCAL);
Tracer.fastStartSpan(operation, parentSpanId, SpanType.LOCAL);
} else {
Tracer.startSpan(operation);
Tracer.fastStartSpan(operation);
}

try {
Expand Down
Loading
, '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] Tracer spans are inexpensive for unsampled operations#180

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

bulldozer-bot
merged 12 commits into

from

Jun 24, 2019
 Merged


[improvement] Tracer spans are inexpensive for unsampled operations
#180
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


12 commits


Select commit
Hold shift + click to select a range
9ab758a

Split Tracer into Sampled+Unsampled types


carterkozak Jun 20, 2019
f08617b

error prone validation to prefer the fast path


carterkozak Jun 20, 2019
6063502

Refactor startSpan logic into Tracer to reduce duplication


carterkozak Jun 20, 2019
e1adc3c

Clean up TracingBenchmark a bit


carterkozak Jun 20, 2019
41896d4

Match default sample rate


carterkozak Jun 21, 2019
90e45fb

Annotate Trace internal methods with CheckReturnValue


carterkozak Jun 21, 2019
64e9214

s/depth/numberOfSpans


carterkozak Jun 21, 2019
752fb36

style


carterkozak Jun 21, 2019
1b57d51

class level design documentation


carterkozak Jun 21, 2019
80340a3

Trace.push is an internal concern


carterkozak Jun 23, 2019
9d06c36

rename validateDepth -> validateNumberOfSpans


carterkozak Jun 23, 2019
da00afb

popCurrentSpan takes a trace


carterkozak Jun 24, 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


1 change: 1 addition & 0 deletions
.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@ bin/
.idea/
out/
generated_src/
generated_testSrc/

# Codegen
.generated
Expand Down

20 changes: 10 additions & 10 deletions
tracing-benchmarks/src/jmh/java/com/palantir/tracing/TracingBenchmark.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,7 @@

package com.palantir.tracing;

import com.google.common.util.concurrent.Runnables;
import java.util.concurrent.TimeUnit;
import org.openjdk.jmh.annotations.Benchmark;
import org.openjdk.jmh.annotations.BenchmarkMode;
Expand DownExpand Up@@ -47,13 +48,13 @@
@SuppressWarnings({"checkstyle:hideutilityclassconstructor", "checkstyle:VisibilityModifier"})
public class TracingBenchmark {

 private static final Runnable nestedSpans = createnestedSpan(100);
 private static final Runnable nestedSpans = createNestedSpan(100);

 @SuppressWarnings("ImmutableEnumChecker")
 public enum BenchmarkObservability {
 SAMPLE(AlwaysSampler.INSTANCE),
 DO_NOT_SAMPLE(() -> false),
 UNDECIDED(new RandomSampler(0.1f));
 UNDECIDED(new RandomSampler(0.01f));

 private final TraceSampler traceSampler;

Expand DownExpand Up@@ -87,20 +88,19 @@ public static void nestedSpans() {
 nestedSpans.run();
 }

 private static Runnable createnestedSpan(int depth) {
 if (depth == 0) {
 return () -> {
 };
 private static Runnable createNestedSpan(int depth) {
 if (depth <= 0) {
 return Runnables.doNothing();
 } else {
 return wrapWithSpan(createnestedSpan(depth - 1));
 return wrapWithSpan("benchmark-span-" + depth, createNestedSpan(depth - 1));
 }
 }

 private static Runnable wrapWithSpan(Runnable toBenNested) {
 private static Runnable wrapWithSpan(String operation, Runnable next) {
 return () -> {
 Tracer.fastStartSpan(operation);
 try {
 Tracer.startSpan("span");
 toBenNested.run();
 next.run();
 } finally {
 Tracer.fastCompleteSpan();
 }
Expand Down

49 changes: 43 additions & 6 deletions
tracing-jaxrs/src/test/java/com/palantir/tracing/jaxrs/JaxRsTracersTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@

import static org.assertj.core.api.Assertions.assertThat;

import com.palantir.tracing.AlwaysSampler;
import com.palantir.tracing.Tracer;
import java.io.ByteArrayOutputStream;
import javax.ws.rs.core.StreamingOutput;
Expand All@@ -26,22 +27,58 @@
public final class JaxRsTracersTest {

 @Test
 public void testWrappingStreamingOutput_streamingOutputTraceIsIsolated() throws Exception {
 Tracer.startSpan("outside");
 public void testWrappingStreamingOutput_streamingOutputTraceIsIsolated_sampled() throws Exception {
 Tracer.setSampler(AlwaysSampler.INSTANCE);
 Tracer.getAndClearTrace();

 Tracer.fastStartSpan("outside");
 StreamingOutput streamingOutput = JaxRsTracers.wrap(os -> {
 Tracer.startSpan("inside"); // never completed
 Tracer.fastStartSpan("inside"); // never completed
 });
 streamingOutput.write(new ByteArrayOutputStream());
 assertThat(Tracer.completeSpan().get().getOperation()).isEqualTo("outside");
 }

 @Test
 public void testWrappingStreamingOutput_traceStateIsCapturedAtConstructionTime() throws Exception {
 Tracer.startSpan("before-construction");
 public void testWrappingStreamingOutput_streamingOutputTraceIsIsolated_unsampled() throws Exception {
 Tracer.setSampler(() -> false);
 Tracer.getAndClearTrace();

 Tracer.fastStartSpan("outside");
 StreamingOutput streamingOutput = JaxRsTracers.wrap(os -> {
 Tracer.fastStartSpan("inside"); // never completed
 });
 streamingOutput.write(new ByteArrayOutputStream());
 assertThat(Tracer.hasTraceId()).isTrue();
 Tracer.fastCompleteSpan();
 assertThat(Tracer.hasTraceId()).isFalse();
 }

 @Test
 public void testWrappingStreamingOutput_traceStateIsCapturedAtConstructionTime_sampled() throws Exception {
 Tracer.setSampler(AlwaysSampler.INSTANCE);
 Tracer.getAndClearTrace();

 Tracer.fastStartSpan("before-construction");
 StreamingOutput streamingOutput = JaxRsTracers.wrap(os -> {
 assertThat(Tracer.completeSpan().get().getOperation()).isEqualTo("streaming-output");
 });
 Tracer.startSpan("after-construction");
 Tracer.fastStartSpan("after-construction");
 streamingOutput.write(new ByteArrayOutputStream());
 }

 @Test
 public void testWrappingStreamingOutput_traceStateIsCapturedAtConstructionTime_unsampled() throws Exception {
 Tracer.setSampler(() -> false);
 Tracer.getAndClearTrace();

 Tracer.fastStartSpan("before-construction");
 StreamingOutput streamingOutput = JaxRsTracers.wrap(os -> {
 assertThat(Tracer.hasTraceId()).isTrue();
 Tracer.fastCompleteSpan();
 assertThat(Tracer.hasTraceId()).isFalse();
 });
 Tracer.fastStartSpan("after-construction");
 streamingOutput.write(new ByteArrayOutputStream());
 }
}

6 changes: 3 additions & 3 deletions
tracing-jersey/src/main/java/com/palantir/tracing/jersey/TraceEnrichingFilter.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -68,14 +68,14 @@ public void filter(ContainerRequestContext requestContext) throws IOException {
 if (Strings.isNullOrEmpty(traceId)) {
 // HTTP request did not indicate a trace; initialize trace state and create a span.
 Tracer.initTrace(getObservabilityFromHeader(requestContext), Tracers.randomId());
 Tracer.startSpan(operation, SpanType.SERVER_INCOMING);
 Tracer.fastStartSpan(operation, SpanType.SERVER_INCOMING);
 } else {
 Tracer.initTrace(getObservabilityFromHeader(requestContext), traceId);
 if (spanId == null) {
 Tracer.startSpan(operation, SpanType.SERVER_INCOMING);
 Tracer.fastStartSpan(operation, SpanType.SERVER_INCOMING);
 } else {
 // caller's span is this span's parent.
 Tracer.startSpan(operation, spanId, SpanType.SERVER_INCOMING);
 Tracer.fastStartSpan(operation, spanId, SpanType.SERVER_INCOMING);
 }
 }

Expand Down

4 changes: 2 additions & 2 deletions
tracing-servlet/src/test/java/com/palantir/tracing/servlet/LeakedTraceFilterTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,7 +103,7 @@ public void doFilter(ServletRequest request, ServletResponse response, FilterCha
 throws IOException, ServletException {
 // Open a span to simulate a thread from another request
 // leaving bad data without the leaked trace filter applied.
 Tracer.startSpan("previous request leaked");
 Tracer.fastStartSpan("previous request leaked");
 chain.doFilter(request, response);
 }

Expand DownExpand Up@@ -140,7 +140,7 @@ public void destroy() {}
 env.servlets().addServlet("alwaysLeaks", new HttpServlet() {
 @Override
 protected void service(HttpServletRequest req, HttpServletResponse resp) {
 Tracer.startSpan("leaky");
 Tracer.fastStartSpan("leaky");
 resp.addHeader("Leaky-Invoked", "true");
 }
 }).addMapping("/leaky");
Expand Down

6 changes: 3 additions & 3 deletions
tracing-undertow/src/main/java/com/palantir/tracing/undertow/TracedOperationHandler.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,10 +103,10 @@ private void initializeTraceFromExisting(HeaderMap headers, String traceId) {
 Tracer.initTrace(getObservabilityFromHeader(headers), traceId);
 String spanId = headers.getFirst(SPAN_ID); // nullable
 if (spanId == null) {
 Tracer.startSpan(operation, SpanType.SERVER_INCOMING);
 Tracer.fastStartSpan(operation, SpanType.SERVER_INCOMING);
 } else {
 // caller's span is this span's parent.
 Tracer.startSpan(operation, spanId, SpanType.SERVER_INCOMING);
 Tracer.fastStartSpan(operation, spanId, SpanType.SERVER_INCOMING);
 }
 }

Expand All@@ -115,7 +115,7 @@ private String initializeNewTrace(HeaderMap headers) {
 // HTTP request did not indicate a trace; initialize trace state and create a span.
 String newTraceId = Tracers.randomId();
 Tracer.initTrace(getObservabilityFromHeader(headers), newTraceId);
 Tracer.startSpan(operation, SpanType.SERVER_INCOMING);
 Tracer.fastStartSpan(operation, SpanType.SERVER_INCOMING);
 return newTraceId;
 }

Expand Down

4 changes: 2 additions & 2 deletions
tracing/src/main/java/com/palantir/tracing/AsyncTracer.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,7 +62,7 @@ public AsyncTracer(String operation) {
 */
 public AsyncTracer(Optional<String> operation) {
 this.operation = operation.orElse(DEFAULT_OPERATION);
 Tracer.startSpan(this.operation + "-enqueue");
 Tracer.fastStartSpan(this.operation + "-enqueue");
 deferredTrace = Tracer.copyTrace().get();
 Tracer.fastDiscardSpan(); // span will completed in the deferred execution
 }
Expand All@@ -76,7 +76,7 @@ public <T, E extends Throwable> T withTrace(Tracers.ThrowingCallable<T, E> inner
 Tracer.setTrace(deferredTrace);
 // Finish the enqueue span
 Tracer.fastCompleteSpan();
 Tracer.startSpan(operation + "-run");
 Tracer.fastStartSpan(operation + "-run");
 try {
 return inner.call();
 } finally {
Expand Down

2 changes: 1 addition & 1 deletion
tracing/src/main/java/com/palantir/tracing/CloseableTracer.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,7 @@ public static CloseableTracer startSpan(String operation) {
 * labeled with the provided operation.
 */
 public static CloseableTracer startSpan(String operation, SpanType spanType) {
 Tracer.startSpan(operation, spanType);
 Tracer.fastStartSpan(operation, spanType);
 return INSTANCE;
 }

Expand Down

6 changes: 3 additions & 3 deletions
tracing/src/main/java/com/palantir/tracing/DeferredTracer.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -104,11 +104,11 @@ public <T, E extends Throwable> T withTrace(Tracers.ThrowingCallable<T, E> inner

 Optional<Trace> originalTrace = Tracer.copyTrace();

 Tracer.setTrace(new Trace(isObservable, traceId));
 Tracer.setTrace(Trace.of(isObservable, traceId));
 if (parentSpanId != null) {
 Tracer.startSpan(operation, parentSpanId, SpanType.LOCAL);
 Tracer.fastStartSpan(operation, parentSpanId, SpanType.LOCAL);
 } else {
 Tracer.startSpan(operation);
 Tracer.fastStartSpan(operation);
 }

 try {
Expand Down
Loading

, '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] Tracer spans are inexpensive for unsampled operations#180

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

bulldozer-bot
merged 12 commits into

from

Jun 24, 2019
 Merged


[improvement] Tracer spans are inexpensive for unsampled operations
#180
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


12 commits


Select commit
Hold shift + click to select a range
9ab758a

Split Tracer into Sampled+Unsampled types


carterkozak Jun 20, 2019
f08617b

error prone validation to prefer the fast path


carterkozak Jun 20, 2019
6063502

Refactor startSpan logic into Tracer to reduce duplication


carterkozak Jun 20, 2019
e1adc3c

Clean up TracingBenchmark a bit


carterkozak Jun 20, 2019
41896d4

Match default sample rate


carterkozak Jun 21, 2019
90e45fb

Annotate Trace internal methods with CheckReturnValue


carterkozak Jun 21, 2019
64e9214

s/depth/numberOfSpans


carterkozak Jun 21, 2019
752fb36

style


carterkozak Jun 21, 2019
1b57d51

class level design documentation


carterkozak Jun 21, 2019
80340a3

Trace.push is an internal concern


carterkozak Jun 23, 2019
9d06c36

rename validateDepth -> validateNumberOfSpans


carterkozak Jun 23, 2019
da00afb

popCurrentSpan takes a trace


carterkozak Jun 24, 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


1 change: 1 addition & 0 deletions
.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@ bin/
.idea/
out/
generated_src/
generated_testSrc/

# Codegen
.generated
Expand Down

20 changes: 10 additions & 10 deletions
tracing-benchmarks/src/jmh/java/com/palantir/tracing/TracingBenchmark.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,7 @@

package com.palantir.tracing;

import com.google.common.util.concurrent.Runnables;
import java.util.concurrent.TimeUnit;
import org.openjdk.jmh.annotations.Benchmark;
import org.openjdk.jmh.annotations.BenchmarkMode;
Expand DownExpand Up@@ -47,13 +48,13 @@
@SuppressWarnings({"checkstyle:hideutilityclassconstructor", "checkstyle:VisibilityModifier"})
public class TracingBenchmark {

 private static final Runnable nestedSpans = createnestedSpan(100);
 private static final Runnable nestedSpans = createNestedSpan(100);

 @SuppressWarnings("ImmutableEnumChecker")
 public enum BenchmarkObservability {
 SAMPLE(AlwaysSampler.INSTANCE),
 DO_NOT_SAMPLE(() -> false),
 UNDECIDED(new RandomSampler(0.1f));
 UNDECIDED(new RandomSampler(0.01f));

 private final TraceSampler traceSampler;

Expand DownExpand Up@@ -87,20 +88,19 @@ public static void nestedSpans() {
 nestedSpans.run();
 }

 private static Runnable createnestedSpan(int depth) {
 if (depth == 0) {
 return () -> {
 };
 private static Runnable createNestedSpan(int depth) {
 if (depth <= 0) {
 return Runnables.doNothing();
 } else {
 return wrapWithSpan(createnestedSpan(depth - 1));
 return wrapWithSpan("benchmark-span-" + depth, createNestedSpan(depth - 1));
 }
 }

 private static Runnable wrapWithSpan(Runnable toBenNested) {
 private static Runnable wrapWithSpan(String operation, Runnable next) {
 return () -> {
 Tracer.fastStartSpan(operation);
 try {
 Tracer.startSpan("span");
 toBenNested.run();
 next.run();
 } finally {
 Tracer.fastCompleteSpan();
 }
Expand Down

49 changes: 43 additions & 6 deletions
tracing-jaxrs/src/test/java/com/palantir/tracing/jaxrs/JaxRsTracersTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@

import static org.assertj.core.api.Assertions.assertThat;

import com.palantir.tracing.AlwaysSampler;
import com.palantir.tracing.Tracer;
import java.io.ByteArrayOutputStream;
import javax.ws.rs.core.StreamingOutput;
Expand All@@ -26,22 +27,58 @@
public final class JaxRsTracersTest {

 @Test
 public void testWrappingStreamingOutput_streamingOutputTraceIsIsolated() throws Exception {
 Tracer.startSpan("outside");
 public void testWrappingStreamingOutput_streamingOutputTraceIsIsolated_sampled() throws Exception {
 Tracer.setSampler(AlwaysSampler.INSTANCE);
 Tracer.getAndClearTrace();

 Tracer.fastStartSpan("outside");
 StreamingOutput streamingOutput = JaxRsTracers.wrap(os -> {
 Tracer.startSpan("inside"); // never completed
 Tracer.fastStartSpan("inside"); // never completed
 });
 streamingOutput.write(new ByteArrayOutputStream());
 assertThat(Tracer.completeSpan().get().getOperation()).isEqualTo("outside");
 }

 @Test
 public void testWrappingStreamingOutput_traceStateIsCapturedAtConstructionTime() throws Exception {
 Tracer.startSpan("before-construction");
 public void testWrappingStreamingOutput_streamingOutputTraceIsIsolated_unsampled() throws Exception {
 Tracer.setSampler(() -> false);
 Tracer.getAndClearTrace();

 Tracer.fastStartSpan("outside");
 StreamingOutput streamingOutput = JaxRsTracers.wrap(os -> {
 Tracer.fastStartSpan("inside"); // never completed
 });
 streamingOutput.write(new ByteArrayOutputStream());
 assertThat(Tracer.hasTraceId()).isTrue();
 Tracer.fastCompleteSpan();
 assertThat(Tracer.hasTraceId()).isFalse();
 }

 @Test
 public void testWrappingStreamingOutput_traceStateIsCapturedAtConstructionTime_sampled() throws Exception {
 Tracer.setSampler(AlwaysSampler.INSTANCE);
 Tracer.getAndClearTrace();

 Tracer.fastStartSpan("before-construction");
 StreamingOutput streamingOutput = JaxRsTracers.wrap(os -> {
 assertThat(Tracer.completeSpan().get().getOperation()).isEqualTo("streaming-output");
 });
 Tracer.startSpan("after-construction");
 Tracer.fastStartSpan("after-construction");
 streamingOutput.write(new ByteArrayOutputStream());
 }

 @Test
 public void testWrappingStreamingOutput_traceStateIsCapturedAtConstructionTime_unsampled() throws Exception {
 Tracer.setSampler(() -> false);
 Tracer.getAndClearTrace();

 Tracer.fastStartSpan("before-construction");
 StreamingOutput streamingOutput = JaxRsTracers.wrap(os -> {
 assertThat(Tracer.hasTraceId()).isTrue();
 Tracer.fastCompleteSpan();
 assertThat(Tracer.hasTraceId()).isFalse();
 });
 Tracer.fastStartSpan("after-construction");
 streamingOutput.write(new ByteArrayOutputStream());
 }
}

6 changes: 3 additions & 3 deletions
tracing-jersey/src/main/java/com/palantir/tracing/jersey/TraceEnrichingFilter.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -68,14 +68,14 @@ public void filter(ContainerRequestContext requestContext) throws IOException {
 if (Strings.isNullOrEmpty(traceId)) {
 // HTTP request did not indicate a trace; initialize trace state and create a span.
 Tracer.initTrace(getObservabilityFromHeader(requestContext), Tracers.randomId());
 Tracer.startSpan(operation, SpanType.SERVER_INCOMING);
 Tracer.fastStartSpan(operation, SpanType.SERVER_INCOMING);
 } else {
 Tracer.initTrace(getObservabilityFromHeader(requestContext), traceId);
 if (spanId == null) {
 Tracer.startSpan(operation, SpanType.SERVER_INCOMING);
 Tracer.fastStartSpan(operation, SpanType.SERVER_INCOMING);
 } else {
 // caller's span is this span's parent.
 Tracer.startSpan(operation, spanId, SpanType.SERVER_INCOMING);
 Tracer.fastStartSpan(operation, spanId, SpanType.SERVER_INCOMING);
 }
 }

Expand Down

4 changes: 2 additions & 2 deletions
tracing-servlet/src/test/java/com/palantir/tracing/servlet/LeakedTraceFilterTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,7 +103,7 @@ public void doFilter(ServletRequest request, ServletResponse response, FilterCha
 throws IOException, ServletException {
 // Open a span to simulate a thread from another request
 // leaving bad data without the leaked trace filter applied.
 Tracer.startSpan("previous request leaked");
 Tracer.fastStartSpan("previous request leaked");
 chain.doFilter(request, response);
 }

Expand DownExpand Up@@ -140,7 +140,7 @@ public void destroy() {}
 env.servlets().addServlet("alwaysLeaks", new HttpServlet() {
 @Override
 protected void service(HttpServletRequest req, HttpServletResponse resp) {
 Tracer.startSpan("leaky");
 Tracer.fastStartSpan("leaky");
 resp.addHeader("Leaky-Invoked", "true");
 }
 }).addMapping("/leaky");
Expand Down

6 changes: 3 additions & 3 deletions
tracing-undertow/src/main/java/com/palantir/tracing/undertow/TracedOperationHandler.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,10 +103,10 @@ private void initializeTraceFromExisting(HeaderMap headers, String traceId) {
 Tracer.initTrace(getObservabilityFromHeader(headers), traceId);
 String spanId = headers.getFirst(SPAN_ID); // nullable
 if (spanId == null) {
 Tracer.startSpan(operation, SpanType.SERVER_INCOMING);
 Tracer.fastStartSpan(operation, SpanType.SERVER_INCOMING);
 } else {
 // caller's span is this span's parent.
 Tracer.startSpan(operation, spanId, SpanType.SERVER_INCOMING);
 Tracer.fastStartSpan(operation, spanId, SpanType.SERVER_INCOMING);
 }
 }

Expand All@@ -115,7 +115,7 @@ private String initializeNewTrace(HeaderMap headers) {
 // HTTP request did not indicate a trace; initialize trace state and create a span.
 String newTraceId = Tracers.randomId();
 Tracer.initTrace(getObservabilityFromHeader(headers), newTraceId);
 Tracer.startSpan(operation, SpanType.SERVER_INCOMING);
 Tracer.fastStartSpan(operation, SpanType.SERVER_INCOMING);
 return newTraceId;
 }

Expand Down

4 changes: 2 additions & 2 deletions
tracing/src/main/java/com/palantir/tracing/AsyncTracer.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,7 +62,7 @@ public AsyncTracer(String operation) {
 */
 public AsyncTracer(Optional<String> operation) {
 this.operation = operation.orElse(DEFAULT_OPERATION);
 Tracer.startSpan(this.operation + "-enqueue");
 Tracer.fastStartSpan(this.operation + "-enqueue");
 deferredTrace = Tracer.copyTrace().get();
 Tracer.fastDiscardSpan(); // span will completed in the deferred execution
 }
Expand All@@ -76,7 +76,7 @@ public <T, E extends Throwable> T withTrace(Tracers.ThrowingCallable<T, E> inner
 Tracer.setTrace(deferredTrace);
 // Finish the enqueue span
 Tracer.fastCompleteSpan();
 Tracer.startSpan(operation + "-run");
 Tracer.fastStartSpan(operation + "-run");
 try {
 return inner.call();
 } finally {
Expand Down

2 changes: 1 addition & 1 deletion
tracing/src/main/java/com/palantir/tracing/CloseableTracer.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,7 @@ public static CloseableTracer startSpan(String operation) {
 * labeled with the provided operation.
 */
 public static CloseableTracer startSpan(String operation, SpanType spanType) {
 Tracer.startSpan(operation, spanType);
 Tracer.fastStartSpan(operation, spanType);
 return INSTANCE;
 }

Expand Down

6 changes: 3 additions & 3 deletions
tracing/src/main/java/com/palantir/tracing/DeferredTracer.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -104,11 +104,11 @@ public <T, E extends Throwable> T withTrace(Tracers.ThrowingCallable<T, E> inner

 Optional<Trace> originalTrace = Tracer.copyTrace();

 Tracer.setTrace(new Trace(isObservable, traceId));
 Tracer.setTrace(Trace.of(isObservable, traceId));
 if (parentSpanId != null) {
 Tracer.startSpan(operation, parentSpanId, SpanType.LOCAL);
 Tracer.fastStartSpan(operation, parentSpanId, SpanType.LOCAL);
 } else {
 Tracer.startSpan(operation);
 Tracer.fastStartSpan(operation);
 }

 try {
Expand Down
Loading

, '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] Tracer spans are inexpensive for unsampled operations#180

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

bulldozer-bot
merged 12 commits into

from

Jun 24, 2019
 Merged


[improvement] Tracer spans are inexpensive for unsampled operations
#180
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


12 commits


Select commit
Hold shift + click to select a range
9ab758a

Split Tracer into Sampled+Unsampled types


carterkozak Jun 20, 2019
f08617b

error prone validation to prefer the fast path


carterkozak Jun 20, 2019
6063502

Refactor startSpan logic into Tracer to reduce duplication


carterkozak Jun 20, 2019
e1adc3c

Clean up TracingBenchmark a bit


carterkozak Jun 20, 2019
41896d4

Match default sample rate


carterkozak Jun 21, 2019
90e45fb

Annotate Trace internal methods with CheckReturnValue


carterkozak Jun 21, 2019
64e9214

s/depth/numberOfSpans


carterkozak Jun 21, 2019
752fb36

style


carterkozak Jun 21, 2019
1b57d51

class level design documentation


carterkozak Jun 21, 2019
80340a3

Trace.push is an internal concern


carterkozak Jun 23, 2019
9d06c36

rename validateDepth -> validateNumberOfSpans


carterkozak Jun 23, 2019
da00afb

popCurrentSpan takes a trace


carterkozak Jun 24, 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


1 change: 1 addition & 0 deletions
.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@ bin/
.idea/
out/
generated_src/
generated_testSrc/

# Codegen
.generated
Expand Down

20 changes: 10 additions & 10 deletions
tracing-benchmarks/src/jmh/java/com/palantir/tracing/TracingBenchmark.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,7 @@

package com.palantir.tracing;

import com.google.common.util.concurrent.Runnables;
import java.util.concurrent.TimeUnit;
import org.openjdk.jmh.annotations.Benchmark;
import org.openjdk.jmh.annotations.BenchmarkMode;
Expand DownExpand Up@@ -47,13 +48,13 @@
@SuppressWarnings({"checkstyle:hideutilityclassconstructor", "checkstyle:VisibilityModifier"})
public class TracingBenchmark {

 private static final Runnable nestedSpans = createnestedSpan(100);
 private static final Runnable nestedSpans = createNestedSpan(100);

 @SuppressWarnings("ImmutableEnumChecker")
 public enum BenchmarkObservability {
 SAMPLE(AlwaysSampler.INSTANCE),
 DO_NOT_SAMPLE(() -> false),
 UNDECIDED(new RandomSampler(0.1f));
 UNDECIDED(new RandomSampler(0.01f));

 private final TraceSampler traceSampler;

Expand DownExpand Up@@ -87,20 +88,19 @@ public static void nestedSpans() {
 nestedSpans.run();
 }

 private static Runnable createnestedSpan(int depth) {
 if (depth == 0) {
 return () -> {
 };
 private static Runnable createNestedSpan(int depth) {
 if (depth <= 0) {
 return Runnables.doNothing();
 } else {
 return wrapWithSpan(createnestedSpan(depth - 1));
 return wrapWithSpan("benchmark-span-" + depth, createNestedSpan(depth - 1));
 }
 }

 private static Runnable wrapWithSpan(Runnable toBenNested) {
 private static Runnable wrapWithSpan(String operation, Runnable next) {
 return () -> {
 Tracer.fastStartSpan(operation);
 try {
 Tracer.startSpan("span");
 toBenNested.run();
 next.run();
 } finally {
 Tracer.fastCompleteSpan();
 }
Expand Down

49 changes: 43 additions & 6 deletions
tracing-jaxrs/src/test/java/com/palantir/tracing/jaxrs/JaxRsTracersTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@

import static org.assertj.core.api.Assertions.assertThat;

import com.palantir.tracing.AlwaysSampler;
import com.palantir.tracing.Tracer;
import java.io.ByteArrayOutputStream;
import javax.ws.rs.core.StreamingOutput;
Expand All@@ -26,22 +27,58 @@
public final class JaxRsTracersTest {

 @Test
 public void testWrappingStreamingOutput_streamingOutputTraceIsIsolated() throws Exception {
 Tracer.startSpan("outside");
 public void testWrappingStreamingOutput_streamingOutputTraceIsIsolated_sampled() throws Exception {
 Tracer.setSampler(AlwaysSampler.INSTANCE);
 Tracer.getAndClearTrace();

 Tracer.fastStartSpan("outside");
 StreamingOutput streamingOutput = JaxRsTracers.wrap(os -> {
 Tracer.startSpan("inside"); // never completed
 Tracer.fastStartSpan("inside"); // never completed
 });
 streamingOutput.write(new ByteArrayOutputStream());
 assertThat(Tracer.completeSpan().get().getOperation()).isEqualTo("outside");
 }

 @Test
 public void testWrappingStreamingOutput_traceStateIsCapturedAtConstructionTime() throws Exception {
 Tracer.startSpan("before-construction");
 public void testWrappingStreamingOutput_streamingOutputTraceIsIsolated_unsampled() throws Exception {
 Tracer.setSampler(() -> false);
 Tracer.getAndClearTrace();

 Tracer.fastStartSpan("outside");
 StreamingOutput streamingOutput = JaxRsTracers.wrap(os -> {
 Tracer.fastStartSpan("inside"); // never completed
 });
 streamingOutput.write(new ByteArrayOutputStream());
 assertThat(Tracer.hasTraceId()).isTrue();
 Tracer.fastCompleteSpan();
 assertThat(Tracer.hasTraceId()).isFalse();
 }

 @Test
 public void testWrappingStreamingOutput_traceStateIsCapturedAtConstructionTime_sampled() throws Exception {
 Tracer.setSampler(AlwaysSampler.INSTANCE);
 Tracer.getAndClearTrace();

 Tracer.fastStartSpan("before-construction");
 StreamingOutput streamingOutput = JaxRsTracers.wrap(os -> {
 assertThat(Tracer.completeSpan().get().getOperation()).isEqualTo("streaming-output");
 });
 Tracer.startSpan("after-construction");
 Tracer.fastStartSpan("after-construction");
 streamingOutput.write(new ByteArrayOutputStream());
 }

 @Test
 public void testWrappingStreamingOutput_traceStateIsCapturedAtConstructionTime_unsampled() throws Exception {
 Tracer.setSampler(() -> false);
 Tracer.getAndClearTrace();

 Tracer.fastStartSpan("before-construction");
 StreamingOutput streamingOutput = JaxRsTracers.wrap(os -> {
 assertThat(Tracer.hasTraceId()).isTrue();
 Tracer.fastCompleteSpan();
 assertThat(Tracer.hasTraceId()).isFalse();
 });
 Tracer.fastStartSpan("after-construction");
 streamingOutput.write(new ByteArrayOutputStream());
 }
}

6 changes: 3 additions & 3 deletions
tracing-jersey/src/main/java/com/palantir/tracing/jersey/TraceEnrichingFilter.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -68,14 +68,14 @@ public void filter(ContainerRequestContext requestContext) throws IOException {
 if (Strings.isNullOrEmpty(traceId)) {
 // HTTP request did not indicate a trace; initialize trace state and create a span.
 Tracer.initTrace(getObservabilityFromHeader(requestContext), Tracers.randomId());
 Tracer.startSpan(operation, SpanType.SERVER_INCOMING);
 Tracer.fastStartSpan(operation, SpanType.SERVER_INCOMING);
 } else {
 Tracer.initTrace(getObservabilityFromHeader(requestContext), traceId);
 if (spanId == null) {
 Tracer.startSpan(operation, SpanType.SERVER_INCOMING);
 Tracer.fastStartSpan(operation, SpanType.SERVER_INCOMING);
 } else {
 // caller's span is this span's parent.
 Tracer.startSpan(operation, spanId, SpanType.SERVER_INCOMING);
 Tracer.fastStartSpan(operation, spanId, SpanType.SERVER_INCOMING);
 }
 }

Expand Down

4 changes: 2 additions & 2 deletions
tracing-servlet/src/test/java/com/palantir/tracing/servlet/LeakedTraceFilterTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,7 +103,7 @@ public void doFilter(ServletRequest request, ServletResponse response, FilterCha
 throws IOException, ServletException {
 // Open a span to simulate a thread from another request
 // leaving bad data without the leaked trace filter applied.
 Tracer.startSpan("previous request leaked");
 Tracer.fastStartSpan("previous request leaked");
 chain.doFilter(request, response);
 }

Expand DownExpand Up@@ -140,7 +140,7 @@ public void destroy() {}
 env.servlets().addServlet("alwaysLeaks", new HttpServlet() {
 @Override
 protected void service(HttpServletRequest req, HttpServletResponse resp) {
 Tracer.startSpan("leaky");
 Tracer.fastStartSpan("leaky");
 resp.addHeader("Leaky-Invoked", "true");
 }
 }).addMapping("/leaky");
Expand Down

6 changes: 3 additions & 3 deletions
tracing-undertow/src/main/java/com/palantir/tracing/undertow/TracedOperationHandler.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,10 +103,10 @@ private void initializeTraceFromExisting(HeaderMap headers, String traceId) {
 Tracer.initTrace(getObservabilityFromHeader(headers), traceId);
 String spanId = headers.getFirst(SPAN_ID); // nullable
 if (spanId == null) {
 Tracer.startSpan(operation, SpanType.SERVER_INCOMING);
 Tracer.fastStartSpan(operation, SpanType.SERVER_INCOMING);
 } else {
 // caller's span is this span's parent.
 Tracer.startSpan(operation, spanId, SpanType.SERVER_INCOMING);
 Tracer.fastStartSpan(operation, spanId, SpanType.SERVER_INCOMING);
 }
 }

Expand All@@ -115,7 +115,7 @@ private String initializeNewTrace(HeaderMap headers) {
 // HTTP request did not indicate a trace; initialize trace state and create a span.
 String newTraceId = Tracers.randomId();
 Tracer.initTrace(getObservabilityFromHeader(headers), newTraceId);
 Tracer.startSpan(operation, SpanType.SERVER_INCOMING);
 Tracer.fastStartSpan(operation, SpanType.SERVER_INCOMING);
 return newTraceId;
 }

Expand Down

4 changes: 2 additions & 2 deletions
tracing/src/main/java/com/palantir/tracing/AsyncTracer.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,7 +62,7 @@ public AsyncTracer(String operation) {
 */
 public AsyncTracer(Optional<String> operation) {
 this.operation = operation.orElse(DEFAULT_OPERATION);
 Tracer.startSpan(this.operation + "-enqueue");
 Tracer.fastStartSpan(this.operation + "-enqueue");
 deferredTrace = Tracer.copyTrace().get();
 Tracer.fastDiscardSpan(); // span will completed in the deferred execution
 }
Expand All@@ -76,7 +76,7 @@ public <T, E extends Throwable> T withTrace(Tracers.ThrowingCallable<T, E> inner
 Tracer.setTrace(deferredTrace);
 // Finish the enqueue span
 Tracer.fastCompleteSpan();
 Tracer.startSpan(operation + "-run");
 Tracer.fastStartSpan(operation + "-run");
 try {
 return inner.call();
 } finally {
Expand Down

2 changes: 1 addition & 1 deletion
tracing/src/main/java/com/palantir/tracing/CloseableTracer.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,7 @@ public static CloseableTracer startSpan(String operation) {
 * labeled with the provided operation.
 */
 public static CloseableTracer startSpan(String operation, SpanType spanType) {
 Tracer.startSpan(operation, spanType);
 Tracer.fastStartSpan(operation, spanType);
 return INSTANCE;
 }

Expand Down

6 changes: 3 additions & 3 deletions
tracing/src/main/java/com/palantir/tracing/DeferredTracer.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -104,11 +104,11 @@ public <T, E extends Throwable> T withTrace(Tracers.ThrowingCallable<T, E> inner

 Optional<Trace> originalTrace = Tracer.copyTrace();

 Tracer.setTrace(new Trace(isObservable, traceId));
 Tracer.setTrace(Trace.of(isObservable, traceId));
 if (parentSpanId != null) {
 Tracer.startSpan(operation, parentSpanId, SpanType.LOCAL);
 Tracer.fastStartSpan(operation, parentSpanId, SpanType.LOCAL);
 } else {
 Tracer.startSpan(operation);
 Tracer.fastStartSpan(operation);
 }

 try {
Expand Down
Loading

, '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] Tracer spans are inexpensive for unsampled operations#180

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

bulldozer-bot
merged 12 commits into

from

Jun 24, 2019
 Merged


[improvement] Tracer spans are inexpensive for unsampled operations
#180
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


12 commits


Select commit
Hold shift + click to select a range
9ab758a

Split Tracer into Sampled+Unsampled types


carterkozak Jun 20, 2019
f08617b

error prone validation to prefer the fast path


carterkozak Jun 20, 2019
6063502

Refactor startSpan logic into Tracer to reduce duplication


carterkozak Jun 20, 2019
e1adc3c

Clean up TracingBenchmark a bit


carterkozak Jun 20, 2019
41896d4

Match default sample rate


carterkozak Jun 21, 2019
90e45fb

Annotate Trace internal methods with CheckReturnValue


carterkozak Jun 21, 2019
64e9214

s/depth/numberOfSpans


carterkozak Jun 21, 2019
752fb36

style


carterkozak Jun 21, 2019
1b57d51

class level design documentation


carterkozak Jun 21, 2019
80340a3

Trace.push is an internal concern


carterkozak Jun 23, 2019
9d06c36

rename validateDepth -> validateNumberOfSpans


carterkozak Jun 23, 2019
da00afb

popCurrentSpan takes a trace


carterkozak Jun 24, 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


1 change: 1 addition & 0 deletions
.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@ bin/
.idea/
out/
generated_src/
generated_testSrc/

# Codegen
.generated
Expand Down

20 changes: 10 additions & 10 deletions
tracing-benchmarks/src/jmh/java/com/palantir/tracing/TracingBenchmark.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,7 @@

package com.palantir.tracing;

import com.google.common.util.concurrent.Runnables;
import java.util.concurrent.TimeUnit;
import org.openjdk.jmh.annotations.Benchmark;
import org.openjdk.jmh.annotations.BenchmarkMode;
Expand DownExpand Up@@ -47,13 +48,13 @@
@SuppressWarnings({"checkstyle:hideutilityclassconstructor", "checkstyle:VisibilityModifier"})
public class TracingBenchmark {

 private static final Runnable nestedSpans = createnestedSpan(100);
 private static final Runnable nestedSpans = createNestedSpan(100);

 @SuppressWarnings("ImmutableEnumChecker")
 public enum BenchmarkObservability {
 SAMPLE(AlwaysSampler.INSTANCE),
 DO_NOT_SAMPLE(() -> false),
 UNDECIDED(new RandomSampler(0.1f));
 UNDECIDED(new RandomSampler(0.01f));

 private final TraceSampler traceSampler;

Expand DownExpand Up@@ -87,20 +88,19 @@ public static void nestedSpans() {
 nestedSpans.run();
 }

 private static Runnable createnestedSpan(int depth) {
 if (depth == 0) {
 return () -> {
 };
 private static Runnable createNestedSpan(int depth) {
 if (depth <= 0) {
 return Runnables.doNothing();
 } else {
 return wrapWithSpan(createnestedSpan(depth - 1));
 return wrapWithSpan("benchmark-span-" + depth, createNestedSpan(depth - 1));
 }
 }

 private static Runnable wrapWithSpan(Runnable toBenNested) {
 private static Runnable wrapWithSpan(String operation, Runnable next) {
 return () -> {
 Tracer.fastStartSpan(operation);
 try {
 Tracer.startSpan("span");
 toBenNested.run();
 next.run();
 } finally {
 Tracer.fastCompleteSpan();
 }
Expand Down

49 changes: 43 additions & 6 deletions
tracing-jaxrs/src/test/java/com/palantir/tracing/jaxrs/JaxRsTracersTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@

import static org.assertj.core.api.Assertions.assertThat;

import com.palantir.tracing.AlwaysSampler;
import com.palantir.tracing.Tracer;
import java.io.ByteArrayOutputStream;
import javax.ws.rs.core.StreamingOutput;
Expand All@@ -26,22 +27,58 @@
public final class JaxRsTracersTest {

 @Test
 public void testWrappingStreamingOutput_streamingOutputTraceIsIsolated() throws Exception {
 Tracer.startSpan("outside");
 public void testWrappingStreamingOutput_streamingOutputTraceIsIsolated_sampled() throws Exception {
 Tracer.setSampler(AlwaysSampler.INSTANCE);
 Tracer.getAndClearTrace();

 Tracer.fastStartSpan("outside");
 StreamingOutput streamingOutput = JaxRsTracers.wrap(os -> {
 Tracer.startSpan("inside"); // never completed
 Tracer.fastStartSpan("inside"); // never completed
 });
 streamingOutput.write(new ByteArrayOutputStream());
 assertThat(Tracer.completeSpan().get().getOperation()).isEqualTo("outside");
 }

 @Test
 public void testWrappingStreamingOutput_traceStateIsCapturedAtConstructionTime() throws Exception {
 Tracer.startSpan("before-construction");
 public void testWrappingStreamingOutput_streamingOutputTraceIsIsolated_unsampled() throws Exception {
 Tracer.setSampler(() -> false);
 Tracer.getAndClearTrace();

 Tracer.fastStartSpan("outside");
 StreamingOutput streamingOutput = JaxRsTracers.wrap(os -> {
 Tracer.fastStartSpan("inside"); // never completed
 });
 streamingOutput.write(new ByteArrayOutputStream());
 assertThat(Tracer.hasTraceId()).isTrue();
 Tracer.fastCompleteSpan();
 assertThat(Tracer.hasTraceId()).isFalse();
 }

 @Test
 public void testWrappingStreamingOutput_traceStateIsCapturedAtConstructionTime_sampled() throws Exception {
 Tracer.setSampler(AlwaysSampler.INSTANCE);
 Tracer.getAndClearTrace();

 Tracer.fastStartSpan("before-construction");
 StreamingOutput streamingOutput = JaxRsTracers.wrap(os -> {
 assertThat(Tracer.completeSpan().get().getOperation()).isEqualTo("streaming-output");
 });
 Tracer.startSpan("after-construction");
 Tracer.fastStartSpan("after-construction");
 streamingOutput.write(new ByteArrayOutputStream());
 }

 @Test
 public void testWrappingStreamingOutput_traceStateIsCapturedAtConstructionTime_unsampled() throws Exception {
 Tracer.setSampler(() -> false);
 Tracer.getAndClearTrace();

 Tracer.fastStartSpan("before-construction");
 StreamingOutput streamingOutput = JaxRsTracers.wrap(os -> {
 assertThat(Tracer.hasTraceId()).isTrue();
 Tracer.fastCompleteSpan();
 assertThat(Tracer.hasTraceId()).isFalse();
 });
 Tracer.fastStartSpan("after-construction");
 streamingOutput.write(new ByteArrayOutputStream());
 }
}

6 changes: 3 additions & 3 deletions
tracing-jersey/src/main/java/com/palantir/tracing/jersey/TraceEnrichingFilter.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -68,14 +68,14 @@ public void filter(ContainerRequestContext requestContext) throws IOException {
 if (Strings.isNullOrEmpty(traceId)) {
 // HTTP request did not indicate a trace; initialize trace state and create a span.
 Tracer.initTrace(getObservabilityFromHeader(requestContext), Tracers.randomId());
 Tracer.startSpan(operation, SpanType.SERVER_INCOMING);
 Tracer.fastStartSpan(operation, SpanType.SERVER_INCOMING);
 } else {
 Tracer.initTrace(getObservabilityFromHeader(requestContext), traceId);
 if (spanId == null) {
 Tracer.startSpan(operation, SpanType.SERVER_INCOMING);
 Tracer.fastStartSpan(operation, SpanType.SERVER_INCOMING);
 } else {
 // caller's span is this span's parent.
 Tracer.startSpan(operation, spanId, SpanType.SERVER_INCOMING);
 Tracer.fastStartSpan(operation, spanId, SpanType.SERVER_INCOMING);
 }
 }

Expand Down

4 changes: 2 additions & 2 deletions
tracing-servlet/src/test/java/com/palantir/tracing/servlet/LeakedTraceFilterTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,7 +103,7 @@ public void doFilter(ServletRequest request, ServletResponse response, FilterCha
 throws IOException, ServletException {
 // Open a span to simulate a thread from another request
 // leaving bad data without the leaked trace filter applied.
 Tracer.startSpan("previous request leaked");
 Tracer.fastStartSpan("previous request leaked");
 chain.doFilter(request, response);
 }

Expand DownExpand Up@@ -140,7 +140,7 @@ public void destroy() {}
 env.servlets().addServlet("alwaysLeaks", new HttpServlet() {
 @Override
 protected void service(HttpServletRequest req, HttpServletResponse resp) {
 Tracer.startSpan("leaky");
 Tracer.fastStartSpan("leaky");
 resp.addHeader("Leaky-Invoked", "true");
 }
 }).addMapping("/leaky");
Expand Down

6 changes: 3 additions & 3 deletions
tracing-undertow/src/main/java/com/palantir/tracing/undertow/TracedOperationHandler.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,10 +103,10 @@ private void initializeTraceFromExisting(HeaderMap headers, String traceId) {
 Tracer.initTrace(getObservabilityFromHeader(headers), traceId);
 String spanId = headers.getFirst(SPAN_ID); // nullable
 if (spanId == null) {
 Tracer.startSpan(operation, SpanType.SERVER_INCOMING);
 Tracer.fastStartSpan(operation, SpanType.SERVER_INCOMING);
 } else {
 // caller's span is this span's parent.
 Tracer.startSpan(operation, spanId, SpanType.SERVER_INCOMING);
 Tracer.fastStartSpan(operation, spanId, SpanType.SERVER_INCOMING);
 }
 }

Expand All@@ -115,7 +115,7 @@ private String initializeNewTrace(HeaderMap headers) {
 // HTTP request did not indicate a trace; initialize trace state and create a span.
 String newTraceId = Tracers.randomId();
 Tracer.initTrace(getObservabilityFromHeader(headers), newTraceId);
 Tracer.startSpan(operation, SpanType.SERVER_INCOMING);
 Tracer.fastStartSpan(operation, SpanType.SERVER_INCOMING);
 return newTraceId;
 }

Expand Down

4 changes: 2 additions & 2 deletions
tracing/src/main/java/com/palantir/tracing/AsyncTracer.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,7 +62,7 @@ public AsyncTracer(String operation) {
 */
 public AsyncTracer(Optional<String> operation) {
 this.operation = operation.orElse(DEFAULT_OPERATION);
 Tracer.startSpan(this.operation + "-enqueue");
 Tracer.fastStartSpan(this.operation + "-enqueue");
 deferredTrace = Tracer.copyTrace().get();
 Tracer.fastDiscardSpan(); // span will completed in the deferred execution
 }
Expand All@@ -76,7 +76,7 @@ public <T, E extends Throwable> T withTrace(Tracers.ThrowingCallable<T, E> inner
 Tracer.setTrace(deferredTrace);
 // Finish the enqueue span
 Tracer.fastCompleteSpan();
 Tracer.startSpan(operation + "-run");
 Tracer.fastStartSpan(operation + "-run");
 try {
 return inner.call();
 } finally {
Expand Down

2 changes: 1 addition & 1 deletion
tracing/src/main/java/com/palantir/tracing/CloseableTracer.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,7 @@ public static CloseableTracer startSpan(String operation) {
 * labeled with the provided operation.
 */
 public static CloseableTracer startSpan(String operation, SpanType spanType) {
 Tracer.startSpan(operation, spanType);
 Tracer.fastStartSpan(operation, spanType);
 return INSTANCE;
 }

Expand Down

6 changes: 3 additions & 3 deletions
tracing/src/main/java/com/palantir/tracing/DeferredTracer.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -104,11 +104,11 @@ public <T, E extends Throwable> T withTrace(Tracers.ThrowingCallable<T, E> inner

 Optional<Trace> originalTrace = Tracer.copyTrace();

 Tracer.setTrace(new Trace(isObservable, traceId));
 Tracer.setTrace(Trace.of(isObservable, traceId));
 if (parentSpanId != null) {
 Tracer.startSpan(operation, parentSpanId, SpanType.LOCAL);
 Tracer.fastStartSpan(operation, parentSpanId, SpanType.LOCAL);
 } else {
 Tracer.startSpan(operation);
 Tracer.fastStartSpan(operation);
 }

 try {
Expand Down
Loading

, '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] Tracer spans are inexpensive for unsampled operations#180

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

bulldozer-bot
merged 12 commits into

from

Jun 24, 2019
 Merged


[improvement] Tracer spans are inexpensive for unsampled operations
#180
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


12 commits


Select commit
Hold shift + click to select a range
9ab758a

Split Tracer into Sampled+Unsampled types


carterkozak Jun 20, 2019
f08617b

error prone validation to prefer the fast path


carterkozak Jun 20, 2019
6063502

Refactor startSpan logic into Tracer to reduce duplication


carterkozak Jun 20, 2019
e1adc3c

Clean up TracingBenchmark a bit


carterkozak Jun 20, 2019
41896d4

Match default sample rate


carterkozak Jun 21, 2019
90e45fb

Annotate Trace internal methods with CheckReturnValue


carterkozak Jun 21, 2019
64e9214

s/depth/numberOfSpans


carterkozak Jun 21, 2019
752fb36

style


carterkozak Jun 21, 2019
1b57d51

class level design documentation


carterkozak Jun 21, 2019
80340a3

Trace.push is an internal concern


carterkozak Jun 23, 2019
9d06c36

rename validateDepth -> validateNumberOfSpans


carterkozak Jun 23, 2019
da00afb

popCurrentSpan takes a trace


carterkozak Jun 24, 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


1 change: 1 addition & 0 deletions
.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@ bin/
.idea/
out/
generated_src/
generated_testSrc/

# Codegen
.generated
Expand Down

20 changes: 10 additions & 10 deletions
tracing-benchmarks/src/jmh/java/com/palantir/tracing/TracingBenchmark.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,7 @@

package com.palantir.tracing;

import com.google.common.util.concurrent.Runnables;
import java.util.concurrent.TimeUnit;
import org.openjdk.jmh.annotations.Benchmark;
import org.openjdk.jmh.annotations.BenchmarkMode;
Expand DownExpand Up@@ -47,13 +48,13 @@
@SuppressWarnings({"checkstyle:hideutilityclassconstructor", "checkstyle:VisibilityModifier"})
public class TracingBenchmark {

 private static final Runnable nestedSpans = createnestedSpan(100);
 private static final Runnable nestedSpans = createNestedSpan(100);

 @SuppressWarnings("ImmutableEnumChecker")
 public enum BenchmarkObservability {
 SAMPLE(AlwaysSampler.INSTANCE),
 DO_NOT_SAMPLE(() -> false),
 UNDECIDED(new RandomSampler(0.1f));
 UNDECIDED(new RandomSampler(0.01f));

 private final TraceSampler traceSampler;

Expand DownExpand Up@@ -87,20 +88,19 @@ public static void nestedSpans() {
 nestedSpans.run();
 }

 private static Runnable createnestedSpan(int depth) {
 if (depth == 0) {
 return () -> {
 };
 private static Runnable createNestedSpan(int depth) {
 if (depth <= 0) {
 return Runnables.doNothing();
 } else {
 return wrapWithSpan(createnestedSpan(depth - 1));
 return wrapWithSpan("benchmark-span-" + depth, createNestedSpan(depth - 1));
 }
 }

 private static Runnable wrapWithSpan(Runnable toBenNested) {
 private static Runnable wrapWithSpan(String operation, Runnable next) {
 return () -> {
 Tracer.fastStartSpan(operation);
 try {
 Tracer.startSpan("span");
 toBenNested.run();
 next.run();
 } finally {
 Tracer.fastCompleteSpan();
 }
Expand Down

49 changes: 43 additions & 6 deletions
tracing-jaxrs/src/test/java/com/palantir/tracing/jaxrs/JaxRsTracersTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@

import static org.assertj.core.api.Assertions.assertThat;

import com.palantir.tracing.AlwaysSampler;
import com.palantir.tracing.Tracer;
import java.io.ByteArrayOutputStream;
import javax.ws.rs.core.StreamingOutput;
Expand All@@ -26,22 +27,58 @@
public final class JaxRsTracersTest {

 @Test
 public void testWrappingStreamingOutput_streamingOutputTraceIsIsolated() throws Exception {
 Tracer.startSpan("outside");
 public void testWrappingStreamingOutput_streamingOutputTraceIsIsolated_sampled() throws Exception {
 Tracer.setSampler(AlwaysSampler.INSTANCE);
 Tracer.getAndClearTrace();

 Tracer.fastStartSpan("outside");
 StreamingOutput streamingOutput = JaxRsTracers.wrap(os -> {
 Tracer.startSpan("inside"); // never completed
 Tracer.fastStartSpan("inside"); // never completed
 });
 streamingOutput.write(new ByteArrayOutputStream());
 assertThat(Tracer.completeSpan().get().getOperation()).isEqualTo("outside");
 }

 @Test
 public void testWrappingStreamingOutput_traceStateIsCapturedAtConstructionTime() throws Exception {
 Tracer.startSpan("before-construction");
 public void testWrappingStreamingOutput_streamingOutputTraceIsIsolated_unsampled() throws Exception {
 Tracer.setSampler(() -> false);
 Tracer.getAndClearTrace();

 Tracer.fastStartSpan("outside");
 StreamingOutput streamingOutput = JaxRsTracers.wrap(os -> {
 Tracer.fastStartSpan("inside"); // never completed
 });
 streamingOutput.write(new ByteArrayOutputStream());
 assertThat(Tracer.hasTraceId()).isTrue();
 Tracer.fastCompleteSpan();
 assertThat(Tracer.hasTraceId()).isFalse();
 }

 @Test
 public void testWrappingStreamingOutput_traceStateIsCapturedAtConstructionTime_sampled() throws Exception {
 Tracer.setSampler(AlwaysSampler.INSTANCE);
 Tracer.getAndClearTrace();

 Tracer.fastStartSpan("before-construction");
 StreamingOutput streamingOutput = JaxRsTracers.wrap(os -> {
 assertThat(Tracer.completeSpan().get().getOperation()).isEqualTo("streaming-output");
 });
 Tracer.startSpan("after-construction");
 Tracer.fastStartSpan("after-construction");
 streamingOutput.write(new ByteArrayOutputStream());
 }

 @Test
 public void testWrappingStreamingOutput_traceStateIsCapturedAtConstructionTime_unsampled() throws Exception {
 Tracer.setSampler(() -> false);
 Tracer.getAndClearTrace();

 Tracer.fastStartSpan("before-construction");
 StreamingOutput streamingOutput = JaxRsTracers.wrap(os -> {
 assertThat(Tracer.hasTraceId()).isTrue();
 Tracer.fastCompleteSpan();
 assertThat(Tracer.hasTraceId()).isFalse();
 });
 Tracer.fastStartSpan("after-construction");
 streamingOutput.write(new ByteArrayOutputStream());
 }
}

6 changes: 3 additions & 3 deletions
tracing-jersey/src/main/java/com/palantir/tracing/jersey/TraceEnrichingFilter.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -68,14 +68,14 @@ public void filter(ContainerRequestContext requestContext) throws IOException {
 if (Strings.isNullOrEmpty(traceId)) {
 // HTTP request did not indicate a trace; initialize trace state and create a span.
 Tracer.initTrace(getObservabilityFromHeader(requestContext), Tracers.randomId());
 Tracer.startSpan(operation, SpanType.SERVER_INCOMING);
 Tracer.fastStartSpan(operation, SpanType.SERVER_INCOMING);
 } else {
 Tracer.initTrace(getObservabilityFromHeader(requestContext), traceId);
 if (spanId == null) {
 Tracer.startSpan(operation, SpanType.SERVER_INCOMING);
 Tracer.fastStartSpan(operation, SpanType.SERVER_INCOMING);
 } else {
 // caller's span is this span's parent.
 Tracer.startSpan(operation, spanId, SpanType.SERVER_INCOMING);
 Tracer.fastStartSpan(operation, spanId, SpanType.SERVER_INCOMING);
 }
 }

Expand Down

4 changes: 2 additions & 2 deletions
tracing-servlet/src/test/java/com/palantir/tracing/servlet/LeakedTraceFilterTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,7 +103,7 @@ public void doFilter(ServletRequest request, ServletResponse response, FilterCha
 throws IOException, ServletException {
 // Open a span to simulate a thread from another request
 // leaving bad data without the leaked trace filter applied.
 Tracer.startSpan("previous request leaked");
 Tracer.fastStartSpan("previous request leaked");
 chain.doFilter(request, response);
 }

Expand DownExpand Up@@ -140,7 +140,7 @@ public void destroy() {}
 env.servlets().addServlet("alwaysLeaks", new HttpServlet() {
 @Override
 protected void service(HttpServletRequest req, HttpServletResponse resp) {
 Tracer.startSpan("leaky");
 Tracer.fastStartSpan("leaky");
 resp.addHeader("Leaky-Invoked", "true");
 }
 }).addMapping("/leaky");
Expand Down

6 changes: 3 additions & 3 deletions
tracing-undertow/src/main/java/com/palantir/tracing/undertow/TracedOperationHandler.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,10 +103,10 @@ private void initializeTraceFromExisting(HeaderMap headers, String traceId) {
 Tracer.initTrace(getObservabilityFromHeader(headers), traceId);
 String spanId = headers.getFirst(SPAN_ID); // nullable
 if (spanId == null) {
 Tracer.startSpan(operation, SpanType.SERVER_INCOMING);
 Tracer.fastStartSpan(operation, SpanType.SERVER_INCOMING);
 } else {
 // caller's span is this span's parent.
 Tracer.startSpan(operation, spanId, SpanType.SERVER_INCOMING);
 Tracer.fastStartSpan(operation, spanId, SpanType.SERVER_INCOMING);
 }
 }

Expand All@@ -115,7 +115,7 @@ private String initializeNewTrace(HeaderMap headers) {
 // HTTP request did not indicate a trace; initialize trace state and create a span.
 String newTraceId = Tracers.randomId();
 Tracer.initTrace(getObservabilityFromHeader(headers), newTraceId);
 Tracer.startSpan(operation, SpanType.SERVER_INCOMING);
 Tracer.fastStartSpan(operation, SpanType.SERVER_INCOMING);
 return newTraceId;
 }

Expand Down

4 changes: 2 additions & 2 deletions
tracing/src/main/java/com/palantir/tracing/AsyncTracer.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,7 +62,7 @@ public AsyncTracer(String operation) {
 */
 public AsyncTracer(Optional<String> operation) {
 this.operation = operation.orElse(DEFAULT_OPERATION);
 Tracer.startSpan(this.operation + "-enqueue");
 Tracer.fastStartSpan(this.operation + "-enqueue");
 deferredTrace = Tracer.copyTrace().get();
 Tracer.fastDiscardSpan(); // span will completed in the deferred execution
 }
Expand All@@ -76,7 +76,7 @@ public <T, E extends Throwable> T withTrace(Tracers.ThrowingCallable<T, E> inner
 Tracer.setTrace(deferredTrace);
 // Finish the enqueue span
 Tracer.fastCompleteSpan();
 Tracer.startSpan(operation + "-run");
 Tracer.fastStartSpan(operation + "-run");
 try {
 return inner.call();
 } finally {
Expand Down

2 changes: 1 addition & 1 deletion
tracing/src/main/java/com/palantir/tracing/CloseableTracer.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,7 @@ public static CloseableTracer startSpan(String operation) {
 * labeled with the provided operation.
 */
 public static CloseableTracer startSpan(String operation, SpanType spanType) {
 Tracer.startSpan(operation, spanType);
 Tracer.fastStartSpan(operation, spanType);
 return INSTANCE;
 }

Expand Down

6 changes: 3 additions & 3 deletions
tracing/src/main/java/com/palantir/tracing/DeferredTracer.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -104,11 +104,11 @@ public <T, E extends Throwable> T withTrace(Tracers.ThrowingCallable<T, E> inner

 Optional<Trace> originalTrace = Tracer.copyTrace();

 Tracer.setTrace(new Trace(isObservable, traceId));
 Tracer.setTrace(Trace.of(isObservable, traceId));
 if (parentSpanId != null) {
 Tracer.startSpan(operation, parentSpanId, SpanType.LOCAL);
 Tracer.fastStartSpan(operation, parentSpanId, SpanType.LOCAL);
 } else {
 Tracer.startSpan(operation);
 Tracer.fastStartSpan(operation);
 }

 try {
Expand Down
Loading

, '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] Tracer spans are inexpensive for unsampled operations#180

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

bulldozer-bot
merged 12 commits into

from

Jun 24, 2019
 Merged


[improvement] Tracer spans are inexpensive for unsampled operations
#180
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


12 commits


Select commit
Hold shift + click to select a range
9ab758a

Split Tracer into Sampled+Unsampled types


carterkozak Jun 20, 2019
f08617b

error prone validation to prefer the fast path


carterkozak Jun 20, 2019
6063502

Refactor startSpan logic into Tracer to reduce duplication


carterkozak Jun 20, 2019
e1adc3c

Clean up TracingBenchmark a bit


carterkozak Jun 20, 2019
41896d4

Match default sample rate


carterkozak Jun 21, 2019
90e45fb

Annotate Trace internal methods with CheckReturnValue


carterkozak Jun 21, 2019
64e9214

s/depth/numberOfSpans


carterkozak Jun 21, 2019
752fb36

style


carterkozak Jun 21, 2019
1b57d51

class level design documentation


carterkozak Jun 21, 2019
80340a3

Trace.push is an internal concern


carterkozak Jun 23, 2019
9d06c36

rename validateDepth -> validateNumberOfSpans


carterkozak Jun 23, 2019
da00afb

popCurrentSpan takes a trace


carterkozak Jun 24, 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


1 change: 1 addition & 0 deletions
.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@ bin/
.idea/
out/
generated_src/
generated_testSrc/

# Codegen
.generated
Expand Down

20 changes: 10 additions & 10 deletions
tracing-benchmarks/src/jmh/java/com/palantir/tracing/TracingBenchmark.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,7 @@

package com.palantir.tracing;

import com.google.common.util.concurrent.Runnables;
import java.util.concurrent.TimeUnit;
import org.openjdk.jmh.annotations.Benchmark;
import org.openjdk.jmh.annotations.BenchmarkMode;
Expand DownExpand Up@@ -47,13 +48,13 @@
@SuppressWarnings({"checkstyle:hideutilityclassconstructor", "checkstyle:VisibilityModifier"})
public class TracingBenchmark {

 private static final Runnable nestedSpans = createnestedSpan(100);
 private static final Runnable nestedSpans = createNestedSpan(100);

 @SuppressWarnings("ImmutableEnumChecker")
 public enum BenchmarkObservability {
 SAMPLE(AlwaysSampler.INSTANCE),
 DO_NOT_SAMPLE(() -> false),
 UNDECIDED(new RandomSampler(0.1f));
 UNDECIDED(new RandomSampler(0.01f));

 private final TraceSampler traceSampler;

Expand DownExpand Up@@ -87,20 +88,19 @@ public static void nestedSpans() {
 nestedSpans.run();
 }

 private static Runnable createnestedSpan(int depth) {
 if (depth == 0) {
 return () -> {
 };
 private static Runnable createNestedSpan(int depth) {
 if (depth <= 0) {
 return Runnables.doNothing();
 } else {
 return wrapWithSpan(createnestedSpan(depth - 1));
 return wrapWithSpan("benchmark-span-" + depth, createNestedSpan(depth - 1));
 }
 }

 private static Runnable wrapWithSpan(Runnable toBenNested) {
 private static Runnable wrapWithSpan(String operation, Runnable next) {
 return () -> {
 Tracer.fastStartSpan(operation);
 try {
 Tracer.startSpan("span");
 toBenNested.run();
 next.run();
 } finally {
 Tracer.fastCompleteSpan();
 }
Expand Down

49 changes: 43 additions & 6 deletions
tracing-jaxrs/src/test/java/com/palantir/tracing/jaxrs/JaxRsTracersTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@

import static org.assertj.core.api.Assertions.assertThat;

import com.palantir.tracing.AlwaysSampler;
import com.palantir.tracing.Tracer;
import java.io.ByteArrayOutputStream;
import javax.ws.rs.core.StreamingOutput;
Expand All@@ -26,22 +27,58 @@
public final class JaxRsTracersTest {

 @Test
 public void testWrappingStreamingOutput_streamingOutputTraceIsIsolated() throws Exception {
 Tracer.startSpan("outside");
 public void testWrappingStreamingOutput_streamingOutputTraceIsIsolated_sampled() throws Exception {
 Tracer.setSampler(AlwaysSampler.INSTANCE);
 Tracer.getAndClearTrace();

 Tracer.fastStartSpan("outside");
 StreamingOutput streamingOutput = JaxRsTracers.wrap(os -> {
 Tracer.startSpan("inside"); // never completed
 Tracer.fastStartSpan("inside"); // never completed
 });
 streamingOutput.write(new ByteArrayOutputStream());
 assertThat(Tracer.completeSpan().get().getOperation()).isEqualTo("outside");
 }

 @Test
 public void testWrappingStreamingOutput_traceStateIsCapturedAtConstructionTime() throws Exception {
 Tracer.startSpan("before-construction");
 public void testWrappingStreamingOutput_streamingOutputTraceIsIsolated_unsampled() throws Exception {
 Tracer.setSampler(() -> false);
 Tracer.getAndClearTrace();

 Tracer.fastStartSpan("outside");
 StreamingOutput streamingOutput = JaxRsTracers.wrap(os -> {
 Tracer.fastStartSpan("inside"); // never completed
 });
 streamingOutput.write(new ByteArrayOutputStream());
 assertThat(Tracer.hasTraceId()).isTrue();
 Tracer.fastCompleteSpan();
 assertThat(Tracer.hasTraceId()).isFalse();
 }

 @Test
 public void testWrappingStreamingOutput_traceStateIsCapturedAtConstructionTime_sampled() throws Exception {
 Tracer.setSampler(AlwaysSampler.INSTANCE);
 Tracer.getAndClearTrace();

 Tracer.fastStartSpan("before-construction");
 StreamingOutput streamingOutput = JaxRsTracers.wrap(os -> {
 assertThat(Tracer.completeSpan().get().getOperation()).isEqualTo("streaming-output");
 });
 Tracer.startSpan("after-construction");
 Tracer.fastStartSpan("after-construction");
 streamingOutput.write(new ByteArrayOutputStream());
 }

 @Test
 public void testWrappingStreamingOutput_traceStateIsCapturedAtConstructionTime_unsampled() throws Exception {
 Tracer.setSampler(() -> false);
 Tracer.getAndClearTrace();

 Tracer.fastStartSpan("before-construction");
 StreamingOutput streamingOutput = JaxRsTracers.wrap(os -> {
 assertThat(Tracer.hasTraceId()).isTrue();
 Tracer.fastCompleteSpan();
 assertThat(Tracer.hasTraceId()).isFalse();
 });
 Tracer.fastStartSpan("after-construction");
 streamingOutput.write(new ByteArrayOutputStream());
 }
}

6 changes: 3 additions & 3 deletions
tracing-jersey/src/main/java/com/palantir/tracing/jersey/TraceEnrichingFilter.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -68,14 +68,14 @@ public void filter(ContainerRequestContext requestContext) throws IOException {
 if (Strings.isNullOrEmpty(traceId)) {
 // HTTP request did not indicate a trace; initialize trace state and create a span.
 Tracer.initTrace(getObservabilityFromHeader(requestContext), Tracers.randomId());
 Tracer.startSpan(operation, SpanType.SERVER_INCOMING);
 Tracer.fastStartSpan(operation, SpanType.SERVER_INCOMING);
 } else {
 Tracer.initTrace(getObservabilityFromHeader(requestContext), traceId);
 if (spanId == null) {
 Tracer.startSpan(operation, SpanType.SERVER_INCOMING);
 Tracer.fastStartSpan(operation, SpanType.SERVER_INCOMING);
 } else {
 // caller's span is this span's parent.
 Tracer.startSpan(operation, spanId, SpanType.SERVER_INCOMING);
 Tracer.fastStartSpan(operation, spanId, SpanType.SERVER_INCOMING);
 }
 }

Expand Down

4 changes: 2 additions & 2 deletions
tracing-servlet/src/test/java/com/palantir/tracing/servlet/LeakedTraceFilterTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,7 +103,7 @@ public void doFilter(ServletRequest request, ServletResponse response, FilterCha
 throws IOException, ServletException {
 // Open a span to simulate a thread from another request
 // leaving bad data without the leaked trace filter applied.
 Tracer.startSpan("previous request leaked");
 Tracer.fastStartSpan("previous request leaked");
 chain.doFilter(request, response);
 }

Expand DownExpand Up@@ -140,7 +140,7 @@ public void destroy() {}
 env.servlets().addServlet("alwaysLeaks", new HttpServlet() {
 @Override
 protected void service(HttpServletRequest req, HttpServletResponse resp) {
 Tracer.startSpan("leaky");
 Tracer.fastStartSpan("leaky");
 resp.addHeader("Leaky-Invoked", "true");
 }
 }).addMapping("/leaky");
Expand Down

6 changes: 3 additions & 3 deletions
tracing-undertow/src/main/java/com/palantir/tracing/undertow/TracedOperationHandler.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,10 +103,10 @@ private void initializeTraceFromExisting(HeaderMap headers, String traceId) {
 Tracer.initTrace(getObservabilityFromHeader(headers), traceId);
 String spanId = headers.getFirst(SPAN_ID); // nullable
 if (spanId == null) {
 Tracer.startSpan(operation, SpanType.SERVER_INCOMING);
 Tracer.fastStartSpan(operation, SpanType.SERVER_INCOMING);
 } else {
 // caller's span is this span's parent.
 Tracer.startSpan(operation, spanId, SpanType.SERVER_INCOMING);
 Tracer.fastStartSpan(operation, spanId, SpanType.SERVER_INCOMING);
 }
 }

Expand All@@ -115,7 +115,7 @@ private String initializeNewTrace(HeaderMap headers) {
 // HTTP request did not indicate a trace; initialize trace state and create a span.
 String newTraceId = Tracers.randomId();
 Tracer.initTrace(getObservabilityFromHeader(headers), newTraceId);
 Tracer.startSpan(operation, SpanType.SERVER_INCOMING);
 Tracer.fastStartSpan(operation, SpanType.SERVER_INCOMING);
 return newTraceId;
 }

Expand Down

4 changes: 2 additions & 2 deletions
tracing/src/main/java/com/palantir/tracing/AsyncTracer.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,7 +62,7 @@ public AsyncTracer(String operation) {
 */
 public AsyncTracer(Optional<String> operation) {
 this.operation = operation.orElse(DEFAULT_OPERATION);
 Tracer.startSpan(this.operation + "-enqueue");
 Tracer.fastStartSpan(this.operation + "-enqueue");
 deferredTrace = Tracer.copyTrace().get();
 Tracer.fastDiscardSpan(); // span will completed in the deferred execution
 }
Expand All@@ -76,7 +76,7 @@ public <T, E extends Throwable> T withTrace(Tracers.ThrowingCallable<T, E> inner
 Tracer.setTrace(deferredTrace);
 // Finish the enqueue span
 Tracer.fastCompleteSpan();
 Tracer.startSpan(operation + "-run");
 Tracer.fastStartSpan(operation + "-run");
 try {
 return inner.call();
 } finally {
Expand Down

2 changes: 1 addition & 1 deletion
tracing/src/main/java/com/palantir/tracing/CloseableTracer.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,7 @@ public static CloseableTracer startSpan(String operation) {
 * labeled with the provided operation.
 */
 public static CloseableTracer startSpan(String operation, SpanType spanType) {
 Tracer.startSpan(operation, spanType);
 Tracer.fastStartSpan(operation, spanType);
 return INSTANCE;
 }

Expand Down

6 changes: 3 additions & 3 deletions
tracing/src/main/java/com/palantir/tracing/DeferredTracer.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -104,11 +104,11 @@ public <T, E extends Throwable> T withTrace(Tracers.ThrowingCallable<T, E> inner

 Optional<Trace> originalTrace = Tracer.copyTrace();

 Tracer.setTrace(new Trace(isObservable, traceId));
 Tracer.setTrace(Trace.of(isObservable, traceId));
 if (parentSpanId != null) {
 Tracer.startSpan(operation, parentSpanId, SpanType.LOCAL);
 Tracer.fastStartSpan(operation, parentSpanId, SpanType.LOCAL);
 } else {
 Tracer.startSpan(operation);
 Tracer.fastStartSpan(operation);
 }

 try {
Expand Down
Loading

, '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] Tracer spans are inexpensive for unsampled operations#180

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

bulldozer-bot
merged 12 commits into

from

Jun 24, 2019
 Merged


[improvement] Tracer spans are inexpensive for unsampled operations
#180
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


12 commits


Select commit
Hold shift + click to select a range
9ab758a

Split Tracer into Sampled+Unsampled types


carterkozak Jun 20, 2019
f08617b

error prone validation to prefer the fast path


carterkozak Jun 20, 2019
6063502

Refactor startSpan logic into Tracer to reduce duplication


carterkozak Jun 20, 2019
e1adc3c

Clean up TracingBenchmark a bit


carterkozak Jun 20, 2019
41896d4

Match default sample rate


carterkozak Jun 21, 2019
90e45fb

Annotate Trace internal methods with CheckReturnValue


carterkozak Jun 21, 2019
64e9214

s/depth/numberOfSpans


carterkozak Jun 21, 2019
752fb36

style


carterkozak Jun 21, 2019
1b57d51

class level design documentation


carterkozak Jun 21, 2019
80340a3

Trace.push is an internal concern


carterkozak Jun 23, 2019
9d06c36

rename validateDepth -> validateNumberOfSpans


carterkozak Jun 23, 2019
da00afb

popCurrentSpan takes a trace


carterkozak Jun 24, 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


1 change: 1 addition & 0 deletions
.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@ bin/
.idea/
out/
generated_src/
generated_testSrc/

# Codegen
.generated
Expand Down

20 changes: 10 additions & 10 deletions
tracing-benchmarks/src/jmh/java/com/palantir/tracing/TracingBenchmark.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,7 @@

package com.palantir.tracing;

import com.google.common.util.concurrent.Runnables;
import java.util.concurrent.TimeUnit;
import org.openjdk.jmh.annotations.Benchmark;
import org.openjdk.jmh.annotations.BenchmarkMode;
Expand DownExpand Up@@ -47,13 +48,13 @@
@SuppressWarnings({"checkstyle:hideutilityclassconstructor", "checkstyle:VisibilityModifier"})
public class TracingBenchmark {

 private static final Runnable nestedSpans = createnestedSpan(100);
 private static final Runnable nestedSpans = createNestedSpan(100);

 @SuppressWarnings("ImmutableEnumChecker")
 public enum BenchmarkObservability {
 SAMPLE(AlwaysSampler.INSTANCE),
 DO_NOT_SAMPLE(() -> false),
 UNDECIDED(new RandomSampler(0.1f));
 UNDECIDED(new RandomSampler(0.01f));

 private final TraceSampler traceSampler;

Expand DownExpand Up@@ -87,20 +88,19 @@ public static void nestedSpans() {
 nestedSpans.run();
 }

 private static Runnable createnestedSpan(int depth) {
 if (depth == 0) {
 return () -> {
 };
 private static Runnable createNestedSpan(int depth) {
 if (depth <= 0) {
 return Runnables.doNothing();
 } else {
 return wrapWithSpan(createnestedSpan(depth - 1));
 return wrapWithSpan("benchmark-span-" + depth, createNestedSpan(depth - 1));
 }
 }

 private static Runnable wrapWithSpan(Runnable toBenNested) {
 private static Runnable wrapWithSpan(String operation, Runnable next) {
 return () -> {
 Tracer.fastStartSpan(operation);
 try {
 Tracer.startSpan("span");
 toBenNested.run();
 next.run();
 } finally {
 Tracer.fastCompleteSpan();
 }
Expand Down

49 changes: 43 additions & 6 deletions
tracing-jaxrs/src/test/java/com/palantir/tracing/jaxrs/JaxRsTracersTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@

import static org.assertj.core.api.Assertions.assertThat;

import com.palantir.tracing.AlwaysSampler;
import com.palantir.tracing.Tracer;
import java.io.ByteArrayOutputStream;
import javax.ws.rs.core.StreamingOutput;
Expand All@@ -26,22 +27,58 @@
public final class JaxRsTracersTest {

 @Test
 public void testWrappingStreamingOutput_streamingOutputTraceIsIsolated() throws Exception {
 Tracer.startSpan("outside");
 public void testWrappingStreamingOutput_streamingOutputTraceIsIsolated_sampled() throws Exception {
 Tracer.setSampler(AlwaysSampler.INSTANCE);
 Tracer.getAndClearTrace();

 Tracer.fastStartSpan("outside");
 StreamingOutput streamingOutput = JaxRsTracers.wrap(os -> {
 Tracer.startSpan("inside"); // never completed
 Tracer.fastStartSpan("inside"); // never completed
 });
 streamingOutput.write(new ByteArrayOutputStream());
 assertThat(Tracer.completeSpan().get().getOperation()).isEqualTo("outside");
 }

 @Test
 public void testWrappingStreamingOutput_traceStateIsCapturedAtConstructionTime() throws Exception {
 Tracer.startSpan("before-construction");
 public void testWrappingStreamingOutput_streamingOutputTraceIsIsolated_unsampled() throws Exception {
 Tracer.setSampler(() -> false);
 Tracer.getAndClearTrace();

 Tracer.fastStartSpan("outside");
 StreamingOutput streamingOutput = JaxRsTracers.wrap(os -> {
 Tracer.fastStartSpan("inside"); // never completed
 });
 streamingOutput.write(new ByteArrayOutputStream());
 assertThat(Tracer.hasTraceId()).isTrue();
 Tracer.fastCompleteSpan();
 assertThat(Tracer.hasTraceId()).isFalse();
 }

 @Test
 public void testWrappingStreamingOutput_traceStateIsCapturedAtConstructionTime_sampled() throws Exception {
 Tracer.setSampler(AlwaysSampler.INSTANCE);
 Tracer.getAndClearTrace();

 Tracer.fastStartSpan("before-construction");
 StreamingOutput streamingOutput = JaxRsTracers.wrap(os -> {
 assertThat(Tracer.completeSpan().get().getOperation()).isEqualTo("streaming-output");
 });
 Tracer.startSpan("after-construction");
 Tracer.fastStartSpan("after-construction");
 streamingOutput.write(new ByteArrayOutputStream());
 }

 @Test
 public void testWrappingStreamingOutput_traceStateIsCapturedAtConstructionTime_unsampled() throws Exception {
 Tracer.setSampler(() -> false);
 Tracer.getAndClearTrace();

 Tracer.fastStartSpan("before-construction");
 StreamingOutput streamingOutput = JaxRsTracers.wrap(os -> {
 assertThat(Tracer.hasTraceId()).isTrue();
 Tracer.fastCompleteSpan();
 assertThat(Tracer.hasTraceId()).isFalse();
 });
 Tracer.fastStartSpan("after-construction");
 streamingOutput.write(new ByteArrayOutputStream());
 }
}

6 changes: 3 additions & 3 deletions
tracing-jersey/src/main/java/com/palantir/tracing/jersey/TraceEnrichingFilter.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -68,14 +68,14 @@ public void filter(ContainerRequestContext requestContext) throws IOException {
 if (Strings.isNullOrEmpty(traceId)) {
 // HTTP request did not indicate a trace; initialize trace state and create a span.
 Tracer.initTrace(getObservabilityFromHeader(requestContext), Tracers.randomId());
 Tracer.startSpan(operation, SpanType.SERVER_INCOMING);
 Tracer.fastStartSpan(operation, SpanType.SERVER_INCOMING);
 } else {
 Tracer.initTrace(getObservabilityFromHeader(requestContext), traceId);
 if (spanId == null) {
 Tracer.startSpan(operation, SpanType.SERVER_INCOMING);
 Tracer.fastStartSpan(operation, SpanType.SERVER_INCOMING);
 } else {
 // caller's span is this span's parent.
 Tracer.startSpan(operation, spanId, SpanType.SERVER_INCOMING);
 Tracer.fastStartSpan(operation, spanId, SpanType.SERVER_INCOMING);
 }
 }

Expand Down

4 changes: 2 additions & 2 deletions
tracing-servlet/src/test/java/com/palantir/tracing/servlet/LeakedTraceFilterTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,7 +103,7 @@ public void doFilter(ServletRequest request, ServletResponse response, FilterCha
 throws IOException, ServletException {
 // Open a span to simulate a thread from another request
 // leaving bad data without the leaked trace filter applied.
 Tracer.startSpan("previous request leaked");
 Tracer.fastStartSpan("previous request leaked");
 chain.doFilter(request, response);
 }

Expand DownExpand Up@@ -140,7 +140,7 @@ public void destroy() {}
 env.servlets().addServlet("alwaysLeaks", new HttpServlet() {
 @Override
 protected void service(HttpServletRequest req, HttpServletResponse resp) {
 Tracer.startSpan("leaky");
 Tracer.fastStartSpan("leaky");
 resp.addHeader("Leaky-Invoked", "true");
 }
 }).addMapping("/leaky");
Expand Down

6 changes: 3 additions & 3 deletions
tracing-undertow/src/main/java/com/palantir/tracing/undertow/TracedOperationHandler.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -103,10 +103,10 @@ private void initializeTraceFromExisting(HeaderMap headers, String traceId) {
 Tracer.initTrace(getObservabilityFromHeader(headers), traceId);
 String spanId = headers.getFirst(SPAN_ID); // nullable
 if (spanId == null) {
 Tracer.startSpan(operation, SpanType.SERVER_INCOMING);
 Tracer.fastStartSpan(operation, SpanType.SERVER_INCOMING);
 } else {
 // caller's span is this span's parent.
 Tracer.startSpan(operation, spanId, SpanType.SERVER_INCOMING);
 Tracer.fastStartSpan(operation, spanId, SpanType.SERVER_INCOMING);
 }
 }

Expand All@@ -115,7 +115,7 @@ private String initializeNewTrace(HeaderMap headers) {
 // HTTP request did not indicate a trace; initialize trace state and create a span.
 String newTraceId = Tracers.randomId();
 Tracer.initTrace(getObservabilityFromHeader(headers), newTraceId);
 Tracer.startSpan(operation, SpanType.SERVER_INCOMING);
 Tracer.fastStartSpan(operation, SpanType.SERVER_INCOMING);
 return newTraceId;
 }

Expand Down

4 changes: 2 additions & 2 deletions
tracing/src/main/java/com/palantir/tracing/AsyncTracer.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,7 +62,7 @@ public AsyncTracer(String operation) {
 */
 public AsyncTracer(Optional<String> operation) {
 this.operation = operation.orElse(DEFAULT_OPERATION);
 Tracer.startSpan(this.operation + "-enqueue");
 Tracer.fastStartSpan(this.operation + "-enqueue");
 deferredTrace = Tracer.copyTrace().get();
 Tracer.fastDiscardSpan(); // span will completed in the deferred execution
 }
Expand All@@ -76,7 +76,7 @@ public <T, E extends Throwable> T withTrace(Tracers.ThrowingCallable<T, E> inner
 Tracer.setTrace(deferredTrace);
 // Finish the enqueue span
 Tracer.fastCompleteSpan();
 Tracer.startSpan(operation + "-run");
 Tracer.fastStartSpan(operation + "-run");
 try {
 return inner.call();
 } finally {
Expand Down

2 changes: 1 addition & 1 deletion
tracing/src/main/java/com/palantir/tracing/CloseableTracer.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,7 @@ public static CloseableTracer startSpan(String operation) {
 * labeled with the provided operation.
 */
 public static CloseableTracer startSpan(String operation, SpanType spanType) {
 Tracer.startSpan(operation, spanType);
 Tracer.fastStartSpan(operation, spanType);
 return INSTANCE;
 }

Expand Down

6 changes: 3 additions & 3 deletions
tracing/src/main/java/com/palantir/tracing/DeferredTracer.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -104,11 +104,11 @@ public <T, E extends Throwable> T withTrace(Tracers.ThrowingCallable<T, E> inner

 Optional<Trace> originalTrace = Tracer.copyTrace();

 Tracer.setTrace(new Trace(isObservable, traceId));
 Tracer.setTrace(Trace.of(isObservable, traceId));
 if (parentSpanId != null) {
 Tracer.startSpan(operation, parentSpanId, SpanType.LOCAL);
 Tracer.fastStartSpan(operation, parentSpanId, SpanType.LOCAL);
 } else {
 Tracer.startSpan(operation);
 Tracer.fastStartSpan(operation);
 }

 try {
Expand Down
Loading