open-telemetry
/
opentelemetry-java-instrumentation
mirror of https://github.com/open-telemetry/opentelemetry-java-instrumentation.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Extract logic for bridging recognized context keys (#3547) 

* Extract logic for bridging recognized context keys

* Moar

* Not private

* Not private

* Style
This commit is contained in:
Anuraag Agrawal 2021-07-14 08:24:36 +09:00 committed by GitHub
parent 9219fb6067
commit 2e5505b872
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 98 additions and 96 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
gradle/enforcement/checkstyle.xml
View File

@ -227,7 +227,7 @@
value="Class type name ''{0}'' must match pattern ''{1}''."/> value="Class type name ''{0}'' must match pattern ''{1}''."/>
</module> </module>
<module name="RecordTypeParameterName"> <module name="RecordTypeParameterName">
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/> <property name="format" value="^[A-Z]+[0-9]?$"/>
<message key="name.invalidPattern" <message key="name.invalidPattern"
value="Record type name ''{0}'' must match pattern ''{1}''."/> value="Record type name ''{0}'' must match pattern ''{1}''."/>
</module> </module>

190
instrumentation/opentelemetry-api-1.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/opentelemetryapi/context/AgentContextStorage.java
View File

@ -14,6 +14,7 @@ import application.io.opentelemetry.context.Scope;
import io.opentelemetry.javaagent.instrumentation.opentelemetryapi.baggage.BaggageBridging; import io.opentelemetry.javaagent.instrumentation.opentelemetryapi.baggage.BaggageBridging;
import io.opentelemetry.javaagent.instrumentation.opentelemetryapi.trace.Bridging; import io.opentelemetry.javaagent.instrumentation.opentelemetryapi.trace.Bridging;
import java.lang.reflect.Field; import java.lang.reflect.Field;
import java.util.function.Function;
import org.checkerframework.checker.nullness.qual.Nullable; import org.checkerframework.checker.nullness.qual.Nullable;
import org.slf4j.Logger; import org.slf4j.Logger;
import org.slf4j.LoggerFactory; import org.slf4j.LoggerFactory;
@ -59,66 +60,19 @@ public class AgentContextStorage implements ContextStorage, AutoCloseable {
static final io.opentelemetry.context.ContextKey<Context> APPLICATION_CONTEXT = static final io.opentelemetry.context.ContextKey<Context> APPLICATION_CONTEXT =
io.opentelemetry.context.ContextKey.named("otel-context"); io.opentelemetry.context.ContextKey.named("otel-context");
static final io.opentelemetry.context.ContextKey<io.opentelemetry.api.trace.Span> static final ContextKeyBridge<?, ?>[] CONTEXT_KEY_BRIDGES =
AGENT_SPAN_CONTEXT_KEY; new ContextKeyBridge[] {
@Nullable static final ContextKey<Span> APPLICATION_SPAN_CONTEXT_KEY; new ContextKeyBridge<Span, io.opentelemetry.api.trace.Span>(
"application.io.opentelemetry.api.trace.SpanContextKey",
static final io.opentelemetry.context.ContextKey<io.opentelemetry.api.baggage.Baggage> "io.opentelemetry.api.trace.SpanContextKey",
AGENT_BAGGAGE_CONTEXT_KEY; Bridging::toApplication,
@Nullable static final ContextKey<Baggage> APPLICATION_BAGGAGE_CONTEXT_KEY; Bridging::toAgentOrNull),
new ContextKeyBridge<>(
static { "application.io.opentelemetry.api.baggage.BaggageContextKey",
io.opentelemetry.context.ContextKey<io.opentelemetry.api.trace.Span> agentSpanContextKey; "io.opentelemetry.api.baggage.BaggageContextKey",
try { BaggageBridging::toApplication,
Class<?> spanContextKey = Class.forName("io.opentelemetry.api.trace.SpanContextKey"); BaggageBridging::toAgent),
Field spanContextKeyField = spanContextKey.getDeclaredField("KEY"); };
spanContextKeyField.setAccessible(true);
agentSpanContextKey =
(io.opentelemetry.context.ContextKey<io.opentelemetry.api.trace.Span>)
spanContextKeyField.get(null);
} catch (Throwable t) {
agentSpanContextKey = null;
}
AGENT_SPAN_CONTEXT_KEY = agentSpanContextKey;
ContextKey<Span> applicationSpanContextKey;
try {
Class<?> spanContextKey =
Class.forName("application.io.opentelemetry.api.trace.SpanContextKey");
Field spanContextKeyField = spanContextKey.getDeclaredField("KEY");
spanContextKeyField.setAccessible(true);
applicationSpanContextKey = (ContextKey<Span>) spanContextKeyField.get(null);
} catch (Throwable t) {
applicationSpanContextKey = null;
}
APPLICATION_SPAN_CONTEXT_KEY = applicationSpanContextKey;
io.opentelemetry.context.ContextKey<io.opentelemetry.api.baggage.Baggage>
agentBaggageContextKey;
try {
Class<?> baggageContextKey = Class.forName("io.opentelemetry.api.baggage.BaggageContextKey");
Field baggageContextKeyField = baggageContextKey.getDeclaredField("KEY");
baggageContextKeyField.setAccessible(true);
agentBaggageContextKey =
(io.opentelemetry.context.ContextKey<io.opentelemetry.api.baggage.Baggage>)
baggageContextKeyField.get(null);
} catch (Throwable t) {
agentBaggageContextKey = null;
}
AGENT_BAGGAGE_CONTEXT_KEY = agentBaggageContextKey;
ContextKey<Baggage> applicationBaggageContextKey;
try {
Class<?> baggageContextKey =
Class.forName("application.io.opentelemetry.api.baggage.BaggageContextKey");
Field baggageContextKeyField = baggageContextKey.getDeclaredField("KEY");
baggageContextKeyField.setAccessible(true);
applicationBaggageContextKey = (ContextKey<Baggage>) baggageContextKeyField.get(null);
} catch (Throwable t) {
applicationBaggageContextKey = null;
}
APPLICATION_BAGGAGE_CONTEXT_KEY = applicationBaggageContextKey;
}
@Override @Override
public Scope attach(Context toAttach) { public Scope attach(Context toAttach) {
@ -163,8 +117,8 @@ public class AgentContextStorage implements ContextStorage, AutoCloseable {
} }
private static class AgentContextWrapper implements Context { private static class AgentContextWrapper implements Context {
private final io.opentelemetry.context.Context agentContext; final io.opentelemetry.context.Context agentContext;
private final Context applicationContext; final Context applicationContext;
AgentContextWrapper(io.opentelemetry.context.Context agentContext, Context applicationContext) { AgentContextWrapper(io.opentelemetry.context.Context agentContext, Context applicationContext) {
this.agentContext = agentContext; this.agentContext = agentContext;
@ -180,47 +134,23 @@ public class AgentContextStorage implements ContextStorage, AutoCloseable {
@Override @Override
public <V> V get(ContextKey<V> key) { public <V> V get(ContextKey<V> key) {
if (key == APPLICATION_SPAN_CONTEXT_KEY) { for (ContextKeyBridge<?, ?> bridge : CONTEXT_KEY_BRIDGES) {
io.opentelemetry.api.trace.Span agentSpan = agentContext.get(AGENT_SPAN_CONTEXT_KEY); V value = bridge.get(this, key);
if (agentSpan == null) { if (value != null) {
return null;
}
Span applicationSpan = Bridging.toApplication(agentSpan);
@SuppressWarnings("unchecked")
V value = (V) applicationSpan;
return value; return value;
} }
if (key == APPLICATION_BAGGAGE_CONTEXT_KEY) {
io.opentelemetry.api.baggage.Baggage agentBaggage =
agentContext.get(AGENT_BAGGAGE_CONTEXT_KEY);
if (agentBaggage == null) {
return null;
}
Baggage applicationBaggage = BaggageBridging.toApplication(agentBaggage);
@SuppressWarnings("unchecked")
V value = (V) applicationBaggage;
return value;
} }
return applicationContext.get(key); return applicationContext.get(key);
} }
@Override @Override
public <V> Context with(ContextKey<V> k1, V v1) { public <V> Context with(ContextKey<V> k1, V v1) {
if (k1 == APPLICATION_SPAN_CONTEXT_KEY) { for (ContextKeyBridge<?, ?> bridge : CONTEXT_KEY_BRIDGES) {
Span applicationSpan = (Span) v1; Context context = bridge.with(this, k1, v1);
io.opentelemetry.api.trace.Span agentSpan = Bridging.toAgentOrNull(applicationSpan); if (context != null) {
if (agentSpan == null) { return context;
return this;
} }
return new AgentContextWrapper(
agentContext.with(AGENT_SPAN_CONTEXT_KEY, agentSpan), applicationContext);
}
if (k1 == APPLICATION_BAGGAGE_CONTEXT_KEY) {
Baggage applicationBaggage = (Baggage) v1;
io.opentelemetry.api.baggage.Baggage agentBaggage =
BaggageBridging.toAgent(applicationBaggage);
return new AgentContextWrapper(
agentContext.with(AGENT_BAGGAGE_CONTEXT_KEY, agentBaggage), applicationContext);
} }
return new AgentContextWrapper(agentContext, applicationContext.with(k1, v1)); return new AgentContextWrapper(agentContext, applicationContext.with(k1, v1));
} }
@ -230,4 +160,76 @@ public class AgentContextStorage implements ContextStorage, AutoCloseable {
return "{agentContext=" + agentContext + ", applicationContext=" + applicationContext + "}"; return "{agentContext=" + agentContext + ", applicationContext=" + applicationContext + "}";
} }
} }
static class ContextKeyBridge<APPLICATION, AGENT> {
private final ContextKey<APPLICATION> applicationContextKey;
private final io.opentelemetry.context.ContextKey<AGENT> agentContextKey;
private final Function<APPLICATION, AGENT> toAgent;
private final Function<AGENT, APPLICATION> toApplication;
@SuppressWarnings("unchecked")
ContextKeyBridge(
String applicationKeyHolderClassName,
String agentKeyHolderClassName,
Function<AGENT, APPLICATION> toApplication,
Function<APPLICATION, AGENT> toAgent) {
this.toApplication = toApplication;
this.toAgent = toAgent;
ContextKey<APPLICATION> applicationContextKey;
try {
Class<?> applicationKeyHolderClass = Class.forName(applicationKeyHolderClassName);
Field applicationContextKeyField = applicationKeyHolderClass.getDeclaredField("KEY");
applicationContextKeyField.setAccessible(true);
applicationContextKey = (ContextKey<APPLICATION>) applicationContextKeyField.get(null);
} catch (Throwable t) {
applicationContextKey = null;
}
this.applicationContextKey = applicationContextKey;
io.opentelemetry.context.ContextKey<AGENT> agentContextKey;
try {
Class<?> agentKeyHolderClass = Class.forName(agentKeyHolderClassName);
Field agentContextKeyField = agentKeyHolderClass.getDeclaredField("KEY");
agentContextKeyField.setAccessible(true);
agentContextKey =
(io.opentelemetry.context.ContextKey<AGENT>) agentContextKeyField.get(null);
} catch (Throwable t) {
agentContextKey = null;
}
this.agentContextKey = agentContextKey;
}
@Nullable
<V> V get(AgentContextWrapper contextWrapper, ContextKey<V> requestedKey) {
if (requestedKey == applicationContextKey) {
AGENT agentValue = contextWrapper.agentContext.get(agentContextKey);
if (agentValue == null) {
return null;
}
APPLICATION applicationValue = toApplication.apply(agentValue);
@SuppressWarnings("unchecked")
V castValue = (V) applicationValue;
return castValue;
}
return null;
}
@Nullable
<V> Context with(AgentContextWrapper contextWrapper, ContextKey<V> requestedKey, V value) {
if (requestedKey == applicationContextKey) {
@SuppressWarnings("unchecked")
APPLICATION applicationValue = (APPLICATION) value;
AGENT agentValue = toAgent.apply(applicationValue);
if (agentValue == null) {
return contextWrapper;
}
return new AgentContextWrapper(
contextWrapper.agentContext.with(agentContextKey, agentValue),
contextWrapper.applicationContext);
}
return null;
}
}
} }