+ play, spray, newrelic: store in TraceLocal useful data to diagnose errors and closes #6

2 files changed, 25 insertions, 6 deletions

diff --git a/kamon-spray/src/main/scala/spray/can/server/ServerRequestInstrumentation.scala b/kamon-spray/src/main/scala/spray/can/server/ServerRequestInstrumentation.scala
index 93a9cf55..2bdd96e7 100644
--- a/kamon-spray/src/main/scala/spray/can/server/ServerRequestInstrumentation.scala
+++ b/kamon-spray/src/main/scala/spray/can/server/ServerRequestInstrumentation.scala
@@ -15,6 +15,7 @@
  * ========================================================== */
 package spray.can.server
 
+import kamon.trace.TraceLocal.{ HttpContext, HttpContextKey }
 import org.aspectj.lang.annotation._
 import kamon.trace._
 import akka.actor.ActorSystem
@@ -28,6 +29,8 @@ import spray.http.HttpHeaders.RawHeader
 @Aspect
 class ServerRequestInstrumentation {
 
+  import ServerRequestInstrumentation._
+
   @DeclareMixin("spray.can.server.OpenRequestComponent.DefaultOpenRequest")
   def mixinContextAwareToOpenRequest: TraceContextAware = TraceContextAware.default
 
@@ -83,7 +86,12 @@ class ServerRequestInstrumentation {
       } else pjp.proceed
 
       TraceRecorder.finish()
+
       recordHttpServerMetrics(response, incomingContext.name, sprayExtension)
+
+      //store in TraceLocal useful data to diagnose errors
+      storeDiagnosticData(openRequest)
+
       proceedResult
     }
   }
@@ -110,4 +118,19 @@ class ServerRequestInstrumentation {
       case response: HttpResponse ⇒ response.withHeaders(response.headers ::: RawHeader(traceTokenHeaderName, token) :: Nil)
       case other                  ⇒ other
     }
+
+  def storeDiagnosticData(currentContext: TraceContextAware): Unit = {
+    val request = currentContext.asInstanceOf[OpenRequest].request
+    val headers = request.headers.map(header ⇒ header.name -> header.value).toMap
+    val agent = headers.getOrElse(UserAgent, Unknown)
+    val forwarded = headers.getOrElse(XForwardedFor, Unknown)
+
+    TraceLocal.store(HttpContextKey)(HttpContext(agent, request.uri.toRelative.toString(), forwarded))
+  }
+}
+
+object ServerRequestInstrumentation {
+  val UserAgent = "User-Agent"
+  val XForwardedFor = "X-Forwarded-For"
+  val Unknown = "unknown"
 }
diff --git a/kamon-spray/src/test/scala/kamon/spray/SprayServerTracingSpec.scala b/kamon-spray/src/test/scala/kamon/spray/SprayServerTracingSpec.scala
index 48253b1d..30d42eea 100644
--- a/kamon-spray/src/test/scala/kamon/spray/SprayServerTracingSpec.scala
+++ b/kamon-spray/src/test/scala/kamon/spray/SprayServerTracingSpec.scala
@@ -24,11 +24,7 @@ import kamon.Kamon
 import org.scalatest.concurrent.{ PatienceConfiguration, ScalaFutures }
 import spray.http.HttpHeaders.RawHeader
 import spray.http.{ HttpResponse, HttpRequest }
-import kamon.metric.{ TraceMetrics, Metrics }
-import kamon.metric.Subscriptions.TickMetricSnapshot
 import com.typesafe.config.ConfigFactory
-import kamon.metric.TraceMetrics.ElapsedTime
-import kamon.metric.instrument.Histogram
 
 class SprayServerTracingSpec extends TestKitBase with WordSpecLike with Matchers with RequestBuilding
     with ScalaFutures with PatienceConfiguration with TestServer {
@@ -81,7 +77,7 @@ class SprayServerTracingSpec extends TestKitBase with WordSpecLike with Matchers
       server.reply(HttpResponse(entity = "ok"))
       val response = client.expectMsgType[HttpResponse]
 
-      response.headers.filter(_.name == Kamon(Spray).traceTokenHeaderName).size should be(1)
+      response.headers.count(_.name == Kamon(Spray).traceTokenHeaderName) should be(1)
 
     }
 
@@ -96,7 +92,7 @@ class SprayServerTracingSpec extends TestKitBase with WordSpecLike with Matchers
       server.reply(HttpResponse(entity = "ok"))
       val response = client.expectMsgType[HttpResponse]
 
-      response.headers should not contain (RawHeader(Kamon(Spray).traceTokenHeaderName, "propagation-disabled"))
+      response.headers should not contain RawHeader(Kamon(Spray).traceTokenHeaderName, "propagation-disabled")
     }
   }