Merge pull request #1022 from SimunKaracic/initial-kamon-redis

Initial instrumentation for Jedis

Author: SimunKaracic

build.sbt

@@ -132,7 +132,8 @@ lazy val instrumentation = (project in file("instrumentation"))
     `kamon-akka-http`,
     `kamon-play`,
     `kamon-okhttp`,
-    `kamon-tapir`
+    `kamon-tapir`,
+    `kamon-redis`,
   )
 
 
@@ -495,6 +496,21 @@ lazy val `kamon-tapir` = (project in file("instrumentation/kamon-tapir"))
     )
   ).dependsOn(`kamon-core`, `kamon-akka-http`, `kamon-testkit` % "test")
 
+lazy val `kamon-redis` = (project in file("instrumentation/kamon-redis"))
+  .disablePlugins(AssemblyPlugin)
+  .enablePlugins(JavaAgent)
+  .settings(instrumentationSettings)
+  .settings(
+    libraryDependencies ++= Seq(
+      kanelaAgent % "provided",
+      "redis.clients"      % "jedis"                    % "3.6.0" % "provided",
+
+      scalatest % "test",
+      logbackClassic % "test",
+      "org.testcontainers" % "testcontainers" % "1.15.3" % "test",
+    )
+  ).dependsOn(`kamon-core`, `kamon-testkit` % "test")
+
 /**
   * Reporters
   */
@@ -732,5 +748,6 @@ val `kamon-bundle` = (project in file("bundle/kamon-bundle"))
     `kamon-akka` % "shaded",
     `kamon-akka-http` % "shaded",
     `kamon-play` % "shaded",
-    `kamon-okhttp` % "shaded"
+    `kamon-redis` % "shaded",
+    `kamon-okhttp` % "shaded",
   )

instrumentation/kamon-redis/src/main/resources/reference.conf

@@ -0,0 +1,15 @@
+kanela.modules {
+  redis {
+    name = "Redis Instrumentation"
+    # Does it provide metrics? No.
+    description = "Provides tracing and metrics for the Jedis library"
+
+    instrumentations = [
+      "kamon.instrumentation.jedis.JedisInstrumentation",
+    ]
+
+    within = [
+      "redis.clients.jedis..*",
+    ]
+  }
+}

instrumentation/kamon-redis/src/main/scala/kamon/instrumentation/jedis/JedisInstrumentation.scala

@@ -0,0 +1,34 @@
+package kamon.instrumentation.jedis
+
+import kamon.Kamon
+import kamon.trace.Span
+import kanela.agent.api.instrumentation.InstrumentationBuilder
+import kanela.agent.libs.net.bytebuddy.asm.Advice
+import redis.clients.jedis.commands.ProtocolCommand
+
+class JedisInstrumentation extends InstrumentationBuilder {
+  onType("redis.clients.jedis.Protocol")
+    .advise(method("sendCommand").and(withArgument(1, classOf[ProtocolCommand])), classOf[SendCommandAdvice])
+}
+
+class SendCommandAdvice
+
+object SendCommandAdvice {
+  @Advice.OnMethodEnter()
+  def enter(@Advice.Argument(1) command: ProtocolCommand) = {
+    val spanName = s"redis.command.${command}"
+    val span = Kamon.clientSpanBuilder(spanName, "redis.client.jedis")
+      .start()
+
+    span
+  }
+
+  @Advice.OnMethodExit(onThrowable = classOf[Throwable])
+  def exit(@Advice.Enter span: Span,
+           @Advice.Thrown t: Throwable) = {
+    if (t != null) {
+      span.fail(t)
+    }
+    span.finish()
+  }
+}

instrumentation/kamon-redis/src/test/scala/kamon/instrumentation/jedis/JedisInstrumentationSpec.scala

@@ -0,0 +1,58 @@
+package kamon.instrumentation.jedis
+
+import kamon.testkit.{MetricInspection, TestSpanReporter}
+import kamon.trace.Span.Kind
+import org.scalatest.concurrent.{Eventually, ScalaFutures}
+import org.scalatest.{BeforeAndAfterAll, BeforeAndAfterEach, Matchers, OptionValues, WordSpec}
+import org.testcontainers.containers.GenericContainer
+import org.testcontainers.utility.DockerImageName
+import redis.clients.jedis.Jedis
+
+import scala.concurrent.duration.DurationInt
+import scala.util.control.NonFatal
+
+
+class JedisInstrumentationSpec extends WordSpec
+  with Matchers
+  with ScalaFutures
+  with Eventually
+  with BeforeAndAfterAll
+  with MetricInspection.Syntax
+  with OptionValues
+  with TestSpanReporter {
+
+  var container: GenericContainer[Nothing] = _
+
+  override def beforeAll: Unit = {
+    val REDIS_IMAGE = DockerImageName.parse("redis")
+    container = new GenericContainer(REDIS_IMAGE).withExposedPorts(6379)
+
+    container.start()
+  }
+
+  override def afterAll: Unit = {
+    container.stop()
+  }
+
+  "the Jedis instrumentation" should {
+    "generate a client span for get and set commands" in {
+      val jedis = new Jedis(container.getHost, container.getFirstMappedPort)
+      jedis.set("foo", "bar")
+
+      eventually(timeout(10.seconds)) {
+        val span = testSpanReporter().nextSpan().get
+        span.operationName shouldBe "redis.command.SET"
+        span.kind shouldBe Kind.Client
+      }
+
+      testSpanReporter().clear()
+
+      jedis.get("foo")
+      eventually(timeout(10.seconds)) {
+        val span = testSpanReporter().nextSpan().get
+        span.operationName shouldBe "redis.command.GET"
+        span.kind shouldBe Kind.Client
+      }
+    }
+  }
+}