-
Notifications
You must be signed in to change notification settings - Fork 6.4k
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 #729 from ascrutae/fix/jetty-client-9.0-issue
[Agent] fix jetty client doesn't work in after version 9.1
- Loading branch information
Showing
10 changed files
with
365 additions
and
19 deletions.
There are no files selected for viewing
42 changes: 42 additions & 0 deletions
42
apm-sniffer/apm-sdk-plugin/jetty-plugin/jetty-client-9.0-plugin/pom.xml
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,42 @@ | ||
<!-- | ||
~ 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. | ||
~ | ||
--> | ||
|
||
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> | ||
<parent> | ||
<artifactId>jetty-plugins</artifactId> | ||
<groupId>org.apache.skywalking</groupId> | ||
<version>5.0.0-alpha</version> | ||
</parent> | ||
<modelVersion>4.0.0</modelVersion> | ||
|
||
<artifactId>apm-jetty-client-9.0-plugin</artifactId> | ||
<packaging>jar</packaging> | ||
|
||
<name>jetty-client-9.0-plugin</name> | ||
<url>http://maven.apache.org</url> | ||
|
||
<dependencies> | ||
<dependency> | ||
<groupId>org.eclipse.jetty</groupId> | ||
<artifactId>jetty-client</artifactId> | ||
<version>9.0.0.v20130308</version> | ||
<scope>provided</scope> | ||
</dependency> | ||
</dependencies> | ||
</project> |
85 changes: 85 additions & 0 deletions
85
...ava/org/apache/skywalking/apm/plugin/jetty/v90/client/SyncHttpRequestSendInterceptor.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,85 @@ | ||
/* | ||
* 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.jetty.v90.client; | ||
|
||
import java.lang.reflect.Method; | ||
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.InstanceMethodsAroundInterceptor; | ||
import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.MethodInterceptResult; | ||
import org.apache.skywalking.apm.network.trace.component.ComponentsDefine; | ||
import org.eclipse.jetty.client.HttpRequest; | ||
import org.eclipse.jetty.http.HttpFields; | ||
import org.eclipse.jetty.http.HttpMethod; | ||
|
||
public class SyncHttpRequestSendInterceptor implements InstanceMethodsAroundInterceptor { | ||
|
||
@Override | ||
public void beforeMethod(EnhancedInstance objInst, Method method, Object[] allArguments, Class<?>[] argumentsTypes, | ||
MethodInterceptResult result) throws Throwable { | ||
HttpRequest request = (HttpRequest)objInst; | ||
ContextCarrier contextCarrier = new ContextCarrier(); | ||
AbstractSpan span = ContextManager.createExitSpan(request.getURI().getPath(), contextCarrier, request.getHost() + ":" + request.getPort()); | ||
span.setComponent(ComponentsDefine.JETTY_CLIENT); | ||
|
||
Tags.HTTP.METHOD.set(span, getHttpMethod(request)); | ||
Tags.URL.set(span, request.getURI().toString()); | ||
SpanLayer.asHttp(span); | ||
|
||
CarrierItem next = contextCarrier.items(); | ||
HttpFields field = request.getHeaders(); | ||
while (next.hasNext()) { | ||
next = next.next(); | ||
field.add(next.getHeadKey(), next.getHeadValue()); | ||
} | ||
} | ||
|
||
@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().errorOccurred().log(t); | ||
} | ||
|
||
public String getHttpMethod(HttpRequest request) { | ||
HttpMethod httpMethod = HttpMethod.GET; | ||
|
||
/** | ||
* The method is null if the client using GET method. | ||
* | ||
* @see org.eclipse.jetty.client.HttpRequest#GET(String uri) | ||
* @see org.eclipse.jetty.client.HttpRequest( org.eclipse.jetty.client.HttpClient client, long conversation, java.net.URI uri) | ||
*/ | ||
if (request.getMethod() != null) { | ||
httpMethod = request.getMethod(); | ||
} | ||
|
||
return httpMethod.name(); | ||
} | ||
} |
76 changes: 76 additions & 0 deletions
76
.../org/apache/skywalking/apm/plugin/jetty/v90/client/define/HttpRequestInstrumentation.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,76 @@ | ||
/* | ||
* 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.jetty.v90.client.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 org.apache.skywalking.apm.agent.core.plugin.match.NameMatch; | ||
|
||
import static net.bytebuddy.matcher.ElementMatchers.named; | ||
import static net.bytebuddy.matcher.ElementMatchers.takesArguments; | ||
|
||
/** | ||
* {@link HttpRequestInstrumentation} enhance the <code>send</code> method without argument in | ||
* <code>org.eclipse.jetty.client.HttpRequest</code> by <code>org.apache.skywalking.apm.plugin.jetty.client.SyncHttpRequestSendInterceptor</code> | ||
* and enhance the <code>send</code> with <code>org.eclipse.jetty.client.api.Response$CompleteListener</code> parameter | ||
* by <code>org.apache.skywalking.apm.plugin.jetty.client.AsyncHttpRequestSendInterceptor</code> | ||
* | ||
* @author zhangxin | ||
*/ | ||
public class HttpRequestInstrumentation extends ClassInstanceMethodsEnhancePluginDefine { | ||
|
||
private static final String ENHANCE_CLASS = "org.eclipse.jetty.client.HttpRequest"; | ||
private static final String ENHANCE_CLASS_NAME = "send"; | ||
public static final String SYNC_SEND_INTERCEPTOR = "org.apache.skywalking.apm.plugin.jetty.v90.client.SyncHttpRequestSendV90Interceptor"; | ||
|
||
@Override protected ConstructorInterceptPoint[] getConstructorsInterceptPoints() { | ||
return new ConstructorInterceptPoint[0]; | ||
} | ||
|
||
@Override protected InstanceMethodsInterceptPoint[] getInstanceMethodsInterceptPoints() { | ||
return new InstanceMethodsInterceptPoint[] { | ||
new InstanceMethodsInterceptPoint() { | ||
//sync call interceptor point | ||
@Override public ElementMatcher<MethodDescription> getMethodsMatcher() { | ||
return named(ENHANCE_CLASS_NAME).and(takesArguments(0)); | ||
} | ||
|
||
@Override public String getMethodsInterceptor() { | ||
return SYNC_SEND_INTERCEPTOR; | ||
} | ||
|
||
@Override public boolean isOverrideArgs() { | ||
return false; | ||
} | ||
} | ||
}; | ||
} | ||
|
||
@Override protected ClassMatch enhanceClass() { | ||
return NameMatch.byName(ENHANCE_CLASS); | ||
} | ||
|
||
@Override protected String[] witnessClasses() { | ||
return new String[] {"org.eclipse.jetty.client.api.ProxyConfiguration"}; | ||
} | ||
} |
1 change: 1 addition & 0 deletions
1
...-sdk-plugin/jetty-plugin/jetty-client-9.0-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 |
---|---|---|
@@ -0,0 +1 @@ | ||
jetty-client-9.0=org.apache.skywalking.apm.plugin.jetty.v90.client.define.HttpRequestInstrumentation |
141 changes: 141 additions & 0 deletions
141
...org/apache/skywalking/apm/plugin/jetty/v90/client/SyncHttpRequestSendInterceptorTest.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,141 @@ | ||
/* | ||
* 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.jetty.v90.client; | ||
|
||
import java.net.URI; | ||
import java.util.List; | ||
import org.apache.skywalking.apm.agent.core.context.trace.AbstractTracingSpan; | ||
import org.apache.skywalking.apm.agent.core.context.trace.TraceSegment; | ||
import org.apache.skywalking.apm.agent.core.context.util.KeyValuePair; | ||
import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.EnhancedInstance; | ||
import org.apache.skywalking.apm.agent.test.helper.SegmentHelper; | ||
import org.apache.skywalking.apm.agent.test.helper.SpanHelper; | ||
import org.apache.skywalking.apm.agent.test.tools.AgentServiceRule; | ||
import org.apache.skywalking.apm.agent.test.tools.SegmentStorage; | ||
import org.apache.skywalking.apm.agent.test.tools.SegmentStoragePoint; | ||
import org.apache.skywalking.apm.agent.test.tools.SpanAssert; | ||
import org.eclipse.jetty.client.HttpClient; | ||
import org.eclipse.jetty.client.HttpRequest; | ||
import org.eclipse.jetty.http.HttpMethod; | ||
import org.junit.Assert; | ||
import org.junit.Before; | ||
import org.junit.Rule; | ||
import org.junit.Test; | ||
import org.junit.runner.RunWith; | ||
import org.mockito.Mock; | ||
import org.powermock.modules.junit4.PowerMockRunner; | ||
import org.powermock.modules.junit4.PowerMockRunnerDelegate; | ||
import org.apache.skywalking.apm.agent.test.tools.TracingSegmentRunner; | ||
|
||
import static org.hamcrest.CoreMatchers.is; | ||
import static org.junit.Assert.assertThat; | ||
|
||
@RunWith(PowerMockRunner.class) | ||
@PowerMockRunnerDelegate(TracingSegmentRunner.class) | ||
public class SyncHttpRequestSendInterceptorTest { | ||
|
||
@SegmentStoragePoint | ||
private SegmentStorage segmentStorage; | ||
@Rule | ||
public AgentServiceRule serviceRule = new AgentServiceRule(); | ||
@Mock | ||
private HttpClient httpClient; | ||
@Mock | ||
private EnhancedInstance callBackEnhanceInstance; | ||
|
||
private Object[] allArguments; | ||
private Class[] argumentTypes; | ||
private MockHttpRequest enhancedInstance; | ||
private SyncHttpRequestSendInterceptor interceptor; | ||
private URI uri = URI.create("http://localhost:8080/test"); | ||
|
||
@Before | ||
public void setUp() throws Exception { | ||
enhancedInstance = new MockHttpRequest(httpClient, uri); | ||
allArguments = new Object[] {"OperationKey", "OperationValue"}; | ||
argumentTypes = new Class[] {String.class, String.class}; | ||
|
||
interceptor = new SyncHttpRequestSendInterceptor(); | ||
allArguments = new Object[] {callBackEnhanceInstance}; | ||
} | ||
|
||
@Test | ||
public void testMethodsAround() throws Throwable { | ||
interceptor.beforeMethod(enhancedInstance, null, allArguments, argumentTypes, null); | ||
interceptor.afterMethod(enhancedInstance, null, allArguments, argumentTypes, null); | ||
|
||
assertThat(segmentStorage.getTraceSegments().size(), is(1)); | ||
TraceSegment traceSegment = segmentStorage.getTraceSegments().get(0); | ||
|
||
Assert.assertEquals(1, SegmentHelper.getSpans(traceSegment).size()); | ||
AbstractTracingSpan finishedSpan = SegmentHelper.getSpans(traceSegment).get(0); | ||
|
||
List<KeyValuePair> tags = SpanHelper.getTags(finishedSpan); | ||
assertThat(tags.size(), is(2)); | ||
assertThat(tags.get(0).getValue(), is("GET")); | ||
assertThat(tags.get(1).getValue(), is(uri.toString())); | ||
|
||
Assert.assertEquals(false, SpanHelper.getErrorOccurred(finishedSpan)); | ||
} | ||
|
||
@Test | ||
public void testMethodsAroundError() throws Throwable { | ||
interceptor.beforeMethod(enhancedInstance, null, allArguments, argumentTypes, null); | ||
interceptor.handleMethodException(enhancedInstance, null, allArguments, argumentTypes, new RuntimeException()); | ||
interceptor.afterMethod(enhancedInstance, null, allArguments, argumentTypes, null); | ||
|
||
assertThat(segmentStorage.getTraceSegments().size(), is(1)); | ||
TraceSegment traceSegment = segmentStorage.getTraceSegments().get(0); | ||
|
||
Assert.assertEquals(1, SegmentHelper.getSpans(traceSegment).size()); | ||
AbstractTracingSpan finishedSpan = SegmentHelper.getSpans(traceSegment).get(0); | ||
|
||
List<KeyValuePair> tags = SpanHelper.getTags(finishedSpan); | ||
assertThat(tags.size(), is(2)); | ||
assertThat(tags.get(0).getValue(), is("GET")); | ||
assertThat(tags.get(1).getValue(), is(uri.toString())); | ||
|
||
Assert.assertEquals(true, SpanHelper.getErrorOccurred(finishedSpan)); | ||
SpanAssert.assertException(SpanHelper.getLogs(finishedSpan).get(0), RuntimeException.class); | ||
|
||
} | ||
|
||
private class MockHttpRequest extends HttpRequest implements EnhancedInstance { | ||
public MockHttpRequest(HttpClient httpClient, URI uri) { | ||
super(httpClient, uri); | ||
} | ||
|
||
@Override public Object getSkyWalkingDynamicField() { | ||
return null; | ||
} | ||
|
||
@Override public void setSkyWalkingDynamicField(Object value) { | ||
|
||
} | ||
|
||
@Override public HttpMethod getMethod() { | ||
return HttpMethod.GET; | ||
} | ||
|
||
@Override public URI getURI() { | ||
return uri; | ||
} | ||
} | ||
} |
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
Oops, something went wrong.