Skip to content
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.

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

Optionally add baggage to span attributes #8023

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
package io.opentelemetry.javaagent.tooling;

import io.opentelemetry.api.baggage.Baggage;
import io.opentelemetry.context.Context;
import io.opentelemetry.sdk.trace.ReadWriteSpan;

public class AddBaggageSpanProcessor implements OnStartSpanProcessor {
@Override
public void onStart(Context context, ReadWriteSpan span) {
Baggage baggage = Baggage.fromContext(context);
baggage.forEach(
(key, value) ->
span.setAttribute(
// add prefix to key to not override existing attributes
"baggage." + key,
value.getValue()));
Copy link

Choose a reason for hiding this comment

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

Given the lack of spec around this topic, it would be good to keep the attribute naming flexible and have the baggage namespace prefix come in through the constructor as an optional parameter. The suggested whitelisting of baggage keys to attach would provide the necessary security to prevent unwanted overrides.

}
}
Original file line number Diff line number Diff line change
Expand Up @@ -6,41 +6,15 @@
package io.opentelemetry.javaagent.tooling;

import io.opentelemetry.context.Context;
import io.opentelemetry.sdk.common.CompletableResultCode;
import io.opentelemetry.sdk.trace.ReadWriteSpan;
import io.opentelemetry.sdk.trace.ReadableSpan;
import io.opentelemetry.sdk.trace.SpanProcessor;
import io.opentelemetry.semconv.trace.attributes.SemanticAttributes;

public class AddThreadDetailsSpanProcessor implements SpanProcessor {
public class AddThreadDetailsSpanProcessor implements OnStartSpanProcessor {

@Override
public void onStart(Context context, ReadWriteSpan span) {
Thread currentThread = Thread.currentThread();
span.setAttribute(SemanticAttributes.THREAD_ID, currentThread.getId());
span.setAttribute(SemanticAttributes.THREAD_NAME, currentThread.getName());
}

@Override
public boolean isStartRequired() {
return true;
}

@Override
public void onEnd(ReadableSpan span) {}

@Override
public boolean isEndRequired() {
return false;
}

@Override
public CompletableResultCode shutdown() {
return CompletableResultCode.ofSuccess();
}

@Override
public CompletableResultCode forceFlush() {
return CompletableResultCode.ofSuccess();
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
@AutoService(AutoConfigurationCustomizerProvider.class)
public class AgentTracerProviderConfigurer implements AutoConfigurationCustomizerProvider {
private static final String ADD_THREAD_DETAILS = "otel.javaagent.add-thread-details";
private static final String ADD_BAGGAGE = "otel.javaagent.span.add-baggage";
Copy link
Member

Choose a reason for hiding this comment

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

this would correspond with, e.g. otel.traces.exporter, otel.metrics.exporter, otel.logs.exporter

Suggested change
private static final String ADD_BAGGAGE = "otel.javaagent.span.add-baggage";
private static final String ADD_BAGGAGE = "otel.javaagent.traces.add-baggage";


@Override
public void customize(AutoConfigurationCustomizer autoConfigurationCustomizer) {
Expand All @@ -38,6 +39,11 @@ private static SdkTracerProviderBuilder configure(
sdkTracerProviderBuilder.addSpanProcessor(new AddThreadDetailsSpanProcessor());
}

// Register baggage adding span processor if config value is set
if (config.getBoolean(ADD_BAGGAGE, false)) {
sdkTracerProviderBuilder.addSpanProcessor(new AddBaggageSpanProcessor());
}

maybeEnableLoggingExporter(sdkTracerProviderBuilder, config);

return sdkTracerProviderBuilder;
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
package io.opentelemetry.javaagent.tooling;

import io.opentelemetry.sdk.common.CompletableResultCode;
import io.opentelemetry.sdk.trace.ReadableSpan;
import io.opentelemetry.sdk.trace.SpanProcessor;

public interface OnStartSpanProcessor extends SpanProcessor {
@Override
default boolean isStartRequired() {
return true;
}

@Override
default void onEnd(ReadableSpan span) {}

@Override
default boolean isEndRequired() {
return false;
}

@Override
default CompletableResultCode shutdown() {
return CompletableResultCode.ofSuccess();
}

@Override
default CompletableResultCode forceFlush() {
return CompletableResultCode.ofSuccess();
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
package io.opentelemetry.javaagent.tooling;

import static org.mockito.Mockito.verify;

import io.opentelemetry.api.baggage.Baggage;
import io.opentelemetry.context.Context;
import io.opentelemetry.context.Scope;
import io.opentelemetry.sdk.trace.ReadWriteSpan;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension;

@ExtendWith(MockitoExtension.class)
class AddBaggageSpanProcessorTest {
@Mock ReadWriteSpan readWriteSpan;

@Test
void shouldAddBaggageToSpanWithPrefixedKeysWhenBaggageIsPopulated() {
try (Scope unused = Baggage.builder().put("someKey", "someValue").build().makeCurrent()) {
new AddBaggageSpanProcessor().onStart(Context.current(), readWriteSpan);
}

verify(readWriteSpan).setAttribute("baggage.someKey", "someValue");
}
}