Skip to content

Tracer#getTraceMetadata [into ckozak/detached_tracing_api]#249

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
iamdanfox merged 5 commits into from
Sep 4, 2019
Merged

Tracer#getTraceMetadata [into ckozak/detached_tracing_api] #249

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a8f6c76
Revert "CloseableSpan exposes ids necessary to set headers"
iamdanfox Sep 4, 2019
1d03066
Tracer#getTraceMetadata
iamdanfox Sep 4, 2019
cc77f82
parentSpanId is empty
iamdanfox Sep 4, 2019
b700633
nit
iamdanfox Sep 4, 2019
b54a116
Update tracing/src/main/java/com/palantir/tracing/Tracer.java
iamdanfox Sep 4, 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
7 changes: 0 additions & 7 deletions tracing/src/main/java/com/palantir/tracing/CloseableSpan.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,6 @@
package com.palantir.tracing;

import java.io.Closeable;
import java.util.Optional;

/**
* Closeable marker around a tracing span operation. This object should be used in a try/with block.
Expand All@@ -31,10 +30,4 @@ public interface CloseableSpan extends Closeable {
*/
@Override
void close();

String getSpanId();

Optional<String> getParentSpanId();

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

package com.palantir.tracing;

import java.util.Optional;
import org.immutables.value.Value;

/** Ids necessary to write headers onto network requests. */
@Value.Immutable
@Value.Style(visibility = Value.Style.ImplementationVisibility.PACKAGE)
interface TraceMetadata {

/** Corresponds to {@link com.palantir.tracing.api.TraceHttpHeaders#TRACE_ID}. */
String traceId();

/** Corresponds to {@link com.palantir.tracing.api.TraceHttpHeaders#SPAN_ID}. */
String spanId();

/** Corresponds to {@link com.palantir.tracing.api.TraceHttpHeaders#PARENT_SPAN_ID}. */
Optional<String> parentSpanId();

/** Corresponds to {@link com.palantir.tracing.api.TraceHttpHeaders#ORIGINATING_SPAN_ID}. */
Optional<String> originatingSpanId();

static Builder builder() {
return new Builder();
}

class Builder extends ImmutableTraceMetadata.Builder {}
}
72 changes: 41 additions & 31 deletions tracing/src/main/java/com/palantir/tracing/Tracer.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,7 @@
import com.palantir.logsafe.SafeArg;
import com.palantir.logsafe.UnsafeArg;
import com.palantir.logsafe.exceptions.SafeIllegalArgumentException;
import com.palantir.logsafe.exceptions.SafeRuntimeException;
import com.palantir.tracing.api.OpenSpan;
import com.palantir.tracing.api.Span;
import com.palantir.tracing.api.SpanObserver;
Expand DownExpand Up@@ -89,6 +90,32 @@ private static boolean shouldObserve(Observability observability) {
throw new SafeIllegalArgumentException("Unknown observability", SafeArg.of("observability", observability));
}

static TraceMetadata getTraceMetadata() {
Trace trace = checkNotNull(currentTrace.get(), "Unable to getTraceMetadata when there is trace in progress");

if (trace.isObservable()) {
OpenSpan openSpan = trace.top()
.orElseThrow(() -> new SafeRuntimeException("Trace with no spans in progress"));
return TraceMetadata.builder()
.spanId(openSpan.getSpanId())
.parentSpanId(openSpan.getParentSpanId())
.originatingSpanId(trace.getOriginatingSpanId())
.traceId(trace.getTraceId())
.build();
} else {
// In the unsampled case, the Trace.Unsampled class doesn't actually store a spanId/parentSpanId
// stack, so we just make one up (just in time). This matches the behaviour of Tracer#startSpan.

// n.b. this is a bit funky because calling getTraceMetadata multiple times will return different spanIds
return TraceMetadata.builder()
.spanId(Tracers.randomId())
.parentSpanId(Optional.empty())
.originatingSpanId(trace.getOriginatingSpanId())
.traceId(trace.getTraceId())
.build();
}
}

/**
* Deprecated.
*
Expand DownExpand Up@@ -207,8 +234,8 @@ public CloseableSpan childSpan(String operationName, SpanType type) {
warnIfCompleted("startSpanOnCurrentThread");
Trace maybeCurrentTrace = currentTrace.get();
setTrace(Trace.of(true, traceId));
OpenSpan newSpan = Tracer.startSpan(operationName, openSpan.getSpanId(), type);
return TraceRestoringCloseableSpan.of(maybeCurrentTrace, newSpan);
Tracer.fastStartSpan(operationName, openSpan.getSpanId(), type);
return TraceRestoringCloseableSpan.of(maybeCurrentTrace);
}

@Override
Expand DownExpand Up@@ -251,8 +278,8 @@ private static final class UnsampledDetachedSpan implements DetachedSpan {
public CloseableSpan childSpan(String operationName, SpanType type) {
Trace maybeCurrentTrace = currentTrace.get();
setTrace(Trace.of(false, traceId));
OpenSpan newSpan = Tracer.startSpan(operationName, type);
return TraceRestoringCloseableSpan.of(maybeCurrentTrace, newSpan);
Tracer.fastStartSpan(operationName, type);
return TraceRestoringCloseableSpan.of(maybeCurrentTrace);
}

@Override
Expand All@@ -273,40 +300,23 @@ public String toString() {

private static final class TraceRestoringCloseableSpan implements CloseableSpan {

@Nullable
private final Trace traceToRestore;
private final OpenSpan newSpan;

TraceRestoringCloseableSpan(@Nullable Trace traceToRestore, OpenSpan newSpan) {
this.traceToRestore = traceToRestore;
this.newSpan = Preconditions.checkNotNull(newSpan, "OpenSpan");
}

public static CloseableSpan of(@Nullable Trace traceToRestore, OpenSpan newSpan) {
return new TraceRestoringCloseableSpan(traceToRestore, newSpan);
}
// Complete the current span.
private static final CloseableSpan DEFAULT_TOKEN = Tracer::fastCompleteSpan;

@Override
public void close() {
Tracer.fastCompleteSpan();
if (traceToRestore != null) {
Tracer.setTrace(traceToRestore);
}
}
private final Trace original;

@Override
public String getSpanId() {
return newSpan.getSpanId();
static CloseableSpan of(@Nullable Trace original) {
return original == null ? DEFAULT_TOKEN : new TraceRestoringCloseableSpan(original);
}

@Override
public Optional<String> getParentSpanId() {
return newSpan.getParentSpanId();
TraceRestoringCloseableSpan(Trace original) {
this.original = Preconditions.checkNotNull(original, "Expected an original trace instance");
}

@Override
public Optional<String> getOriginatingSpanId() {
return newSpan.getOriginatingSpanId();
public void close() {
DEFAULT_TOKEN.close();
Tracer.setTrace(original);
}
}

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

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

iamdanfox
merged 5 commits into

from

Sep 4, 2019
 Merged


Tracer#getTraceMetadata [into ckozak/detached_tracing_api]
#249
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
a8f6c76

Revert "CloseableSpan exposes ids necessary to set headers"


iamdanfox Sep 4, 2019
1d03066

Tracer#getTraceMetadata


iamdanfox Sep 4, 2019
cc77f82

parentSpanId is empty


iamdanfox Sep 4, 2019
b700633

nit


iamdanfox Sep 4, 2019
b54a116

Update tracing/src/main/java/com/palantir/tracing/Tracer.java


iamdanfox Sep 4, 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


7 changes: 0 additions & 7 deletions
tracing/src/main/java/com/palantir/tracing/CloseableSpan.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,6 @@
package com.palantir.tracing;

import java.io.Closeable;
import java.util.Optional;

/**
 * Closeable marker around a tracing span operation. This object should be used in a try/with block.
Expand All@@ -31,10 +30,4 @@ public interface CloseableSpan extends Closeable {
 */
 @Override
 void close();

 String getSpanId();

 Optional<String> getParentSpanId();

 Optional<String> getOriginatingSpanId();
}

44 changes: 44 additions & 0 deletions
tracing/src/main/java/com/palantir/tracing/TraceMetadata.java

View file


Open in desktop

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

package com.palantir.tracing;

import java.util.Optional;
import org.immutables.value.Value;

/** Ids necessary to write headers onto network requests. */
@Value.Immutable
@Value.Style(visibility = Value.Style.ImplementationVisibility.PACKAGE)
interface TraceMetadata {

 /** Corresponds to {@link com.palantir.tracing.api.TraceHttpHeaders#TRACE_ID}. */
 String traceId();

 /** Corresponds to {@link com.palantir.tracing.api.TraceHttpHeaders#SPAN_ID}. */
 String spanId();

 /** Corresponds to {@link com.palantir.tracing.api.TraceHttpHeaders#PARENT_SPAN_ID}. */
 Optional<String> parentSpanId();

 /** Corresponds to {@link com.palantir.tracing.api.TraceHttpHeaders#ORIGINATING_SPAN_ID}. */
 Optional<String> originatingSpanId();

 static Builder builder() {
 return new Builder();
 }

 class Builder extends ImmutableTraceMetadata.Builder {}
}

72 changes: 41 additions & 31 deletions
tracing/src/main/java/com/palantir/tracing/Tracer.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,7 @@
import com.palantir.logsafe.SafeArg;
import com.palantir.logsafe.UnsafeArg;
import com.palantir.logsafe.exceptions.SafeIllegalArgumentException;
import com.palantir.logsafe.exceptions.SafeRuntimeException;
import com.palantir.tracing.api.OpenSpan;
import com.palantir.tracing.api.Span;
import com.palantir.tracing.api.SpanObserver;
Expand DownExpand Up@@ -89,6 +90,32 @@ private static boolean shouldObserve(Observability observability) {
 throw new SafeIllegalArgumentException("Unknown observability", SafeArg.of("observability", observability));
 }

 static TraceMetadata getTraceMetadata() {
 Trace trace = checkNotNull(currentTrace.get(), "Unable to getTraceMetadata when there is trace in progress");

 if (trace.isObservable()) {
 OpenSpan openSpan = trace.top()
 .orElseThrow(() -> new SafeRuntimeException("Trace with no spans in progress"));
 return TraceMetadata.builder()
 .spanId(openSpan.getSpanId())
 .parentSpanId(openSpan.getParentSpanId())
 .originatingSpanId(trace.getOriginatingSpanId())
 .traceId(trace.getTraceId())
 .build();
 } else {
 // In the unsampled case, the Trace.Unsampled class doesn't actually store a spanId/parentSpanId
 // stack, so we just make one up (just in time). This matches the behaviour of Tracer#startSpan.

 // n.b. this is a bit funky because calling getTraceMetadata multiple times will return different spanIds
 return TraceMetadata.builder()
 .spanId(Tracers.randomId())
 .parentSpanId(Optional.empty())
 .originatingSpanId(trace.getOriginatingSpanId())
 .traceId(trace.getTraceId())
 .build();
 }
 }

 /**
 * Deprecated.
 *
Expand DownExpand Up@@ -207,8 +234,8 @@ public CloseableSpan childSpan(String operationName, SpanType type) {
 warnIfCompleted("startSpanOnCurrentThread");
 Trace maybeCurrentTrace = currentTrace.get();
 setTrace(Trace.of(true, traceId));
OpenSpan newSpan = Tracer.startSpan(operationName, openSpan.getSpanId(), type);
 return TraceRestoringCloseableSpan.of(maybeCurrentTrace, newSpan);
 Tracer.fastStartSpan(operationName, openSpan.getSpanId(), type);
 return TraceRestoringCloseableSpan.of(maybeCurrentTrace);
 }

 @Override
Expand DownExpand Up@@ -251,8 +278,8 @@ private static final class UnsampledDetachedSpan implements DetachedSpan {
 public CloseableSpan childSpan(String operationName, SpanType type) {
 Trace maybeCurrentTrace = currentTrace.get();
 setTrace(Trace.of(false, traceId));
OpenSpan newSpan = Tracer.startSpan(operationName, type);
 return TraceRestoringCloseableSpan.of(maybeCurrentTrace, newSpan);
 Tracer.fastStartSpan(operationName, type);
 return TraceRestoringCloseableSpan.of(maybeCurrentTrace);
 }

 @Override
Expand All@@ -273,40 +300,23 @@ public String toString() {

 private static final class TraceRestoringCloseableSpan implements CloseableSpan {

 @Nullable
 private final Trace traceToRestore;
 private final OpenSpan newSpan;

 TraceRestoringCloseableSpan(@Nullable Trace traceToRestore, OpenSpan newSpan) {
 this.traceToRestore = traceToRestore;
 this.newSpan = Preconditions.checkNotNull(newSpan, "OpenSpan");
 }

 public static CloseableSpan of(@Nullable Trace traceToRestore, OpenSpan newSpan) {
 return new TraceRestoringCloseableSpan(traceToRestore, newSpan);
 }
 // Complete the current span.
 private static final CloseableSpan DEFAULT_TOKEN = Tracer::fastCompleteSpan;

 @Override
 public void close() {
 Tracer.fastCompleteSpan();
 if (traceToRestore != null) {
 Tracer.setTrace(traceToRestore);
 }
 }
 private final Trace original;

 @Override
 public String getSpanId() {
 return newSpan.getSpanId();
 static CloseableSpan of(@Nullable Trace original) {
 return original == null ? DEFAULT_TOKEN : new TraceRestoringCloseableSpan(original);
 }

 @Override
 public Optional<String> getParentSpanId() {
 return newSpan.getParentSpanId();
 TraceRestoringCloseableSpan(Trace original) {
 this.original = Preconditions.checkNotNull(original, "Expected an original trace instance");
 }

 @Override
 public Optional<String> getOriginatingSpanId() {
 return newSpan.getOriginatingSpanId();
 public void close() {
 DEFAULT_TOKEN.close();
 Tracer.setTrace(original);
 }
 }

Expand Down

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

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

iamdanfox
merged 5 commits into

from

Sep 4, 2019
 Merged


Tracer#getTraceMetadata [into ckozak/detached_tracing_api]
#249
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
a8f6c76

Revert "CloseableSpan exposes ids necessary to set headers"


iamdanfox Sep 4, 2019
1d03066

Tracer#getTraceMetadata


iamdanfox Sep 4, 2019
cc77f82

parentSpanId is empty


iamdanfox Sep 4, 2019
b700633

nit


iamdanfox Sep 4, 2019
b54a116

Update tracing/src/main/java/com/palantir/tracing/Tracer.java


iamdanfox Sep 4, 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


7 changes: 0 additions & 7 deletions
tracing/src/main/java/com/palantir/tracing/CloseableSpan.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,6 @@
package com.palantir.tracing;

import java.io.Closeable;
import java.util.Optional;

/**
 * Closeable marker around a tracing span operation. This object should be used in a try/with block.
Expand All@@ -31,10 +30,4 @@ public interface CloseableSpan extends Closeable {
 */
 @Override
 void close();

 String getSpanId();

 Optional<String> getParentSpanId();

 Optional<String> getOriginatingSpanId();
}

44 changes: 44 additions & 0 deletions
tracing/src/main/java/com/palantir/tracing/TraceMetadata.java

View file


Open in desktop

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

package com.palantir.tracing;

import java.util.Optional;
import org.immutables.value.Value;

/** Ids necessary to write headers onto network requests. */
@Value.Immutable
@Value.Style(visibility = Value.Style.ImplementationVisibility.PACKAGE)
interface TraceMetadata {

 /** Corresponds to {@link com.palantir.tracing.api.TraceHttpHeaders#TRACE_ID}. */
 String traceId();

 /** Corresponds to {@link com.palantir.tracing.api.TraceHttpHeaders#SPAN_ID}. */
 String spanId();

 /** Corresponds to {@link com.palantir.tracing.api.TraceHttpHeaders#PARENT_SPAN_ID}. */
 Optional<String> parentSpanId();

 /** Corresponds to {@link com.palantir.tracing.api.TraceHttpHeaders#ORIGINATING_SPAN_ID}. */
 Optional<String> originatingSpanId();

 static Builder builder() {
 return new Builder();
 }

 class Builder extends ImmutableTraceMetadata.Builder {}
}

72 changes: 41 additions & 31 deletions
tracing/src/main/java/com/palantir/tracing/Tracer.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,7 @@
import com.palantir.logsafe.SafeArg;
import com.palantir.logsafe.UnsafeArg;
import com.palantir.logsafe.exceptions.SafeIllegalArgumentException;
import com.palantir.logsafe.exceptions.SafeRuntimeException;
import com.palantir.tracing.api.OpenSpan;
import com.palantir.tracing.api.Span;
import com.palantir.tracing.api.SpanObserver;
Expand DownExpand Up@@ -89,6 +90,32 @@ private static boolean shouldObserve(Observability observability) {
 throw new SafeIllegalArgumentException("Unknown observability", SafeArg.of("observability", observability));
 }

 static TraceMetadata getTraceMetadata() {
 Trace trace = checkNotNull(currentTrace.get(), "Unable to getTraceMetadata when there is trace in progress");

 if (trace.isObservable()) {
 OpenSpan openSpan = trace.top()
 .orElseThrow(() -> new SafeRuntimeException("Trace with no spans in progress"));
 return TraceMetadata.builder()
 .spanId(openSpan.getSpanId())
 .parentSpanId(openSpan.getParentSpanId())
 .originatingSpanId(trace.getOriginatingSpanId())
 .traceId(trace.getTraceId())
 .build();
 } else {
 // In the unsampled case, the Trace.Unsampled class doesn't actually store a spanId/parentSpanId
 // stack, so we just make one up (just in time). This matches the behaviour of Tracer#startSpan.

 // n.b. this is a bit funky because calling getTraceMetadata multiple times will return different spanIds
 return TraceMetadata.builder()
 .spanId(Tracers.randomId())
 .parentSpanId(Optional.empty())
 .originatingSpanId(trace.getOriginatingSpanId())
 .traceId(trace.getTraceId())
 .build();
 }
 }

 /**
 * Deprecated.
 *
Expand DownExpand Up@@ -207,8 +234,8 @@ public CloseableSpan childSpan(String operationName, SpanType type) {
 warnIfCompleted("startSpanOnCurrentThread");
 Trace maybeCurrentTrace = currentTrace.get();
 setTrace(Trace.of(true, traceId));
OpenSpan newSpan = Tracer.startSpan(operationName, openSpan.getSpanId(), type);
 return TraceRestoringCloseableSpan.of(maybeCurrentTrace, newSpan);
 Tracer.fastStartSpan(operationName, openSpan.getSpanId(), type);
 return TraceRestoringCloseableSpan.of(maybeCurrentTrace);
 }

 @Override
Expand DownExpand Up@@ -251,8 +278,8 @@ private static final class UnsampledDetachedSpan implements DetachedSpan {
 public CloseableSpan childSpan(String operationName, SpanType type) {
 Trace maybeCurrentTrace = currentTrace.get();
 setTrace(Trace.of(false, traceId));
OpenSpan newSpan = Tracer.startSpan(operationName, type);
 return TraceRestoringCloseableSpan.of(maybeCurrentTrace, newSpan);
 Tracer.fastStartSpan(operationName, type);
 return TraceRestoringCloseableSpan.of(maybeCurrentTrace);
 }

 @Override
Expand All@@ -273,40 +300,23 @@ public String toString() {

 private static final class TraceRestoringCloseableSpan implements CloseableSpan {

 @Nullable
 private final Trace traceToRestore;
 private final OpenSpan newSpan;

 TraceRestoringCloseableSpan(@Nullable Trace traceToRestore, OpenSpan newSpan) {
 this.traceToRestore = traceToRestore;
 this.newSpan = Preconditions.checkNotNull(newSpan, "OpenSpan");
 }

 public static CloseableSpan of(@Nullable Trace traceToRestore, OpenSpan newSpan) {
 return new TraceRestoringCloseableSpan(traceToRestore, newSpan);
 }
 // Complete the current span.
 private static final CloseableSpan DEFAULT_TOKEN = Tracer::fastCompleteSpan;

 @Override
 public void close() {
 Tracer.fastCompleteSpan();
 if (traceToRestore != null) {
 Tracer.setTrace(traceToRestore);
 }
 }
 private final Trace original;

 @Override
 public String getSpanId() {
 return newSpan.getSpanId();
 static CloseableSpan of(@Nullable Trace original) {
 return original == null ? DEFAULT_TOKEN : new TraceRestoringCloseableSpan(original);
 }

 @Override
 public Optional<String> getParentSpanId() {
 return newSpan.getParentSpanId();
 TraceRestoringCloseableSpan(Trace original) {
 this.original = Preconditions.checkNotNull(original, "Expected an original trace instance");
 }

 @Override
 public Optional<String> getOriginatingSpanId() {
 return newSpan.getOriginatingSpanId();
 public void close() {
 DEFAULT_TOKEN.close();
 Tracer.setTrace(original);
 }
 }

Expand Down

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

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

iamdanfox
merged 5 commits into

from

Sep 4, 2019
 Merged


Tracer#getTraceMetadata [into ckozak/detached_tracing_api]
#249
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
a8f6c76

Revert "CloseableSpan exposes ids necessary to set headers"


iamdanfox Sep 4, 2019
1d03066

Tracer#getTraceMetadata


iamdanfox Sep 4, 2019
cc77f82

parentSpanId is empty


iamdanfox Sep 4, 2019
b700633

nit


iamdanfox Sep 4, 2019
b54a116

Update tracing/src/main/java/com/palantir/tracing/Tracer.java


iamdanfox Sep 4, 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


7 changes: 0 additions & 7 deletions
tracing/src/main/java/com/palantir/tracing/CloseableSpan.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,6 @@
package com.palantir.tracing;

import java.io.Closeable;
import java.util.Optional;

/**
 * Closeable marker around a tracing span operation. This object should be used in a try/with block.
Expand All@@ -31,10 +30,4 @@ public interface CloseableSpan extends Closeable {
 */
 @Override
 void close();

 String getSpanId();

 Optional<String> getParentSpanId();

 Optional<String> getOriginatingSpanId();
}

44 changes: 44 additions & 0 deletions
tracing/src/main/java/com/palantir/tracing/TraceMetadata.java

View file


Open in desktop

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

package com.palantir.tracing;

import java.util.Optional;
import org.immutables.value.Value;

/** Ids necessary to write headers onto network requests. */
@Value.Immutable
@Value.Style(visibility = Value.Style.ImplementationVisibility.PACKAGE)
interface TraceMetadata {

 /** Corresponds to {@link com.palantir.tracing.api.TraceHttpHeaders#TRACE_ID}. */
 String traceId();

 /** Corresponds to {@link com.palantir.tracing.api.TraceHttpHeaders#SPAN_ID}. */
 String spanId();

 /** Corresponds to {@link com.palantir.tracing.api.TraceHttpHeaders#PARENT_SPAN_ID}. */
 Optional<String> parentSpanId();

 /** Corresponds to {@link com.palantir.tracing.api.TraceHttpHeaders#ORIGINATING_SPAN_ID}. */
 Optional<String> originatingSpanId();

 static Builder builder() {
 return new Builder();
 }

 class Builder extends ImmutableTraceMetadata.Builder {}
}

72 changes: 41 additions & 31 deletions
tracing/src/main/java/com/palantir/tracing/Tracer.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,7 @@
import com.palantir.logsafe.SafeArg;
import com.palantir.logsafe.UnsafeArg;
import com.palantir.logsafe.exceptions.SafeIllegalArgumentException;
import com.palantir.logsafe.exceptions.SafeRuntimeException;
import com.palantir.tracing.api.OpenSpan;
import com.palantir.tracing.api.Span;
import com.palantir.tracing.api.SpanObserver;
Expand DownExpand Up@@ -89,6 +90,32 @@ private static boolean shouldObserve(Observability observability) {
 throw new SafeIllegalArgumentException("Unknown observability", SafeArg.of("observability", observability));
 }

 static TraceMetadata getTraceMetadata() {
 Trace trace = checkNotNull(currentTrace.get(), "Unable to getTraceMetadata when there is trace in progress");

 if (trace.isObservable()) {
 OpenSpan openSpan = trace.top()
 .orElseThrow(() -> new SafeRuntimeException("Trace with no spans in progress"));
 return TraceMetadata.builder()
 .spanId(openSpan.getSpanId())
 .parentSpanId(openSpan.getParentSpanId())
 .originatingSpanId(trace.getOriginatingSpanId())
 .traceId(trace.getTraceId())
 .build();
 } else {
 // In the unsampled case, the Trace.Unsampled class doesn't actually store a spanId/parentSpanId
 // stack, so we just make one up (just in time). This matches the behaviour of Tracer#startSpan.

 // n.b. this is a bit funky because calling getTraceMetadata multiple times will return different spanIds
 return TraceMetadata.builder()
 .spanId(Tracers.randomId())
 .parentSpanId(Optional.empty())
 .originatingSpanId(trace.getOriginatingSpanId())
 .traceId(trace.getTraceId())
 .build();
 }
 }

 /**
 * Deprecated.
 *
Expand DownExpand Up@@ -207,8 +234,8 @@ public CloseableSpan childSpan(String operationName, SpanType type) {
 warnIfCompleted("startSpanOnCurrentThread");
 Trace maybeCurrentTrace = currentTrace.get();
 setTrace(Trace.of(true, traceId));
OpenSpan newSpan = Tracer.startSpan(operationName, openSpan.getSpanId(), type);
 return TraceRestoringCloseableSpan.of(maybeCurrentTrace, newSpan);
 Tracer.fastStartSpan(operationName, openSpan.getSpanId(), type);
 return TraceRestoringCloseableSpan.of(maybeCurrentTrace);
 }

 @Override
Expand DownExpand Up@@ -251,8 +278,8 @@ private static final class UnsampledDetachedSpan implements DetachedSpan {
 public CloseableSpan childSpan(String operationName, SpanType type) {
 Trace maybeCurrentTrace = currentTrace.get();
 setTrace(Trace.of(false, traceId));
OpenSpan newSpan = Tracer.startSpan(operationName, type);
 return TraceRestoringCloseableSpan.of(maybeCurrentTrace, newSpan);
 Tracer.fastStartSpan(operationName, type);
 return TraceRestoringCloseableSpan.of(maybeCurrentTrace);
 }

 @Override
Expand All@@ -273,40 +300,23 @@ public String toString() {

 private static final class TraceRestoringCloseableSpan implements CloseableSpan {

 @Nullable
 private final Trace traceToRestore;
 private final OpenSpan newSpan;

 TraceRestoringCloseableSpan(@Nullable Trace traceToRestore, OpenSpan newSpan) {
 this.traceToRestore = traceToRestore;
 this.newSpan = Preconditions.checkNotNull(newSpan, "OpenSpan");
 }

 public static CloseableSpan of(@Nullable Trace traceToRestore, OpenSpan newSpan) {
 return new TraceRestoringCloseableSpan(traceToRestore, newSpan);
 }
 // Complete the current span.
 private static final CloseableSpan DEFAULT_TOKEN = Tracer::fastCompleteSpan;

 @Override
 public void close() {
 Tracer.fastCompleteSpan();
 if (traceToRestore != null) {
 Tracer.setTrace(traceToRestore);
 }
 }
 private final Trace original;

 @Override
 public String getSpanId() {
 return newSpan.getSpanId();
 static CloseableSpan of(@Nullable Trace original) {
 return original == null ? DEFAULT_TOKEN : new TraceRestoringCloseableSpan(original);
 }

 @Override
 public Optional<String> getParentSpanId() {
 return newSpan.getParentSpanId();
 TraceRestoringCloseableSpan(Trace original) {
 this.original = Preconditions.checkNotNull(original, "Expected an original trace instance");
 }

 @Override
 public Optional<String> getOriginatingSpanId() {
 return newSpan.getOriginatingSpanId();
 public void close() {
 DEFAULT_TOKEN.close();
 Tracer.setTrace(original);
 }
 }

Expand Down

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

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

iamdanfox
merged 5 commits into

from

Sep 4, 2019
 Merged


Tracer#getTraceMetadata [into ckozak/detached_tracing_api]
#249
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
a8f6c76

Revert "CloseableSpan exposes ids necessary to set headers"


iamdanfox Sep 4, 2019
1d03066

Tracer#getTraceMetadata


iamdanfox Sep 4, 2019
cc77f82

parentSpanId is empty


iamdanfox Sep 4, 2019
b700633

nit


iamdanfox Sep 4, 2019
b54a116

Update tracing/src/main/java/com/palantir/tracing/Tracer.java


iamdanfox Sep 4, 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


7 changes: 0 additions & 7 deletions
tracing/src/main/java/com/palantir/tracing/CloseableSpan.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,6 @@
package com.palantir.tracing;

import java.io.Closeable;
import java.util.Optional;

/**
 * Closeable marker around a tracing span operation. This object should be used in a try/with block.
Expand All@@ -31,10 +30,4 @@ public interface CloseableSpan extends Closeable {
 */
 @Override
 void close();

 String getSpanId();

 Optional<String> getParentSpanId();

 Optional<String> getOriginatingSpanId();
}

44 changes: 44 additions & 0 deletions
tracing/src/main/java/com/palantir/tracing/TraceMetadata.java

View file


Open in desktop

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

package com.palantir.tracing;

import java.util.Optional;
import org.immutables.value.Value;

/** Ids necessary to write headers onto network requests. */
@Value.Immutable
@Value.Style(visibility = Value.Style.ImplementationVisibility.PACKAGE)
interface TraceMetadata {

 /** Corresponds to {@link com.palantir.tracing.api.TraceHttpHeaders#TRACE_ID}. */
 String traceId();

 /** Corresponds to {@link com.palantir.tracing.api.TraceHttpHeaders#SPAN_ID}. */
 String spanId();

 /** Corresponds to {@link com.palantir.tracing.api.TraceHttpHeaders#PARENT_SPAN_ID}. */
 Optional<String> parentSpanId();

 /** Corresponds to {@link com.palantir.tracing.api.TraceHttpHeaders#ORIGINATING_SPAN_ID}. */
 Optional<String> originatingSpanId();

 static Builder builder() {
 return new Builder();
 }

 class Builder extends ImmutableTraceMetadata.Builder {}
}

72 changes: 41 additions & 31 deletions
tracing/src/main/java/com/palantir/tracing/Tracer.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,7 @@
import com.palantir.logsafe.SafeArg;
import com.palantir.logsafe.UnsafeArg;
import com.palantir.logsafe.exceptions.SafeIllegalArgumentException;
import com.palantir.logsafe.exceptions.SafeRuntimeException;
import com.palantir.tracing.api.OpenSpan;
import com.palantir.tracing.api.Span;
import com.palantir.tracing.api.SpanObserver;
Expand DownExpand Up@@ -89,6 +90,32 @@ private static boolean shouldObserve(Observability observability) {
 throw new SafeIllegalArgumentException("Unknown observability", SafeArg.of("observability", observability));
 }

 static TraceMetadata getTraceMetadata() {
 Trace trace = checkNotNull(currentTrace.get(), "Unable to getTraceMetadata when there is trace in progress");

 if (trace.isObservable()) {
 OpenSpan openSpan = trace.top()
 .orElseThrow(() -> new SafeRuntimeException("Trace with no spans in progress"));
 return TraceMetadata.builder()
 .spanId(openSpan.getSpanId())
 .parentSpanId(openSpan.getParentSpanId())
 .originatingSpanId(trace.getOriginatingSpanId())
 .traceId(trace.getTraceId())
 .build();
 } else {
 // In the unsampled case, the Trace.Unsampled class doesn't actually store a spanId/parentSpanId
 // stack, so we just make one up (just in time). This matches the behaviour of Tracer#startSpan.

 // n.b. this is a bit funky because calling getTraceMetadata multiple times will return different spanIds
 return TraceMetadata.builder()
 .spanId(Tracers.randomId())
 .parentSpanId(Optional.empty())
 .originatingSpanId(trace.getOriginatingSpanId())
 .traceId(trace.getTraceId())
 .build();
 }
 }

 /**
 * Deprecated.
 *
Expand DownExpand Up@@ -207,8 +234,8 @@ public CloseableSpan childSpan(String operationName, SpanType type) {
 warnIfCompleted("startSpanOnCurrentThread");
 Trace maybeCurrentTrace = currentTrace.get();
 setTrace(Trace.of(true, traceId));
OpenSpan newSpan = Tracer.startSpan(operationName, openSpan.getSpanId(), type);
 return TraceRestoringCloseableSpan.of(maybeCurrentTrace, newSpan);
 Tracer.fastStartSpan(operationName, openSpan.getSpanId(), type);
 return TraceRestoringCloseableSpan.of(maybeCurrentTrace);
 }

 @Override
Expand DownExpand Up@@ -251,8 +278,8 @@ private static final class UnsampledDetachedSpan implements DetachedSpan {
 public CloseableSpan childSpan(String operationName, SpanType type) {
 Trace maybeCurrentTrace = currentTrace.get();
 setTrace(Trace.of(false, traceId));
OpenSpan newSpan = Tracer.startSpan(operationName, type);
 return TraceRestoringCloseableSpan.of(maybeCurrentTrace, newSpan);
 Tracer.fastStartSpan(operationName, type);
 return TraceRestoringCloseableSpan.of(maybeCurrentTrace);
 }

 @Override
Expand All@@ -273,40 +300,23 @@ public String toString() {

 private static final class TraceRestoringCloseableSpan implements CloseableSpan {

 @Nullable
 private final Trace traceToRestore;
 private final OpenSpan newSpan;

 TraceRestoringCloseableSpan(@Nullable Trace traceToRestore, OpenSpan newSpan) {
 this.traceToRestore = traceToRestore;
 this.newSpan = Preconditions.checkNotNull(newSpan, "OpenSpan");
 }

 public static CloseableSpan of(@Nullable Trace traceToRestore, OpenSpan newSpan) {
 return new TraceRestoringCloseableSpan(traceToRestore, newSpan);
 }
 // Complete the current span.
 private static final CloseableSpan DEFAULT_TOKEN = Tracer::fastCompleteSpan;

 @Override
 public void close() {
 Tracer.fastCompleteSpan();
 if (traceToRestore != null) {
 Tracer.setTrace(traceToRestore);
 }
 }
 private final Trace original;

 @Override
 public String getSpanId() {
 return newSpan.getSpanId();
 static CloseableSpan of(@Nullable Trace original) {
 return original == null ? DEFAULT_TOKEN : new TraceRestoringCloseableSpan(original);
 }

 @Override
 public Optional<String> getParentSpanId() {
 return newSpan.getParentSpanId();
 TraceRestoringCloseableSpan(Trace original) {
 this.original = Preconditions.checkNotNull(original, "Expected an original trace instance");
 }

 @Override
 public Optional<String> getOriginatingSpanId() {
 return newSpan.getOriginatingSpanId();
 public void close() {
 DEFAULT_TOKEN.close();
 Tracer.setTrace(original);
 }
 }

Expand Down

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

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

iamdanfox
merged 5 commits into

from

Sep 4, 2019
 Merged


Tracer#getTraceMetadata [into ckozak/detached_tracing_api]
#249
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
a8f6c76

Revert "CloseableSpan exposes ids necessary to set headers"


iamdanfox Sep 4, 2019
1d03066

Tracer#getTraceMetadata


iamdanfox Sep 4, 2019
cc77f82

parentSpanId is empty


iamdanfox Sep 4, 2019
b700633

nit


iamdanfox Sep 4, 2019
b54a116

Update tracing/src/main/java/com/palantir/tracing/Tracer.java


iamdanfox Sep 4, 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


7 changes: 0 additions & 7 deletions
tracing/src/main/java/com/palantir/tracing/CloseableSpan.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,6 @@
package com.palantir.tracing;

import java.io.Closeable;
import java.util.Optional;

/**
 * Closeable marker around a tracing span operation. This object should be used in a try/with block.
Expand All@@ -31,10 +30,4 @@ public interface CloseableSpan extends Closeable {
 */
 @Override
 void close();

 String getSpanId();

 Optional<String> getParentSpanId();

 Optional<String> getOriginatingSpanId();
}

44 changes: 44 additions & 0 deletions
tracing/src/main/java/com/palantir/tracing/TraceMetadata.java

View file


Open in desktop

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

package com.palantir.tracing;

import java.util.Optional;
import org.immutables.value.Value;

/** Ids necessary to write headers onto network requests. */
@Value.Immutable
@Value.Style(visibility = Value.Style.ImplementationVisibility.PACKAGE)
interface TraceMetadata {

 /** Corresponds to {@link com.palantir.tracing.api.TraceHttpHeaders#TRACE_ID}. */
 String traceId();

 /** Corresponds to {@link com.palantir.tracing.api.TraceHttpHeaders#SPAN_ID}. */
 String spanId();

 /** Corresponds to {@link com.palantir.tracing.api.TraceHttpHeaders#PARENT_SPAN_ID}. */
 Optional<String> parentSpanId();

 /** Corresponds to {@link com.palantir.tracing.api.TraceHttpHeaders#ORIGINATING_SPAN_ID}. */
 Optional<String> originatingSpanId();

 static Builder builder() {
 return new Builder();
 }

 class Builder extends ImmutableTraceMetadata.Builder {}
}

72 changes: 41 additions & 31 deletions
tracing/src/main/java/com/palantir/tracing/Tracer.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,7 @@
import com.palantir.logsafe.SafeArg;
import com.palantir.logsafe.UnsafeArg;
import com.palantir.logsafe.exceptions.SafeIllegalArgumentException;
import com.palantir.logsafe.exceptions.SafeRuntimeException;
import com.palantir.tracing.api.OpenSpan;
import com.palantir.tracing.api.Span;
import com.palantir.tracing.api.SpanObserver;
Expand DownExpand Up@@ -89,6 +90,32 @@ private static boolean shouldObserve(Observability observability) {
 throw new SafeIllegalArgumentException("Unknown observability", SafeArg.of("observability", observability));
 }

 static TraceMetadata getTraceMetadata() {
 Trace trace = checkNotNull(currentTrace.get(), "Unable to getTraceMetadata when there is trace in progress");

 if (trace.isObservable()) {
 OpenSpan openSpan = trace.top()
 .orElseThrow(() -> new SafeRuntimeException("Trace with no spans in progress"));
 return TraceMetadata.builder()
 .spanId(openSpan.getSpanId())
 .parentSpanId(openSpan.getParentSpanId())
 .originatingSpanId(trace.getOriginatingSpanId())
 .traceId(trace.getTraceId())
 .build();
 } else {
 // In the unsampled case, the Trace.Unsampled class doesn't actually store a spanId/parentSpanId
 // stack, so we just make one up (just in time). This matches the behaviour of Tracer#startSpan.

 // n.b. this is a bit funky because calling getTraceMetadata multiple times will return different spanIds
 return TraceMetadata.builder()
 .spanId(Tracers.randomId())
 .parentSpanId(Optional.empty())
 .originatingSpanId(trace.getOriginatingSpanId())
 .traceId(trace.getTraceId())
 .build();
 }
 }

 /**
 * Deprecated.
 *
Expand DownExpand Up@@ -207,8 +234,8 @@ public CloseableSpan childSpan(String operationName, SpanType type) {
 warnIfCompleted("startSpanOnCurrentThread");
 Trace maybeCurrentTrace = currentTrace.get();
 setTrace(Trace.of(true, traceId));
OpenSpan newSpan = Tracer.startSpan(operationName, openSpan.getSpanId(), type);
 return TraceRestoringCloseableSpan.of(maybeCurrentTrace, newSpan);
 Tracer.fastStartSpan(operationName, openSpan.getSpanId(), type);
 return TraceRestoringCloseableSpan.of(maybeCurrentTrace);
 }

 @Override
Expand DownExpand Up@@ -251,8 +278,8 @@ private static final class UnsampledDetachedSpan implements DetachedSpan {
 public CloseableSpan childSpan(String operationName, SpanType type) {
 Trace maybeCurrentTrace = currentTrace.get();
 setTrace(Trace.of(false, traceId));
OpenSpan newSpan = Tracer.startSpan(operationName, type);
 return TraceRestoringCloseableSpan.of(maybeCurrentTrace, newSpan);
 Tracer.fastStartSpan(operationName, type);
 return TraceRestoringCloseableSpan.of(maybeCurrentTrace);
 }

 @Override
Expand All@@ -273,40 +300,23 @@ public String toString() {

 private static final class TraceRestoringCloseableSpan implements CloseableSpan {

 @Nullable
 private final Trace traceToRestore;
 private final OpenSpan newSpan;

 TraceRestoringCloseableSpan(@Nullable Trace traceToRestore, OpenSpan newSpan) {
 this.traceToRestore = traceToRestore;
 this.newSpan = Preconditions.checkNotNull(newSpan, "OpenSpan");
 }

 public static CloseableSpan of(@Nullable Trace traceToRestore, OpenSpan newSpan) {
 return new TraceRestoringCloseableSpan(traceToRestore, newSpan);
 }
 // Complete the current span.
 private static final CloseableSpan DEFAULT_TOKEN = Tracer::fastCompleteSpan;

 @Override
 public void close() {
 Tracer.fastCompleteSpan();
 if (traceToRestore != null) {
 Tracer.setTrace(traceToRestore);
 }
 }
 private final Trace original;

 @Override
 public String getSpanId() {
 return newSpan.getSpanId();
 static CloseableSpan of(@Nullable Trace original) {
 return original == null ? DEFAULT_TOKEN : new TraceRestoringCloseableSpan(original);
 }

 @Override
 public Optional<String> getParentSpanId() {
 return newSpan.getParentSpanId();
 TraceRestoringCloseableSpan(Trace original) {
 this.original = Preconditions.checkNotNull(original, "Expected an original trace instance");
 }

 @Override
 public Optional<String> getOriginatingSpanId() {
 return newSpan.getOriginatingSpanId();
 public void close() {
 DEFAULT_TOKEN.close();
 Tracer.setTrace(original);
 }
 }

Expand Down

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

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

iamdanfox
merged 5 commits into

from

Sep 4, 2019
 Merged


Tracer#getTraceMetadata [into ckozak/detached_tracing_api]
#249
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
a8f6c76

Revert "CloseableSpan exposes ids necessary to set headers"


iamdanfox Sep 4, 2019
1d03066

Tracer#getTraceMetadata


iamdanfox Sep 4, 2019
cc77f82

parentSpanId is empty


iamdanfox Sep 4, 2019
b700633

nit


iamdanfox Sep 4, 2019
b54a116

Update tracing/src/main/java/com/palantir/tracing/Tracer.java


iamdanfox Sep 4, 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


7 changes: 0 additions & 7 deletions
tracing/src/main/java/com/palantir/tracing/CloseableSpan.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,6 @@
package com.palantir.tracing;

import java.io.Closeable;
import java.util.Optional;

/**
 * Closeable marker around a tracing span operation. This object should be used in a try/with block.
Expand All@@ -31,10 +30,4 @@ public interface CloseableSpan extends Closeable {
 */
 @Override
 void close();

 String getSpanId();

 Optional<String> getParentSpanId();

 Optional<String> getOriginatingSpanId();
}

44 changes: 44 additions & 0 deletions
tracing/src/main/java/com/palantir/tracing/TraceMetadata.java

View file


Open in desktop

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

package com.palantir.tracing;

import java.util.Optional;
import org.immutables.value.Value;

/** Ids necessary to write headers onto network requests. */
@Value.Immutable
@Value.Style(visibility = Value.Style.ImplementationVisibility.PACKAGE)
interface TraceMetadata {

 /** Corresponds to {@link com.palantir.tracing.api.TraceHttpHeaders#TRACE_ID}. */
 String traceId();

 /** Corresponds to {@link com.palantir.tracing.api.TraceHttpHeaders#SPAN_ID}. */
 String spanId();

 /** Corresponds to {@link com.palantir.tracing.api.TraceHttpHeaders#PARENT_SPAN_ID}. */
 Optional<String> parentSpanId();

 /** Corresponds to {@link com.palantir.tracing.api.TraceHttpHeaders#ORIGINATING_SPAN_ID}. */
 Optional<String> originatingSpanId();

 static Builder builder() {
 return new Builder();
 }

 class Builder extends ImmutableTraceMetadata.Builder {}
}

72 changes: 41 additions & 31 deletions
tracing/src/main/java/com/palantir/tracing/Tracer.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,7 @@
import com.palantir.logsafe.SafeArg;
import com.palantir.logsafe.UnsafeArg;
import com.palantir.logsafe.exceptions.SafeIllegalArgumentException;
import com.palantir.logsafe.exceptions.SafeRuntimeException;
import com.palantir.tracing.api.OpenSpan;
import com.palantir.tracing.api.Span;
import com.palantir.tracing.api.SpanObserver;
Expand DownExpand Up@@ -89,6 +90,32 @@ private static boolean shouldObserve(Observability observability) {
 throw new SafeIllegalArgumentException("Unknown observability", SafeArg.of("observability", observability));
 }

 static TraceMetadata getTraceMetadata() {
 Trace trace = checkNotNull(currentTrace.get(), "Unable to getTraceMetadata when there is trace in progress");

 if (trace.isObservable()) {
 OpenSpan openSpan = trace.top()
 .orElseThrow(() -> new SafeRuntimeException("Trace with no spans in progress"));
 return TraceMetadata.builder()
 .spanId(openSpan.getSpanId())
 .parentSpanId(openSpan.getParentSpanId())
 .originatingSpanId(trace.getOriginatingSpanId())
 .traceId(trace.getTraceId())
 .build();
 } else {
 // In the unsampled case, the Trace.Unsampled class doesn't actually store a spanId/parentSpanId
 // stack, so we just make one up (just in time). This matches the behaviour of Tracer#startSpan.

 // n.b. this is a bit funky because calling getTraceMetadata multiple times will return different spanIds
 return TraceMetadata.builder()
 .spanId(Tracers.randomId())
 .parentSpanId(Optional.empty())
 .originatingSpanId(trace.getOriginatingSpanId())
 .traceId(trace.getTraceId())
 .build();
 }
 }

 /**
 * Deprecated.
 *
Expand DownExpand Up@@ -207,8 +234,8 @@ public CloseableSpan childSpan(String operationName, SpanType type) {
 warnIfCompleted("startSpanOnCurrentThread");
 Trace maybeCurrentTrace = currentTrace.get();
 setTrace(Trace.of(true, traceId));
OpenSpan newSpan = Tracer.startSpan(operationName, openSpan.getSpanId(), type);
 return TraceRestoringCloseableSpan.of(maybeCurrentTrace, newSpan);
 Tracer.fastStartSpan(operationName, openSpan.getSpanId(), type);
 return TraceRestoringCloseableSpan.of(maybeCurrentTrace);
 }

 @Override
Expand DownExpand Up@@ -251,8 +278,8 @@ private static final class UnsampledDetachedSpan implements DetachedSpan {
 public CloseableSpan childSpan(String operationName, SpanType type) {
 Trace maybeCurrentTrace = currentTrace.get();
 setTrace(Trace.of(false, traceId));
OpenSpan newSpan = Tracer.startSpan(operationName, type);
 return TraceRestoringCloseableSpan.of(maybeCurrentTrace, newSpan);
 Tracer.fastStartSpan(operationName, type);
 return TraceRestoringCloseableSpan.of(maybeCurrentTrace);
 }

 @Override
Expand All@@ -273,40 +300,23 @@ public String toString() {

 private static final class TraceRestoringCloseableSpan implements CloseableSpan {

 @Nullable
 private final Trace traceToRestore;
 private final OpenSpan newSpan;

 TraceRestoringCloseableSpan(@Nullable Trace traceToRestore, OpenSpan newSpan) {
 this.traceToRestore = traceToRestore;
 this.newSpan = Preconditions.checkNotNull(newSpan, "OpenSpan");
 }

 public static CloseableSpan of(@Nullable Trace traceToRestore, OpenSpan newSpan) {
 return new TraceRestoringCloseableSpan(traceToRestore, newSpan);
 }
 // Complete the current span.
 private static final CloseableSpan DEFAULT_TOKEN = Tracer::fastCompleteSpan;

 @Override
 public void close() {
 Tracer.fastCompleteSpan();
 if (traceToRestore != null) {
 Tracer.setTrace(traceToRestore);
 }
 }
 private final Trace original;

 @Override
 public String getSpanId() {
 return newSpan.getSpanId();
 static CloseableSpan of(@Nullable Trace original) {
 return original == null ? DEFAULT_TOKEN : new TraceRestoringCloseableSpan(original);
 }

 @Override
 public Optional<String> getParentSpanId() {
 return newSpan.getParentSpanId();
 TraceRestoringCloseableSpan(Trace original) {
 this.original = Preconditions.checkNotNull(original, "Expected an original trace instance");
 }

 @Override
 public Optional<String> getOriginatingSpanId() {
 return newSpan.getOriginatingSpanId();
 public void close() {
 DEFAULT_TOKEN.close();
 Tracer.setTrace(original);
 }
 }

Expand Down

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

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

iamdanfox
merged 5 commits into

from

Sep 4, 2019
 Merged


Tracer#getTraceMetadata [into ckozak/detached_tracing_api]
#249
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
a8f6c76

Revert "CloseableSpan exposes ids necessary to set headers"


iamdanfox Sep 4, 2019
1d03066

Tracer#getTraceMetadata


iamdanfox Sep 4, 2019
cc77f82

parentSpanId is empty


iamdanfox Sep 4, 2019
b700633

nit


iamdanfox Sep 4, 2019
b54a116

Update tracing/src/main/java/com/palantir/tracing/Tracer.java


iamdanfox Sep 4, 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


7 changes: 0 additions & 7 deletions
tracing/src/main/java/com/palantir/tracing/CloseableSpan.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,6 @@
package com.palantir.tracing;

import java.io.Closeable;
import java.util.Optional;

/**
 * Closeable marker around a tracing span operation. This object should be used in a try/with block.
Expand All@@ -31,10 +30,4 @@ public interface CloseableSpan extends Closeable {
 */
 @Override
 void close();

 String getSpanId();

 Optional<String> getParentSpanId();

 Optional<String> getOriginatingSpanId();
}

44 changes: 44 additions & 0 deletions
tracing/src/main/java/com/palantir/tracing/TraceMetadata.java

View file


Open in desktop

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

package com.palantir.tracing;

import java.util.Optional;
import org.immutables.value.Value;

/** Ids necessary to write headers onto network requests. */
@Value.Immutable
@Value.Style(visibility = Value.Style.ImplementationVisibility.PACKAGE)
interface TraceMetadata {

 /** Corresponds to {@link com.palantir.tracing.api.TraceHttpHeaders#TRACE_ID}. */
 String traceId();

 /** Corresponds to {@link com.palantir.tracing.api.TraceHttpHeaders#SPAN_ID}. */
 String spanId();

 /** Corresponds to {@link com.palantir.tracing.api.TraceHttpHeaders#PARENT_SPAN_ID}. */
 Optional<String> parentSpanId();

 /** Corresponds to {@link com.palantir.tracing.api.TraceHttpHeaders#ORIGINATING_SPAN_ID}. */
 Optional<String> originatingSpanId();

 static Builder builder() {
 return new Builder();
 }

 class Builder extends ImmutableTraceMetadata.Builder {}
}

72 changes: 41 additions & 31 deletions
tracing/src/main/java/com/palantir/tracing/Tracer.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,7 @@
import com.palantir.logsafe.SafeArg;
import com.palantir.logsafe.UnsafeArg;
import com.palantir.logsafe.exceptions.SafeIllegalArgumentException;
import com.palantir.logsafe.exceptions.SafeRuntimeException;
import com.palantir.tracing.api.OpenSpan;
import com.palantir.tracing.api.Span;
import com.palantir.tracing.api.SpanObserver;
Expand DownExpand Up@@ -89,6 +90,32 @@ private static boolean shouldObserve(Observability observability) {
 throw new SafeIllegalArgumentException("Unknown observability", SafeArg.of("observability", observability));
 }

 static TraceMetadata getTraceMetadata() {
 Trace trace = checkNotNull(currentTrace.get(), "Unable to getTraceMetadata when there is trace in progress");

 if (trace.isObservable()) {
 OpenSpan openSpan = trace.top()
 .orElseThrow(() -> new SafeRuntimeException("Trace with no spans in progress"));
 return TraceMetadata.builder()
 .spanId(openSpan.getSpanId())
 .parentSpanId(openSpan.getParentSpanId())
 .originatingSpanId(trace.getOriginatingSpanId())
 .traceId(trace.getTraceId())
 .build();
 } else {
 // In the unsampled case, the Trace.Unsampled class doesn't actually store a spanId/parentSpanId
 // stack, so we just make one up (just in time). This matches the behaviour of Tracer#startSpan.

 // n.b. this is a bit funky because calling getTraceMetadata multiple times will return different spanIds
 return TraceMetadata.builder()
 .spanId(Tracers.randomId())
 .parentSpanId(Optional.empty())
 .originatingSpanId(trace.getOriginatingSpanId())
 .traceId(trace.getTraceId())
 .build();
 }
 }

 /**
 * Deprecated.
 *
Expand DownExpand Up@@ -207,8 +234,8 @@ public CloseableSpan childSpan(String operationName, SpanType type) {
 warnIfCompleted("startSpanOnCurrentThread");
 Trace maybeCurrentTrace = currentTrace.get();
 setTrace(Trace.of(true, traceId));
OpenSpan newSpan = Tracer.startSpan(operationName, openSpan.getSpanId(), type);
 return TraceRestoringCloseableSpan.of(maybeCurrentTrace, newSpan);
 Tracer.fastStartSpan(operationName, openSpan.getSpanId(), type);
 return TraceRestoringCloseableSpan.of(maybeCurrentTrace);
 }

 @Override
Expand DownExpand Up@@ -251,8 +278,8 @@ private static final class UnsampledDetachedSpan implements DetachedSpan {
 public CloseableSpan childSpan(String operationName, SpanType type) {
 Trace maybeCurrentTrace = currentTrace.get();
 setTrace(Trace.of(false, traceId));
OpenSpan newSpan = Tracer.startSpan(operationName, type);
 return TraceRestoringCloseableSpan.of(maybeCurrentTrace, newSpan);
 Tracer.fastStartSpan(operationName, type);
 return TraceRestoringCloseableSpan.of(maybeCurrentTrace);
 }

 @Override
Expand All@@ -273,40 +300,23 @@ public String toString() {

 private static final class TraceRestoringCloseableSpan implements CloseableSpan {

 @Nullable
 private final Trace traceToRestore;
 private final OpenSpan newSpan;

 TraceRestoringCloseableSpan(@Nullable Trace traceToRestore, OpenSpan newSpan) {
 this.traceToRestore = traceToRestore;
 this.newSpan = Preconditions.checkNotNull(newSpan, "OpenSpan");
 }

 public static CloseableSpan of(@Nullable Trace traceToRestore, OpenSpan newSpan) {
 return new TraceRestoringCloseableSpan(traceToRestore, newSpan);
 }
 // Complete the current span.
 private static final CloseableSpan DEFAULT_TOKEN = Tracer::fastCompleteSpan;

 @Override
 public void close() {
 Tracer.fastCompleteSpan();
 if (traceToRestore != null) {
 Tracer.setTrace(traceToRestore);
 }
 }
 private final Trace original;

 @Override
 public String getSpanId() {
 return newSpan.getSpanId();
 static CloseableSpan of(@Nullable Trace original) {
 return original == null ? DEFAULT_TOKEN : new TraceRestoringCloseableSpan(original);
 }

 @Override
 public Optional<String> getParentSpanId() {
 return newSpan.getParentSpanId();
 TraceRestoringCloseableSpan(Trace original) {
 this.original = Preconditions.checkNotNull(original, "Expected an original trace instance");
 }

 @Override
 public Optional<String> getOriginatingSpanId() {
 return newSpan.getOriginatingSpanId();
 public void close() {
 DEFAULT_TOKEN.close();
 Tracer.setTrace(original);
 }
 }

Expand Down