introduce kamon-spring module

Author: cspinetta

.travis.yml

@@ -3,7 +3,7 @@ language: scala
 script:
  - sbt +test
 scala:
- - 2.12.5
+ - 2.12.6
 jdk:
  - oraclejdk8
 before_script:

build.sbt

@@ -23,7 +23,7 @@ val kamonTestkit = "io.kamon" %% "kamon-testkit"
 val springBootStarterWeb = "org.springframework.boot" % "spring-boot-starter-web" % "2.0.0.RELEASE" exclude("org.springframework.boot", "spring-boot-starter-tomcat")
 val springBootStarterTest = "org.springframework.boot" % "spring-boot-starter-test" % "2.0.0.RELEASE"
 val springStarterJetty = "org.springframework.boot" % "spring-boot-starter-jetty" % "2.0.0.RELEASE"
-val kamonServlet3 = "io.kamon" %% "kamon-servlet-3.x.x" % "0.1-e3428b1c8ba6f301749f955b5feb7126ac79bb1e"
+val kamonServlet3 = "io.kamon" %% "kamon-servlet-3.x.x" % "0.1-0c8024964581daaf872876044f8ec7c06b55159e"
 val servletApiV3 = "javax.servlet" % "javax.servlet-api" % "3.0.1"
 
 val httpClient = "org.apache.httpcomponents" % "httpclient" % "4.5.5"
@@ -36,11 +36,10 @@ lazy val root = (project in file("."))
  .aggregate(kamonSpring, kamonSpringBench)
 
 val commonSettings = Seq(
- scalaVersion := "2.12.5",
+ scalaVersion := "2.12.6",
  resolvers += Resolver.mavenLocal,
- crossScalaVersions := Seq("2.12.5", "2.11.12", "2.10.7"),
+ crossScalaVersions := Seq("2.12.6", "2.11.12", "2.10.7"),
  scalacOptions ++= Seq(
-// "-Ypartial-unification",
  "-language:higherKinds",
  "-language:postfixOps") ++ (CrossVersion.partialVersion(scalaVersion.value) match {
  case Some((2,10)) => Seq("-Yno-generic-signatures", "-target:jvm-1.7")

kamon-spring/src/main/resources/reference.conf

@@ -16,4 +16,6 @@ kamon {
  enabled = true
  }
  }
+
+ servlet.tags.server-component = "spring-server"
 }

kamon-spring/src/main/scala/kamon/spring/Spring.scala

@@ -20,7 +20,7 @@ object Spring {
  }
 
  private def addHttpStatusCodeAsMetricTagFromConfig(config: Config): Boolean =
- Kamon.config.getBoolean("kamon.spring.add-http-status-code-as-metric-tag")
+ config.getBoolean("kamon.spring.add-http-status-code-as-metric-tag")
 
 
  Kamon.onReconfigure(new OnReconfigureHook {

kamon-spring/src/test/scala/kamon/spring/AsyncHttpMetricsSpec.scala

@@ -83,7 +83,7 @@ class AsyncHttpMetricsSpec extends WordSpec
 
  "track the response time with status code 5xx" in {
  for(_ <- 1 to 100) yield get("/async/tracing/error")
- ResponseTimeMetrics().forStatusCode("5xx").distribution().max should be >= 10000000L
+ ResponseTimeMetrics().forStatusCode("5xx").distribution().max should be >= 1000000L // 1 ms expressed in nanos
  }
  }
 }

kamon-spring/src/test/scala/kamon/spring/AsyncServerInstrumentationSpec.scala

@@ -18,11 +18,10 @@ package kamon.spring
 
 import com.typesafe.config.ConfigFactory
 import kamon.Kamon
+import kamon.spring.client.HttpClientSupport
 import kamon.spring.webapp.AppSupport
 import kamon.trace.Span
 import kamon.trace.Span.TagValue
-import org.apache.http.client.methods.{CloseableHttpResponse, HttpGet}
-import org.apache.http.impl.client.HttpClients
 import org.scalatest.concurrent.Eventually
 import org.scalatest.{BeforeAndAfterAll, Matchers, OptionValues, WordSpec}
 
@@ -34,7 +33,8 @@ class AsyncServerInstrumentationSpec extends WordSpec
  with Eventually
  with OptionValues
  with SpanReporter
- with AppSupport {
+ with AppSupport
+ with HttpClientSupport {
 
  override protected def beforeAll(): Unit = {
  Kamon.reconfigure(ConfigFactory.load())
@@ -47,33 +47,21 @@ class AsyncServerInstrumentationSpec extends WordSpec
  stopApp()
  }
 
- private val httpClient = HttpClients.createDefault()
-
- private def get(path: String, headers: Seq[(String, String)] = Seq()): CloseableHttpResponse = {
- val request = new HttpGet(s"http://127.0.0.1:$port$path")
- headers.foreach { case (name, v) => request.addHeader(name, v) }
- httpClient.execute(request)
- }
-
  "The Server instrumentation on Spring Boot with Async Servlet" should {
  "propagate the current context and respond to the ok action" in {
 
  get("/async/tracing/ok").getStatusLine.getStatusCode shouldBe 200
 
  eventually(timeout(3 seconds)) {
-
  val span = reporter.nextSpan().value
  val spanTags = stringTag(span) _
 
  span.operationName shouldBe "async.tracing.ok.get"
  spanTags("span.kind") shouldBe "server"
- spanTags("component") shouldBe "servlet.server"
+ spanTags("component") shouldBe "spring-server"
  spanTags("http.method") shouldBe "GET"
  spanTags("http.url") shouldBe "/async/tracing/ok"
  span.tags("http.status_code") shouldBe TagValue.Number(200)
-
-// span.from.until(span.to, ChronoUnit.MILLIS) shouldBe >= (servlet.durationOk.toLong)
-
  }
  }
 
@@ -87,12 +75,10 @@ class AsyncServerInstrumentationSpec extends WordSpec
 
  span.operationName shouldBe "not-found"
  spanTags("span.kind") shouldBe "server"
- spanTags("component") shouldBe "servlet.server"
+ spanTags("component") shouldBe "spring-server"
  spanTags("http.method") shouldBe "GET"
  spanTags("http.url") shouldBe "/async/tracing/not-found"
  span.tags("http.status_code") shouldBe TagValue.Number(404)
-
-// span.from.until(span.to, ChronoUnit.MILLIS) shouldBe >= (servlet.durationNotFound.toLong)
  }
  }
 
@@ -105,37 +91,72 @@ class AsyncServerInstrumentationSpec extends WordSpec
 
  span.operationName shouldBe "async.tracing.error.get"
  spanTags("span.kind") shouldBe "server"
- spanTags("component") shouldBe "servlet.server"
+ spanTags("component") shouldBe "spring-server"
  spanTags("http.method") shouldBe "GET"
  spanTags("http.url") shouldBe "/async/tracing/error"
  span.tags("error") shouldBe TagValue.True
  span.tags("http.status_code") shouldBe TagValue.Number(500)
-
-// span.from.until(span.to, ChronoUnit.MILLIS) shouldBe >= (servlet.durationError.toLong)
  }
  }
 
  "propagate the current context and respond to the error action produced with an internal exception" in {
- get("/async/tracing/unhandled-error").getStatusLine.getStatusCode shouldBe 500
+ get("/async/tracing/exception").getStatusLine.getStatusCode shouldBe 500
 
  eventually(timeout(3 seconds)) {
  val span = reporter.nextSpan().value
  val spanTags = stringTag(span) _
 
- span.operationName shouldBe "async.tracing.unhandled-error.get"
+ span.operationName shouldBe "async.tracing.exception.get"
  spanTags("span.kind") shouldBe "server"
- spanTags("component") shouldBe "servlet.server"
+ spanTags("component") shouldBe "spring-server"
  spanTags("http.method") shouldBe "GET"
- spanTags("http.url") shouldBe "/async/tracing/unhandled-error"
+ spanTags("http.url") shouldBe "/async/tracing/exception"
  span.tags("error") shouldBe TagValue.True
  span.tags("http.status_code") shouldBe TagValue.Number(500)
+ }
+ }
+
+ "resume the incoming context and respond to the ok endpoint" in {
+ get("/async/tracing/ok", IncomingContext.headersB3).getStatusLine.getStatusCode shouldBe 200
+
+ eventually(timeout(3 seconds)) {
+
+ val span = reporter.nextSpan().value
+ val spanTags = stringTag(span) _
+
+ span.operationName shouldBe "async.tracing.ok.get"
+ spanTags("span.kind") shouldBe "server"
+ spanTags("component") shouldBe "spring-server"
+ spanTags("http.method") shouldBe "GET"
+ spanTags("http.url") shouldBe "/async/tracing/ok"
+ span.tags("http.status_code") shouldBe TagValue.Number(200)
 
-// span.from.until(span.to, ChronoUnit.MILLIS) shouldBe >= (servlet.durationError.toLong)
+ span.context.parentID.string shouldBe IncomingContext.SpanId
+ span.context.traceID.string shouldBe IncomingContext.TraceId
  }
  }
  }
 
  def stringTag(span: Span.FinishedSpan)(tag: String): String = {
  span.tags(tag).asInstanceOf[TagValue.String].string
  }
+
+ private object IncomingContext {
+ import kamon.trace.SpanCodec.B3.{Headers => B3Headers}
+
+ val TraceId = "1234"
+ val ParentSpanId = "2222"
+ val SpanId = "4321"
+ val Sampled = "1"
+ val Flags = "some=baggage;more=baggage;other=baggage2"
+
+
+ val headersB3 = Seq(
+ (B3Headers.TraceIdentifier, TraceId),
+ (B3Headers.ParentSpanIdentifier, ParentSpanId),
+ (B3Headers.SpanIdentifier, SpanId),
+ (B3Headers.Sampled, Sampled),
+ (B3Headers.Flags, Flags))
+
+ }
 }

kamon-spring/src/test/scala/kamon/spring/ServerInstrumentationSpec.scala

@@ -16,10 +16,13 @@
 
 package kamon.spring
 
+import java.time.temporal.ChronoUnit
+
 import com.typesafe.config.ConfigFactory
 import kamon.Kamon
 import kamon.spring.client.HttpClientSupport
 import kamon.spring.webapp.AppSupport
+import kamon.spring.webapp.controller.SyncTracingController
 import kamon.trace.Span
 import kamon.trace.Span.TagValue
 import org.scalatest.concurrent.Eventually
@@ -48,7 +51,7 @@ class ServerInstrumentationSpec extends WordSpec
  }
 
  "The Server instrumentation on Sync Spring Boot" should {
- "propagate the current context and respond to the ok action" in {
+ "propagate the current context and respond to the ok endpoint" in {
 
  get("/sync/tracing/ok").getStatusLine.getStatusCode shouldBe 200
 
@@ -59,7 +62,7 @@ class ServerInstrumentationSpec extends WordSpec
 
  span.operationName shouldBe "sync.tracing.ok.get"
  spanTags("span.kind") shouldBe "server"
- spanTags("component") shouldBe "servlet.server"
+ spanTags("component") shouldBe "spring-server"
  spanTags("http.method") shouldBe "GET"
  spanTags("http.url") shouldBe "/sync/tracing/ok"
  span.tags("http.status_code") shouldBe TagValue.Number(200)
@@ -68,7 +71,7 @@ class ServerInstrumentationSpec extends WordSpec
  }
  }
 
- "propagate the current context and respond to the not-found action" in {
+ "propagate the current context and respond to the not-found endpoint" in {
 
  get("/sync/tracing/not-found").getStatusLine.getStatusCode shouldBe 404
 
@@ -78,7 +81,7 @@ class ServerInstrumentationSpec extends WordSpec
 
  span.operationName shouldBe "not-found"
  spanTags("span.kind") shouldBe "server"
- spanTags("component") shouldBe "servlet.server"
+ spanTags("component") shouldBe "spring-server"
  spanTags("http.method") shouldBe "GET"
  spanTags("http.url") shouldBe "/sync/tracing/not-found"
  span.tags("http.status_code") shouldBe TagValue.Number(404)
@@ -87,7 +90,7 @@ class ServerInstrumentationSpec extends WordSpec
  }
  }
 
- "propagate the current context and respond to the error action" in {
+ "propagate the current context and respond to the error endpoint" in {
  get("/sync/tracing/error").getStatusLine.getStatusCode shouldBe 500
 
  eventually(timeout(3 seconds)) {
@@ -96,7 +99,7 @@ class ServerInstrumentationSpec extends WordSpec
 
  span.operationName shouldBe "sync.tracing.error.get"
  spanTags("span.kind") shouldBe "server"
- spanTags("component") shouldBe "servlet.server"
+ spanTags("component") shouldBe "spring-server"
  spanTags("http.method") shouldBe "GET"
  spanTags("http.url") shouldBe "/sync/tracing/error"
  span.tags("error") shouldBe TagValue.True
@@ -106,26 +109,45 @@ class ServerInstrumentationSpec extends WordSpec
  }
  }
 
- "propagate the current context and respond to the error action produced with an internal exception" in {
- get("/sync/tracing/unhandled-error").getStatusLine.getStatusCode shouldBe 500
+ "propagate the current context and respond to the exception endpoint produced with abnormal termination" in {
+ get("/sync/tracing/exception").getStatusLine.getStatusCode shouldBe 200
 
  eventually(timeout(3 seconds)) {
  val span = reporter.nextSpan().value
  val spanTags = stringTag(span) _
 
- span.operationName shouldBe "sync.tracing.unhandled-error.get"
+ span.operationName shouldBe "sync.tracing.exception.get"
  spanTags("span.kind") shouldBe "server"
- spanTags("component") shouldBe "servlet.server"
+ spanTags("component") shouldBe "spring-server"
  spanTags("http.method") shouldBe "GET"
- spanTags("http.url") shouldBe "/sync/tracing/unhandled-error"
+ spanTags("http.url") shouldBe "/sync/tracing/exception"
  span.tags("error") shouldBe TagValue.True
  span.tags("http.status_code") shouldBe TagValue.Number(500)
+ }
+ }
+ "propagate the current context and respond to the slowly endpoint" in {
+
+ get("/sync/tracing/slowly").getStatusLine.getStatusCode shouldBe 200
+
+ eventually(timeout(3 seconds)) {
+
+ val span = reporter.nextSpan().value
+ val spanTags = stringTag(span) _
+
+ span.operationName shouldBe "sync.tracing.slowly.get"
+ spanTags("span.kind") shouldBe "server"
+ spanTags("component") shouldBe "spring-server"
+ spanTags("http.method") shouldBe "GET"
+ spanTags("http.url") shouldBe "/sync/tracing/slowly"
+ span.tags("http.status_code") shouldBe TagValue.Number(200)
+
+ span.context.parentID.string shouldBe ""
 
- // span.from.until(span.to, ChronoUnit.MILLIS) shouldBe >= (servlet.durationError.toLong)
+ span.from.until(span.to, ChronoUnit.MILLIS) shouldBe >= (SyncTracingController.slowlyServiceDuration.toMillis)
  }
  }
 
- "resume the incoming context and respond to the ok action" in {
+ "resume the incoming context and respond to the ok endpoint" in {
  get("/sync/tracing/ok", IncomingContext.headersB3).getStatusLine.getStatusCode shouldBe 200
 
  eventually(timeout(3 seconds)) {
@@ -135,7 +157,7 @@ class ServerInstrumentationSpec extends WordSpec
 
  span.operationName shouldBe "sync.tracing.ok.get"
  spanTags("span.kind") shouldBe "server"
- spanTags("component") shouldBe "servlet.server"
+ spanTags("component") shouldBe "spring-server"
  spanTags("http.method") shouldBe "GET"
  spanTags("http.url") shouldBe "/sync/tracing/ok"
  span.tags("http.status_code") shouldBe TagValue.Number(200)
@@ -150,7 +172,7 @@ class ServerInstrumentationSpec extends WordSpec
  span.tags(tag).asInstanceOf[TagValue.String].string
  }
 
- object IncomingContext {
+ private object IncomingContext {
  import kamon.trace.SpanCodec.B3.{Headers => B3Headers}
 
  val TraceId = "1234"