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.

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

Jump to bottom

Disable Elasticsearch instrumentation for ES clients 8.10+ #9337

Merged
merged 6 commits into from
Sep 12, 2023
Merged

Disable Elasticsearch instrumentation for ES clients 8.10+ #9337

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
092a5cb
Disable Elasticsearch instrumentation for ES clients 8.10+ as those c…
AlexanderWert Aug 29, 2023
879dd49
Apply suggestions from code review
laurit Sep 12, 2023
98fdf49
spotless
laurit Sep 12, 2023
9a76889
Merge branch 'main' into es-8.10-fix
laurit Sep 12, 2023
897d9ad
add comment
laurit Sep 12, 2023
1c5fb6e
elasticsearch rest client doesn't use native instrumentation, revert …
laurit Sep 12, 2023
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
2 changes: 1 addition & 1 deletion instrumentation/elasticsearch/elasticsearch-api-client-7.16/javaagent/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ muzzle {
pass {
group.set("co.elastic.clients")
module.set("elasticsearch-java")
versions.set("[7.16,)")
versions.set("[7.16,8.10)")
laurit marked this conversation as resolved.
Show resolved Hide resolved
assertInverse.set(true)
}
}
Expand Down
11 changes: 11 additions & 0 deletions .../instrumentation/elasticsearch/apiclient/ElasticsearchApiClientInstrumentationModule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,30 @@

package io.opentelemetry.javaagent.instrumentation.elasticsearch.apiclient;

import static io.opentelemetry.javaagent.extension.matcher.AgentElementMatchers.hasClassesNamed;
import static java.util.Arrays.asList;
import static net.bytebuddy.matcher.ElementMatchers.not;

import com.google.auto.service.AutoService;
import io.opentelemetry.javaagent.extension.instrumentation.InstrumentationModule;
import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
import java.util.List;
import net.bytebuddy.matcher.ElementMatcher;

@AutoService(InstrumentationModule.class)
public class ElasticsearchApiClientInstrumentationModule extends InstrumentationModule {
public ElasticsearchApiClientInstrumentationModule() {
super("elasticsearch-api-client-7.16", "elasticsearch");
}

@Override
public ElementMatcher.Junction<ClassLoader> classLoaderMatcher() {
// Since Elasticsearch client version 8.10, the ES client comes with a native OTel instrumentation
// that introduced the class `co.elastic.clients.transport.instrumentation.Instrumentation`.
// Disabling agent instrumentation for those cases.
return not(hasClassesNamed("co.elastic.clients.transport.instrumentation.Instrumentation"));
}

@Override
public List<TypeInstrumentation> typeInstrumentations() {
return asList(
Expand Down
2 changes: 1 addition & 1 deletion instrumentation/elasticsearch/elasticsearch-rest-7.0/javaagent/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ muzzle {
pass {
group.set("org.elasticsearch.client")
module.set("elasticsearch-rest-client")
versions.set("[7.0,)")
versions.set("[7.0,8.10)")
laurit marked this conversation as resolved.
Show resolved Hide resolved
assertInverse.set(true)
}

Expand Down
9 changes: 7 additions & 2 deletions ...gent/instrumentation/elasticsearch/rest/v7_0/ElasticsearchRest7InstrumentationModule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

import static io.opentelemetry.javaagent.extension.matcher.AgentElementMatchers.hasClassesNamed;
import static java.util.Collections.singletonList;
import static net.bytebuddy.matcher.ElementMatchers.not;

import com.google.auto.service.AutoService;
import io.opentelemetry.javaagent.extension.instrumentation.InstrumentationModule;
Expand All @@ -22,8 +23,12 @@ public ElasticsearchRest7InstrumentationModule() {

@Override
public ElementMatcher.Junction<ClassLoader> classLoaderMatcher() {
// class introduced in 7.0.0
return hasClassesNamed("org.elasticsearch.client.RestClient$InternalRequest");
// Class `org.elasticsearch.client.RestClient$InternalRequest` introduced in 7.0.0.
// Since Elasticsearch client version 8.10, the ES client comes with a native OTel instrumentation
// that introduced the class `co.elastic.clients.transport.instrumentation.Instrumentation`.
// Disabling agent instrumentation for those cases.
return hasClassesNamed("org.elasticsearch.client.RestClient$InternalRequest").and(
not(hasClassesNamed("co.elastic.clients.transport.instrumentation.Instrumentation")));
}

@Override
Expand Down
Loading