Skip to content

feat: support jedis v3 #496

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.

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions arex-agent/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,11 @@
<artifactId>arex-jedis-v2</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>${project.groupId}</groupId>
<artifactId>arex-jedis-v3</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>${project.groupId}</groupId>
<artifactId>arex-jedis-v4</artifactId>
Expand Down
1 change: 1 addition & 0 deletions arex-instrumentation/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
<module>database/arex-database-mongo</module>
<module>redis/arex-redis-common</module>
<module>redis/arex-jedis-v2</module>
<module>redis/arex-jedis-v3</module>
<module>redis/arex-jedis-v4</module>
<module>redis/arex-lettuce-v5</module>
<module>redis/arex-lettuce-v6</module>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
public class JedisModuleInstrumentation extends ModuleInstrumentation {
public JedisModuleInstrumentation() {
super("jedis-v2", ModuleDescription.builder()
.name("Jedis").supportFrom(ComparableVersion.of("2.0")).supportTo(ComparableVersion.of("3.99")).build());
.name("Jedis").supportFrom(ComparableVersion.of("2.0")).supportTo(ComparableVersion.of("2.99")).build());
// todo: check this version
}

Expand Down
29 changes: 29 additions & 0 deletions arex-instrumentation/redis/arex-jedis-v3/pom.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<?xml version="1.0" encoding="UTF-8"?>
<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>arex-instrumentation-parent</artifactId>
<groupId>io.arex</groupId>
<version>${revision}</version>
<relativePath>../../pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>

<artifactId>arex-jedis-v3</artifactId>

<dependencies>
<dependency>
<groupId>redis.clients</groupId>
<artifactId>jedis</artifactId>
<version>3.10.0</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>io.arex</groupId>
<artifactId>arex-redis-common</artifactId>
<version>${project.version}</version>
<scope>compile</scope>
</dependency>
</dependencies>
</project>
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
package io.arex.inst.jedis.v3;

import io.arex.inst.extension.MethodInstrumentation;
import io.arex.inst.extension.TypeInstrumentation;
import net.bytebuddy.asm.Advice;
import net.bytebuddy.description.type.TypeDescription;
import net.bytebuddy.matcher.ElementMatcher;
import org.apache.commons.pool2.PooledObject;
import org.apache.commons.pool2.impl.DefaultPooledObject;
import redis.clients.jedis.HostAndPort;
import redis.clients.jedis.Jedis;
import redis.clients.jedis.exceptions.JedisException;

import javax.net.ssl.HostnameVerifier;
import javax.net.ssl.SSLParameters;
import javax.net.ssl.SSLSocketFactory;
import java.util.List;
import java.util.concurrent.atomic.AtomicReference;

import static java.util.Collections.singletonList;
import static net.bytebuddy.matcher.ElementMatchers.*;

public class JedisFactoryInstrumentation extends TypeInstrumentation {
@Override
public ElementMatcher<TypeDescription> typeMatcher() {
return named("redis.clients.jedis.JedisFactory");
}

@Override
public List<MethodInstrumentation> methodAdvices() {
return singletonList(new MethodInstrumentation(
isMethod().and(named("makeObject")).and(takesArguments(0)),
this.getClass().getName() + "$MakeObjectAdvice"));
}

@SuppressWarnings("unused")
public static class MakeObjectAdvice {

@Advice.OnMethodEnter(skipOn = Advice.OnNonDefaultValue.class, suppress = Throwable.class)
public static Jedis onEnter(@Advice.FieldValue("hostAndPort") AtomicReference<HostAndPort> hostAndPort,
@Advice.FieldValue("connectionTimeout") Integer connectionTimeout,
@Advice.FieldValue("soTimeout") Integer soTimeout,
@Advice.FieldValue("ssl") Boolean ssl,
@Advice.FieldValue("sslSocketFactory") SSLSocketFactory sslSocketFactory,
@Advice.FieldValue("sslParameters") SSLParameters sslParameters,
@Advice.FieldValue("hostnameVerifier") HostnameVerifier hostnameVerifier) {
final HostAndPort hp = hostAndPort.get();
return new JedisWrapper(hp.getHost(), hp.getPort(), connectionTimeout, soTimeout,
ssl, sslSocketFactory, sslParameters, hostnameVerifier);
}

// todo: change instrumentation: JedisFactory -> DefaultPoolObject
// need throw JedisException, not suppress throwable
@Advice.OnMethodExit
public static void onExit(@Advice.Enter Jedis jedis,
@Advice.FieldValue("password") String password,
@Advice.FieldValue("database") Integer database,
@Advice.FieldValue("clientName") String clientName,
@Advice.Return(readOnly = false) PooledObject<Jedis> result) throws Exception {
if (jedis == null) {
return;
}
try {
jedis.connect();
if (password != null) {
jedis.auth(password);
}
if (database != 0) {
jedis.select(database);
}
if (clientName != null) {
jedis.clientSetname(clientName);
}
result = new DefaultPooledObject<Jedis>(jedis);
} catch (JedisException jex) {
jedis.close();
throw jex;
}
}
}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
package io.arex.inst.jedis.v3;

import com.google.auto.service.AutoService;
import io.arex.inst.extension.ModuleDescription;
import io.arex.inst.extension.ModuleInstrumentation;
import io.arex.inst.extension.TypeInstrumentation;
import io.arex.agent.bootstrap.model.ComparableVersion;

import java.util.List;

import static java.util.Collections.singletonList;

@AutoService(ModuleInstrumentation.class)
public class JedisModuleInstrumentation extends ModuleInstrumentation {
public JedisModuleInstrumentation() {
super("jedis-v3", ModuleDescription.builder()
.name("Jedis").supportFrom(ComparableVersion.of("3.0")).supportTo(ComparableVersion.of("3.99")).build());
}

@Override
public List<TypeInstrumentation> instrumentationTypes() {
return singletonList(new JedisFactoryInstrumentation());
}
}
Loading