forked from apache/skywalking
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request apache#709 from ascrutae/fix/okhttp-plugin-issue
[Agent] Adjust the buired point of okhttp plugin
- Loading branch information
Showing
7 changed files
with
252 additions
and
43 deletions.
There are no files selected for viewing
103 changes: 103 additions & 0 deletions
103
...plugin/src/main/java/org/apache/skywalking/apm/plugin/okhttp/v3/AsyncCallInterceptor.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to You 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 org.apache.skywalking.apm.plugin.okhttp.v3; | ||
|
|
||
| import java.lang.reflect.Field; | ||
| import java.lang.reflect.Method; | ||
| import java.lang.reflect.Modifier; | ||
| import okhttp3.Headers; | ||
| import okhttp3.HttpUrl; | ||
| import okhttp3.Request; | ||
| import org.apache.skywalking.apm.agent.core.context.CarrierItem; | ||
| import org.apache.skywalking.apm.agent.core.context.ContextCarrier; | ||
| import org.apache.skywalking.apm.agent.core.context.ContextManager; | ||
| import org.apache.skywalking.apm.agent.core.context.tag.Tags; | ||
| import org.apache.skywalking.apm.agent.core.context.trace.AbstractSpan; | ||
| import org.apache.skywalking.apm.agent.core.context.trace.SpanLayer; | ||
| import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.EnhancedInstance; | ||
| import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.InstanceConstructorInterceptor; | ||
| import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.InstanceMethodsAroundInterceptor; | ||
| import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.MethodInterceptResult; | ||
| import org.apache.skywalking.apm.network.trace.component.ComponentsDefine; | ||
|
|
||
| /** | ||
| * {@link AsyncCallInterceptor} get the `EnhanceRequiredInfo` instance from `SkyWalkingDynamicField` and then put it | ||
| * into `AsyncCall` instance when the `AsyncCall` constructor called. | ||
| * | ||
| * {@link AsyncCallInterceptor} also create an exit span by using the `EnhanceRequiredInfo` when the `execute` method | ||
| * called. | ||
| * | ||
| * @author zhangxin | ||
| */ | ||
| public class AsyncCallInterceptor implements InstanceConstructorInterceptor, InstanceMethodsAroundInterceptor { | ||
| @Override | ||
| public void onConstruct(EnhancedInstance objInst, Object[] allArguments) { | ||
| /** | ||
| * The first argument of constructor is not the `real` parameter when the enhance class is an inner class. This | ||
| * is the JDK compiler mechanism. | ||
| */ | ||
| EnhancedInstance realCallInstance = (EnhancedInstance)allArguments[1]; | ||
| Object enhanceRequireInfo = realCallInstance.getSkyWalkingDynamicField(); | ||
|
|
||
| objInst.setSkyWalkingDynamicField(enhanceRequireInfo); | ||
| } | ||
|
|
||
| @Override | ||
| public void beforeMethod(EnhancedInstance objInst, Method method, Object[] allArguments, Class<?>[] argumentsTypes, | ||
| MethodInterceptResult result) throws Throwable { | ||
| EnhanceRequiredInfo enhanceRequiredInfo = (EnhanceRequiredInfo)objInst.getSkyWalkingDynamicField(); | ||
| Request request = (Request)enhanceRequiredInfo.getRealCallEnhance().getSkyWalkingDynamicField(); | ||
|
|
||
| ContextCarrier contextCarrier = new ContextCarrier(); | ||
| HttpUrl requestUrl = request.url(); | ||
| AbstractSpan span = ContextManager.createExitSpan(requestUrl.uri().getPath(), contextCarrier, requestUrl.host() + ":" + requestUrl.port()); | ||
| span.setComponent(ComponentsDefine.OKHTTP); | ||
| Tags.HTTP.METHOD.set(span, request.method()); | ||
| Tags.URL.set(span, requestUrl.uri().toString()); | ||
| SpanLayer.asHttp(span); | ||
|
|
||
| Field headersField = Request.class.getDeclaredField("headers"); | ||
| Field modifiersField = Field.class.getDeclaredField("modifiers"); | ||
| modifiersField.setAccessible(true); | ||
| modifiersField.setInt(headersField, headersField.getModifiers() & ~Modifier.FINAL); | ||
|
|
||
| headersField.setAccessible(true); | ||
| Headers.Builder headerBuilder = request.headers().newBuilder(); | ||
| CarrierItem next = contextCarrier.items(); | ||
| while (next.hasNext()) { | ||
| next = next.next(); | ||
| headerBuilder.add(next.getHeadKey(), next.getHeadValue()); | ||
| } | ||
| headersField.set(request, headerBuilder.build()); | ||
|
|
||
| ContextManager.continued(enhanceRequiredInfo.getContextSnapshot()); | ||
| } | ||
|
|
||
| @Override | ||
| public Object afterMethod(EnhancedInstance objInst, Method method, Object[] allArguments, Class<?>[] argumentsTypes, | ||
| Object ret) throws Throwable { | ||
| ContextManager.stopSpan(); | ||
| return ret; | ||
| } | ||
|
|
||
| @Override public void handleMethodException(EnhancedInstance objInst, Method method, Object[] allArguments, | ||
| Class<?>[] argumentsTypes, Throwable t) { | ||
| ContextManager.activeSpan().log(t); | ||
| } | ||
| } |
47 changes: 47 additions & 0 deletions
47
...-plugin/src/main/java/org/apache/skywalking/apm/plugin/okhttp/v3/EnhanceRequiredInfo.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to You 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 org.apache.skywalking.apm.plugin.okhttp.v3; | ||
|
|
||
| import org.apache.skywalking.apm.agent.core.context.ContextSnapshot; | ||
| import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.EnhancedInstance; | ||
|
|
||
| /** | ||
| * {@link EnhanceRequiredInfo} storage the `ContextSnapshot` and `RealCall` instances for support the async function of | ||
| * okhttp client. | ||
| * | ||
| * @author zhangxin | ||
| */ | ||
| public class EnhanceRequiredInfo { | ||
| private ContextSnapshot contextSnapshot; | ||
| private EnhancedInstance realCallEnhance; | ||
|
|
||
| public EnhanceRequiredInfo(EnhancedInstance realCallEnhance, | ||
| ContextSnapshot contextSnapshot) { | ||
| this.contextSnapshot = contextSnapshot; | ||
| this.realCallEnhance = realCallEnhance; | ||
| } | ||
|
|
||
| public ContextSnapshot getContextSnapshot() { | ||
| return contextSnapshot; | ||
| } | ||
|
|
||
| public EnhancedInstance getRealCallEnhance() { | ||
| return realCallEnhance; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
69 changes: 69 additions & 0 deletions
69
...main/java/org/apache/skywalking/apm/plugin/okhttp/v3/define/AsyncCallInstrumentation.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to You 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 org.apache.skywalking.apm.plugin.okhttp.v3.define; | ||
|
|
||
| import net.bytebuddy.description.method.MethodDescription; | ||
| import net.bytebuddy.matcher.ElementMatcher; | ||
| import org.apache.skywalking.apm.agent.core.plugin.interceptor.ConstructorInterceptPoint; | ||
| import org.apache.skywalking.apm.agent.core.plugin.interceptor.InstanceMethodsInterceptPoint; | ||
| import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.ClassInstanceMethodsEnhancePluginDefine; | ||
| import org.apache.skywalking.apm.agent.core.plugin.match.ClassMatch; | ||
|
|
||
| import static net.bytebuddy.matcher.ElementMatchers.any; | ||
| import static net.bytebuddy.matcher.ElementMatchers.named; | ||
| import static org.apache.skywalking.apm.agent.core.plugin.match.NameMatch.byName; | ||
|
|
||
| public class AsyncCallInstrumentation extends ClassInstanceMethodsEnhancePluginDefine { | ||
|
|
||
| @Override protected ConstructorInterceptPoint[] getConstructorsInterceptPoints() { | ||
| return new ConstructorInterceptPoint[] { | ||
| new ConstructorInterceptPoint() { | ||
| @Override public ElementMatcher<MethodDescription> getConstructorMatcher() { | ||
| return any(); | ||
| } | ||
|
|
||
| @Override public String getConstructorInterceptor() { | ||
| return "org.apache.skywalking.apm.plugin.okhttp.v3.AsyncCallInterceptor"; | ||
| } | ||
| } | ||
| }; | ||
| } | ||
|
|
||
| @Override protected InstanceMethodsInterceptPoint[] getInstanceMethodsInterceptPoints() { | ||
| return new InstanceMethodsInterceptPoint[] { | ||
| new InstanceMethodsInterceptPoint() { | ||
| @Override public ElementMatcher<MethodDescription> getMethodsMatcher() { | ||
| return named("execute"); | ||
| } | ||
|
|
||
| @Override public String getMethodsInterceptor() { | ||
| return "org.apache.skywalking.apm.plugin.okhttp.v3.AsyncCallInterceptor"; | ||
| } | ||
|
|
||
| @Override public boolean isOverrideArgs() { | ||
| return false; | ||
| } | ||
| } | ||
| }; | ||
| } | ||
|
|
||
| @Override protected ClassMatch enhanceClass() { | ||
| return byName("okhttp3.RealCall$AsyncCall"); | ||
| } | ||
| } |
1 change: 1 addition & 0 deletions
1
apm-sniffer/apm-sdk-plugin/okhttp-3.x-plugin/src/main/resources/skywalking-plugin.def
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,3 @@ | ||
| okhttp-3.x=org.apache.skywalking.apm.plugin.okhttp.v3.define.RealCallInstrumentation | ||
| okhttp-3.x=org.apache.skywalking.apm.plugin.okhttp.v3.define.CallbackInstrumentation | ||
| okhttp-3.x=org.apache.skywalking.apm.plugin.okhttp.v3.define.AsyncCallInstrumentation |