Skip to content

Support for tracing the callbacks of async methods in elastiicsearch-6.x/7.x-plugin #694

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
wu-sheng merged 3 commits into from
May 27, 2024
Merged

Support for tracing the callbacks of async methods in elastiicsearch-6.x/7.x-plugin #694

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ad21e49
Support for tracing the callbacks of asynchronous methods in elastics…
CzyerChen May 25, 2024
74b4709
update testcase.
CzyerChen May 27, 2024
207c96f
update testcase.
CzyerChen May 27, 2024
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
1 change: 1 addition & 0 deletions CHANGES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Release Notes.
* Fix NPE in Redisson plugin since Redisson 3.20.0.
* Support for showing batch command details and ignoring PING commands in Redisson plugin.
* Fix peer value of Master-Slave mode in Redisson plugin.
* Support for tracing the callbacks of asynchronous methods in elasticsearch-6.x-plugin/elasticsearch-7.x-plugin.

All issues and pull requests are [here](https://github.com/apache/skywalking/milestone/213?closed=1)

Expand Down
8 changes: 4 additions & 4 deletions ...rg/apache/skywalking/apm/plugin/elasticsearch/v6/define/IndicesClientInstrumentation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ public String getMethodsInterceptor() {

@Override
public boolean isOverrideArgs() {
return false;
return true;
}
},
new InstanceMethodsInterceptPoint() {
Expand All @@ -85,7 +85,7 @@ public String getMethodsInterceptor() {

@Override
public boolean isOverrideArgs() {
return false;
return true;
}
},
new InstanceMethodsInterceptPoint() {
Expand All @@ -102,7 +102,7 @@ public String getMethodsInterceptor() {

@Override
public boolean isOverrideArgs() {
return false;
return true;
}
},
new InstanceMethodsInterceptPoint() {
Expand All @@ -119,7 +119,7 @@ public String getMethodsInterceptor() {

@Override
public boolean isOverrideArgs() {
return false;
return true;
}
}
};
Expand Down
16 changes: 8 additions & 8 deletions ...che/skywalking/apm/plugin/elasticsearch/v6/define/RestHighLevelClientInstrumentation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ public String getMethodsInterceptor() {

@Override
public boolean isOverrideArgs() {
return false;
return true;
}
},
new InstanceMethodsInterceptPoint() {
Expand All @@ -102,7 +102,7 @@ public String getMethodsInterceptor() {

@Override
public boolean isOverrideArgs() {
return false;
return true;
}
},
new InstanceMethodsInterceptPoint() {
Expand All @@ -118,7 +118,7 @@ public String getMethodsInterceptor() {

@Override
public boolean isOverrideArgs() {
return false;
return true;
}
},
new InstanceMethodsInterceptPoint() {
Expand All @@ -134,7 +134,7 @@ public String getMethodsInterceptor() {

@Override
public boolean isOverrideArgs() {
return false;
return true;
}
},
new InstanceMethodsInterceptPoint() {
Expand Down Expand Up @@ -182,7 +182,7 @@ public String getMethodsInterceptor() {

@Override
public boolean isOverrideArgs() {
return false;
return true;
}
},
new InstanceMethodsInterceptPoint() {
Expand All @@ -198,7 +198,7 @@ public String getMethodsInterceptor() {

@Override
public boolean isOverrideArgs() {
return false;
return true;
}
},
new InstanceMethodsInterceptPoint() {
Expand All @@ -214,7 +214,7 @@ public String getMethodsInterceptor() {

@Override
public boolean isOverrideArgs() {
return false;
return true;
}
},
new InstanceMethodsInterceptPoint() {
Expand All @@ -230,7 +230,7 @@ public String getMethodsInterceptor() {

@Override
public boolean isOverrideArgs() {
return false;
return true;
}
}
};
Expand Down
3 changes: 3 additions & 0 deletions ...rc/main/java/org/apache/skywalking/apm/plugin/elasticsearch/v6/interceptor/Constants.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,4 +79,7 @@ public class Constants {
public static final AbstractTag<String> ES_TOOK_MILLIS = Tags.ofKey("es.took_millis");
public static final AbstractTag<String> ES_TOTAL_HITS = Tags.ofKey("es.total_hits");
public static final AbstractTag<String> ES_INGEST_TOOK_MILLIS = Tags.ofKey("es.ingest_took_millis");

public static final String ON_RESPONSE_SUFFIX = "/onResponse";
public static final String ON_FAILURE_SUFFIX = "/onFailure";
}
6 changes: 6 additions & 0 deletions ...lking/apm/plugin/elasticsearch/v6/interceptor/IndicesClientAnalyzeMethodsInterceptor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@
import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.MethodInterceptResult;
import org.apache.skywalking.apm.network.trace.component.ComponentsDefine;
import org.apache.skywalking.apm.plugin.elasticsearch.common.RestClientEnhanceInfo;
import org.apache.skywalking.apm.plugin.elasticsearch.v6.support.AdapterUtil;
import org.elasticsearch.action.ActionListener;
import org.elasticsearch.action.admin.indices.analyze.AnalyzeRequest;

import java.lang.reflect.Method;
Expand Down Expand Up @@ -58,6 +60,10 @@ public void beforeMethod(EnhancedInstance objInst, Method method, Object[] allAr
Tags.DB_STATEMENT.set(span, analyzeRequest.text()[0]);
}
SpanLayer.asDB(span);
if (allArguments.length > 2 && allArguments[2] != null && allArguments[2] instanceof ActionListener) {
allArguments[2] = AdapterUtil.wrapActionListener(restClientEnhanceInfo, Constants.ANALYZE_OPERATOR_NAME,
(ActionListener) allArguments[2]);
}
}
}

Expand Down
6 changes: 6 additions & 0 deletions ...alking/apm/plugin/elasticsearch/v6/interceptor/IndicesClientCreateMethodsInterceptor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@
import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.MethodInterceptResult;
import org.apache.skywalking.apm.network.trace.component.ComponentsDefine;
import org.apache.skywalking.apm.plugin.elasticsearch.common.RestClientEnhanceInfo;
import org.apache.skywalking.apm.plugin.elasticsearch.v6.support.AdapterUtil;
import org.elasticsearch.action.ActionListener;
import org.elasticsearch.client.indices.CreateIndexRequest;

import static org.apache.skywalking.apm.plugin.elasticsearch.v6.ElasticsearchPluginConfig.Plugin.Elasticsearch.TRACE_DSL;
Expand All @@ -52,6 +54,10 @@ public void beforeMethod(EnhancedInstance objInst, Method method, Object[] allAr
Tags.DB_STATEMENT.set(span, createIndexRequest.mappings().utf8ToString());
}
SpanLayer.asDB(span);
if (allArguments.length > 2 && allArguments[2] != null && allArguments[2] instanceof ActionListener) {
allArguments[2] = AdapterUtil.wrapActionListener(restClientEnhanceInfo, Constants.CREATE_OPERATOR_NAME,
(ActionListener) allArguments[2]);
}
}
}

Expand Down
6 changes: 6 additions & 0 deletions ...alking/apm/plugin/elasticsearch/v6/interceptor/IndicesClientDeleteMethodsInterceptor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@
import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.MethodInterceptResult;
import org.apache.skywalking.apm.network.trace.component.ComponentsDefine;
import org.apache.skywalking.apm.plugin.elasticsearch.common.RestClientEnhanceInfo;
import org.apache.skywalking.apm.plugin.elasticsearch.v6.support.AdapterUtil;
import org.elasticsearch.action.ActionListener;
import org.elasticsearch.action.admin.indices.delete.DeleteIndexRequest;

import static org.apache.skywalking.apm.plugin.elasticsearch.v6.interceptor.Constants.DB_TYPE;
Expand All @@ -48,6 +50,10 @@ public void beforeMethod(EnhancedInstance objInst, Method method, Object[] allAr
Tags.DB_TYPE.set(span, DB_TYPE);
Tags.DB_INSTANCE.set(span, Arrays.asList(deleteIndexRequest.indices()).toString());
SpanLayer.asDB(span);
if (allArguments.length > 2 && allArguments[2] != null && allArguments[2] instanceof ActionListener) {
allArguments[2] = AdapterUtil.wrapActionListener(restClientEnhanceInfo, Constants.DELETE_OPERATOR_NAME,
(ActionListener) allArguments[2]);
}
}
}

Expand Down
6 changes: 6 additions & 0 deletions ...lking/apm/plugin/elasticsearch/v6/interceptor/IndicesClientRefreshMethodsInterceptor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@
import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.MethodInterceptResult;
import org.apache.skywalking.apm.network.trace.component.ComponentsDefine;
import org.apache.skywalking.apm.plugin.elasticsearch.common.RestClientEnhanceInfo;
import org.apache.skywalking.apm.plugin.elasticsearch.v6.support.AdapterUtil;
import org.elasticsearch.action.ActionListener;
import org.elasticsearch.action.admin.indices.refresh.RefreshRequest;

import java.lang.reflect.Method;
Expand All @@ -48,6 +50,10 @@ public void beforeMethod(EnhancedInstance objInst, Method method, Object[] allAr
Tags.DB_TYPE.set(span, DB_TYPE);
Tags.DB_INSTANCE.set(span, buildIndicesString(request.indices()));
SpanLayer.asDB(span);
if (allArguments.length > 2 && allArguments[2] != null && allArguments[2] instanceof ActionListener) {
allArguments[2] = AdapterUtil.wrapActionListener(restClientEnhanceInfo, Constants.REFRESH_OPERATOR_NAME,
(ActionListener) allArguments[2]);
}
}
}

Expand Down
6 changes: 6 additions & 0 deletions ...plugin/elasticsearch/v6/interceptor/RestHighLevelClientClearScrollMethodsInterceptor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@
import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.MethodInterceptResult;
import org.apache.skywalking.apm.network.trace.component.ComponentsDefine;
import org.apache.skywalking.apm.plugin.elasticsearch.common.RestClientEnhanceInfo;
import org.apache.skywalking.apm.plugin.elasticsearch.v6.support.AdapterUtil;
import org.elasticsearch.action.ActionListener;
import org.elasticsearch.action.search.ClearScrollRequest;

import java.lang.reflect.Method;
Expand All @@ -52,6 +54,10 @@ public void beforeMethod(EnhancedInstance objInst, Method method, Object[] allAr
}

SpanLayer.asDB(span);
if (allArguments.length > 2 && allArguments[2] != null && allArguments[2] instanceof ActionListener) {
allArguments[2] = AdapterUtil.wrapActionListener(restClientEnhanceInfo, Constants.CLEAR_SCROLL_OPERATOR_NAME,
(ActionListener) allArguments[2]);
}
}

@Override
Expand Down
6 changes: 6 additions & 0 deletions ...ugin/elasticsearch/v6/interceptor/RestHighLevelClientDeleteByQueryMethodsInterceptor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@
import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.MethodInterceptResult;
import org.apache.skywalking.apm.network.trace.component.ComponentsDefine;
import org.apache.skywalking.apm.plugin.elasticsearch.common.RestClientEnhanceInfo;
import org.apache.skywalking.apm.plugin.elasticsearch.v6.support.AdapterUtil;
import org.elasticsearch.action.ActionListener;
import org.elasticsearch.index.reindex.DeleteByQueryRequest;

import java.lang.reflect.Method;
Expand Down Expand Up @@ -58,6 +60,10 @@ public void beforeMethod(EnhancedInstance objInst, Method method, Object[] allAr
}

SpanLayer.asDB(span);
if (allArguments.length > 2 && allArguments[2] != null && allArguments[2] instanceof ActionListener) {
allArguments[2] = AdapterUtil.wrapActionListener(restClientEnhanceInfo, Constants.DELETE_BY_QUERY_OPERATOR_NAME,
(ActionListener) allArguments[2]);
}
}

@Override
Expand Down
6 changes: 6 additions & 0 deletions ...ing/apm/plugin/elasticsearch/v6/interceptor/RestHighLevelClientGetMethodsInterceptor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@
import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.MethodInterceptResult;
import org.apache.skywalking.apm.network.trace.component.ComponentsDefine;
import org.apache.skywalking.apm.plugin.elasticsearch.common.RestClientEnhanceInfo;
import org.apache.skywalking.apm.plugin.elasticsearch.v6.support.AdapterUtil;
import org.elasticsearch.action.ActionListener;
import org.elasticsearch.action.get.GetRequest;

import static org.apache.skywalking.apm.plugin.elasticsearch.v6.ElasticsearchPluginConfig.Plugin.Elasticsearch.TRACE_DSL;
Expand All @@ -51,6 +53,10 @@ public void beforeMethod(EnhancedInstance objInst, Method method, Object[] allAr
}

SpanLayer.asDB(span);
if (allArguments.length > 2 && allArguments[2] != null && allArguments[2] instanceof ActionListener) {
allArguments[2] = AdapterUtil.wrapActionListener(restClientEnhanceInfo, Constants.GET_OPERATOR_NAME,
(ActionListener) allArguments[2]);
}
}

@Override
Expand Down
6 changes: 6 additions & 0 deletions ...g/apm/plugin/elasticsearch/v6/interceptor/RestHighLevelClientIndexMethodsInterceptor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@
import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.MethodInterceptResult;
import org.apache.skywalking.apm.network.trace.component.ComponentsDefine;
import org.apache.skywalking.apm.plugin.elasticsearch.common.RestClientEnhanceInfo;
import org.apache.skywalking.apm.plugin.elasticsearch.v6.support.AdapterUtil;
import org.elasticsearch.action.ActionListener;
import org.elasticsearch.action.index.IndexRequest;

import static org.apache.skywalking.apm.plugin.elasticsearch.v6.ElasticsearchPluginConfig.Plugin.Elasticsearch.TRACE_DSL;
Expand All @@ -51,6 +53,10 @@ public void beforeMethod(EnhancedInstance objInst, Method method, Object[] allAr
}

SpanLayer.asDB(span);
if (allArguments.length > 2 && allArguments[2] != null && allArguments[2] instanceof ActionListener) {
allArguments[2] = AdapterUtil.wrapActionListener(restClientEnhanceInfo, Constants.INDEX_OPERATOR_NAME,
(ActionListener) allArguments[2]);
}
}

@Override
Expand Down
6 changes: 6 additions & 0 deletions .../apm/plugin/elasticsearch/v6/interceptor/RestHighLevelClientSearchMethodsInterceptor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@
import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.MethodInterceptResult;
import org.apache.skywalking.apm.network.trace.component.ComponentsDefine;
import org.apache.skywalking.apm.plugin.elasticsearch.common.RestClientEnhanceInfo;
import org.apache.skywalking.apm.plugin.elasticsearch.v6.support.AdapterUtil;
import org.elasticsearch.action.ActionListener;
import org.elasticsearch.action.search.SearchRequest;

import static org.apache.skywalking.apm.plugin.elasticsearch.v6.ElasticsearchPluginConfig.Plugin.Elasticsearch.TRACE_DSL;
Expand All @@ -52,6 +54,10 @@ public void beforeMethod(EnhancedInstance objInst, Method method, Object[] allAr
}

SpanLayer.asDB(span);
if (allArguments.length > 2 && allArguments[2] != null && allArguments[2] instanceof ActionListener) {
allArguments[2] = AdapterUtil.wrapActionListener(restClientEnhanceInfo, Constants.SEARCH_OPERATOR_NAME,
(ActionListener) allArguments[2]);
}
}

@Override
Expand Down
6 changes: 6 additions & 0 deletions ...lugin/elasticsearch/v6/interceptor/RestHighLevelClientSearchScrollMethodsInterceptor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@
import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.MethodInterceptResult;
import org.apache.skywalking.apm.network.trace.component.ComponentsDefine;
import org.apache.skywalking.apm.plugin.elasticsearch.common.RestClientEnhanceInfo;
import org.apache.skywalking.apm.plugin.elasticsearch.v6.support.AdapterUtil;
import org.elasticsearch.action.ActionListener;
import org.elasticsearch.action.search.SearchScrollRequest;

import java.lang.reflect.Method;
Expand All @@ -51,6 +53,10 @@ public void beforeMethod(EnhancedInstance objInst, Method method, Object[] allAr
}

SpanLayer.asDB(span);
if (allArguments.length > 2 && allArguments[2] != null && allArguments[2] instanceof ActionListener) {
allArguments[2] = AdapterUtil.wrapActionListener(restClientEnhanceInfo, Constants.SEARCH_SCROLL_OPERATOR_NAME,
(ActionListener) allArguments[2]);
}
}

@Override
Expand Down
6 changes: 6 additions & 0 deletions ...gin/elasticsearch/v6/interceptor/RestHighLevelClientSearchTemplateMethodsInterceptor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@
import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.MethodInterceptResult;
import org.apache.skywalking.apm.network.trace.component.ComponentsDefine;
import org.apache.skywalking.apm.plugin.elasticsearch.common.RestClientEnhanceInfo;
import org.apache.skywalking.apm.plugin.elasticsearch.v6.support.AdapterUtil;
import org.elasticsearch.action.ActionListener;
import org.elasticsearch.script.mustache.SearchTemplateRequest;

import java.lang.reflect.Method;
Expand Down Expand Up @@ -55,6 +57,10 @@ public void beforeMethod(EnhancedInstance objInst, Method method, Object[] allAr
}

SpanLayer.asDB(span);
if (allArguments.length > 2 && allArguments[2] != null && allArguments[2] instanceof ActionListener) {
allArguments[2] = AdapterUtil.wrapActionListener(restClientEnhanceInfo, Constants.SEARCH_TEMPLATE_OPERATOR_NAME,
(ActionListener) allArguments[2]);
}
}

@Override
Expand Down
6 changes: 6 additions & 0 deletions .../apm/plugin/elasticsearch/v6/interceptor/RestHighLevelClientUpdateMethodsInterceptor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@
import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.MethodInterceptResult;
import org.apache.skywalking.apm.network.trace.component.ComponentsDefine;
import org.apache.skywalking.apm.plugin.elasticsearch.common.RestClientEnhanceInfo;
import org.apache.skywalking.apm.plugin.elasticsearch.v6.support.AdapterUtil;
import org.elasticsearch.action.ActionListener;
import org.elasticsearch.action.update.UpdateRequest;

import static org.apache.skywalking.apm.plugin.elasticsearch.v6.ElasticsearchPluginConfig.Plugin.Elasticsearch.TRACE_DSL;
Expand All @@ -51,6 +53,10 @@ public void beforeMethod(EnhancedInstance objInst, Method method, Object[] allAr
}

SpanLayer.asDB(span);
if (allArguments.length > 2 && allArguments[2] != null && allArguments[2] instanceof ActionListener) {
allArguments[2] = AdapterUtil.wrapActionListener(restClientEnhanceInfo, Constants.UPDATE_OPERATOR_NAME,
(ActionListener) allArguments[2]);
}
}

@Override
Expand Down
Loading