Merge branch 'wip/spray-client-tracing'

9 files changed, 212 insertions, 16 deletions

diff --git a/kamon-playground/src/main/scala/test/SimpleRequestProcessor.scala b/kamon-playground/src/main/scala/test/SimpleRequestProcessor.scala
index 1c1dba4f..53cd28ff 100644
--- a/kamon-playground/src/main/scala/test/SimpleRequestProcessor.scala
+++ b/kamon-playground/src/main/scala/test/SimpleRequestProcessor.scala
@@ -52,6 +52,12 @@ object SimpleRequestProcessor extends App with SimpleRoutingApp with RequestBuil
             Future.sequence(futures).map(l ⇒ "Ok")
           }
         }
+      } ~ {
+        path("site") {
+          complete {
+            pipeline(Get("http://localhost:4000/"))
+          }
+        }
       } ~
         path("reply" / Segment) { reqID ⇒
           uow {
@@ -116,3 +122,16 @@ class Replier extends Actor with ActorLogging {
       sender ! anything
   }
 }
+
+object PingPong extends App {
+  val system = ActorSystem()
+  val pinger = system.actorOf(Props(new Actor {
+    def receive: Actor.Receive = { case "pong" => sender ! "ping" }
+  }))
+  val ponger = system.actorOf(Props(new Actor {
+    def receive: Actor.Receive = { case "ping" => sender ! "pong" }
+  }))
+
+  pinger.tell("pong", ponger)
+
+}
diff --git a/kamon-spray/src/main/resources/META-INF/aop.xml b/kamon-spray/src/main/resources/META-INF/aop.xml
index afbbb8c0..8324617b 100644
--- a/kamon-spray/src/main/resources/META-INF/aop.xml
+++ b/kamon-spray/src/main/resources/META-INF/aop.xml
@@ -5,6 +5,7 @@
 
   <aspects>
     <aspect name="spray.can.server.ServerRequestTracing"/>
+    <aspect name="spray.can.client.ClientRequestTracing"/>
     <include within="spray..*"/>
   </aspects>
 </aspectj>
diff --git a/kamon-spray/src/main/scala/spray/can/client/ClientRequestTracing.scala b/kamon-spray/src/main/scala/spray/can/client/ClientRequestTracing.scala
new file mode 100644
index 00000000..b081bf00
--- /dev/null
+++ b/kamon-spray/src/main/scala/spray/can/client/ClientRequestTracing.scala
@@ -0,0 +1,88 @@
+/* ===================================================
+ * Copyright © 2013 the kamon project <http://kamon.io/>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ========================================================== */
+
+package spray.can.client
+
+import org.aspectj.lang.annotation._
+import org.aspectj.lang.ProceedingJoinPoint
+import spray.http.{HttpMessageEnd, HttpRequest}
+import spray.http.HttpHeaders.Host
+import kamon.trace.{TraceContext, Trace, Segments}
+import kamon.trace.Segments.{ContextAndSegmentCompletionAware, HttpClientRequest}
+import kamon.trace.Trace.SegmentCompletionHandle
+
+@Aspect
+class ClientRequestTracing {
+
+  @DeclareMixin("spray.can.client.HttpHostConnector.RequestContext")
+  def mixin: ContextAndSegmentCompletionAware = new ContextAndSegmentCompletionAware {
+    val traceContext: Option[TraceContext] = Trace.context()
+    var completionHandle: Option[SegmentCompletionHandle] = None
+  }
+
+
+  @Pointcut("execution(spray.can.client.HttpHostConnector.RequestContext.new(..)) && this(ctx) && args(request, *, *, *)")
+  def requestContextCreation(ctx: ContextAndSegmentCompletionAware, request: HttpRequest): Unit = {}
+
+  @After("requestContextCreation(ctx, request)")
+  def afterRequestContextCreation(ctx: ContextAndSegmentCompletionAware, request: HttpRequest): Unit = {
+    // The RequestContext will be copied when a request needs to be retried but we are only interested in creating the
+    // completion handle the first time we create one.
+
+    // The read to ctx.completionHandle should take care of initializing the aspect timely.
+    if(ctx.completionHandle.isEmpty) {
+      val requestAttributes = Map[String, String](
+        "host" -> request.header[Host].map(_.value).getOrElse("unknown"),
+        "path" -> request.uri.path.toString(),
+        "method" -> request.method.toString()
+      )
+      val completionHandle = Trace.startSegment(category = HttpClientRequest, attributes = requestAttributes)
+      ctx.completionHandle = Some(completionHandle)
+    }
+  }
+
+
+  @Pointcut("execution(* spray.can.client.HttpHostConnector.RequestContext.copy(..)) && this(old)")
+  def copyingRequestContext(old: ContextAndSegmentCompletionAware): Unit = {}
+
+  @Around("copyingRequestContext(old)")
+  def aroundCopyingRequestContext(pjp: ProceedingJoinPoint, old: ContextAndSegmentCompletionAware) = {
+    Trace.withContext(old.traceContext) {
+      pjp.proceed()
+    }
+  }
+
+
+  @Pointcut("execution(* spray.can.client.HttpHostConnectionSlot.dispatchToCommander(..)) && args(requestContext, message)")
+  def dispatchToCommander(requestContext: ContextAndSegmentCompletionAware, message: Any): Unit = {}
+
+  @Around("dispatchToCommander(requestContext, message)")
+  def aroundDispatchToCommander(pjp: ProceedingJoinPoint, requestContext: ContextAndSegmentCompletionAware, message: Any) = {
+    requestContext.traceContext match {
+      case ctx @ Some(_) =>
+        Trace.withContext(ctx) {
+          if(message.isInstanceOf[HttpMessageEnd])
+            requestContext.completionHandle.map(_.complete(Segments.End()))
+
+          pjp.proceed()
+        }
+
+      case None => pjp.proceed()
+    }
+  }
+
+
+}
\ No newline at end of file
diff --git a/kamon-spray/src/test/scala/kamon/spray/ClientRequestTracingSpec.scala b/kamon-spray/src/test/scala/kamon/spray/ClientRequestTracingSpec.scala
new file mode 100644
index 00000000..393ae6ff
--- /dev/null
+++ b/kamon-spray/src/test/scala/kamon/spray/ClientRequestTracingSpec.scala
@@ -0,0 +1,31 @@
+package kamon.spray
+
+import akka.testkit.TestKit
+import akka.actor.ActorSystem
+import org.scalatest.WordSpecLike
+import spray.httpx.RequestBuilding
+import spray.client.pipelining._
+import kamon.trace.{UowTrace, Trace}
+import scala.concurrent.Await
+
+class ClientRequestTracingSpec extends TestKit(ActorSystem("server-request-tracing-spec")) with WordSpecLike with RequestBuilding with TestServer {
+  implicit val ec = system.dispatcher
+
+
+  "the client instrumentation" should {
+    "record segments for a client http request" in {
+
+      Trace.start("record-segments")(system)
+
+      send {
+        Get(s"http://127.0.0.1:$port/ok")
+
+      // We don't care about the response, just make sure we finish the Trace after the response has been received.
+      } map(rsp => Trace.finish())
+
+      val trace = expectMsgType[UowTrace]
+      println(trace.segments)
+    }
+  }
+
+}
diff --git a/kamon-spray/src/test/scala/kamon/ServerRequestTracingSpec.scala b/kamon-spray/src/test/scala/kamon/spray/ServerRequestTracingSpec.scala
index d598431a..e54fe24f 100644
--- a/kamon-spray/src/test/scala/kamon/ServerRequestTracingSpec.scala
+++ b/kamon-spray/src/test/scala/kamon/spray/ServerRequestTracingSpec.scala
@@ -13,20 +13,19 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  * ========================================================== */
-package kamon
+package kamon.spray
 
 import _root_.spray.httpx.RequestBuilding
 import _root_.spray.routing.SimpleRoutingApp
 import akka.testkit.TestKit
-import akka.actor.{ActorRef, ActorSystem}
+import akka.actor.ActorSystem
 import org.scalatest.WordSpecLike
 import scala.concurrent.Await
 import scala.concurrent.duration._
 import _root_.spray.client.pipelining._
 import akka.util.Timeout
-import kamon.trace.Trace
-import kamon.Kamon.Extension
-import kamon.trace.UowTracing.{Finish, Start}
+import kamon.trace.{UowTrace, Trace}
+import kamon.Kamon
 
 class ServerRequestTracingSpec extends TestKit(ActorSystem("server-request-tracing-spec")) with WordSpecLike with RequestBuilding with TestServer {
 
@@ -37,8 +36,7 @@ class ServerRequestTracingSpec extends TestKit(ActorSystem("server-request-traci
       }
 
       within(5 seconds) {
-        val traceId = expectMsgPF() { case Start(id, _) => id}
-        expectMsgPF() { case Finish(traceId) => }
+        fishForNamedTrace("ok")
       }
     }
 
@@ -48,9 +46,7 @@ class ServerRequestTracingSpec extends TestKit(ActorSystem("server-request-traci
       }
 
       within(5 seconds) {
-        val traceId = expectMsgPF() { case Start(id, _) => id }
-        println("Expecting for trace: " + traceId)
-        expectMsgPF() { case Finish(traceId) => }
+        fishForNamedTrace("clearcontext")
       }
     }
 
@@ -60,19 +56,21 @@ class ServerRequestTracingSpec extends TestKit(ActorSystem("server-request-traci
       }
 
       within(5 seconds) {
-        expectMsgPF() { case Start(_, "GET: /accounts") => }
+        fishForNamedTrace("accounts")
       }
     }
   }
+
+  def fishForNamedTrace(traceName: String) = fishForMessage() {
+    case trace: UowTrace if trace.name.contains(traceName) => true
+    case _ => false
+  }
 }
 
 trait TestServer extends SimpleRoutingApp {
   self: TestKit =>
 
-  // Nasty, but very helpful for tests.
-  AkkaExtensionSwap.swap(system, Trace, new Extension {
-    def manager: ActorRef = testActor
-  })
+  Kamon(Trace).tell(Trace.Register, testActor)
 
   implicit val timeout = Timeout(20 seconds)
   val port: Int = Await.result(
diff --git a/kamon-trace/src/main/scala/kamon/trace/Segments.scala b/kamon-trace/src/main/scala/kamon/trace/Segments.scala
new file mode 100644
index 00000000..7cc20181
--- /dev/null
+++ b/kamon-trace/src/main/scala/kamon/trace/Segments.scala
@@ -0,0 +1,41 @@
+/* ===================================================
+ * Copyright © 2013 the kamon project <http://kamon.io/>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ========================================================== */
+
+package kamon.trace
+
+import kamon.trace.Trace.SegmentCompletionHandle
+
+object Segments {
+  
+  trait Category
+  case object HttpClientRequest extends Category
+  
+  case class Start(category: Category, description: String = "",
+                          attributes: Map[String, String] = Map(), timestamp: Long = System.nanoTime())
+  
+  case class End(attributes: Map[String, String] = Map(), timestamp: Long = System.nanoTime())
+  
+  case class Segment(start: Start, end: End)
+
+
+
+
+  trait SegmentCompletionHandleAware {
+    var completionHandle: Option[SegmentCompletionHandle]
+  }
+
+  trait ContextAndSegmentCompletionAware extends ContextAware with SegmentCompletionHandleAware
+}
diff --git a/kamon-trace/src/main/scala/kamon/trace/Trace.scala b/kamon-trace/src/main/scala/kamon/trace/Trace.scala
index 05519067..6eff69e5 100644
--- a/kamon-trace/src/main/scala/kamon/trace/Trace.scala
+++ b/kamon-trace/src/main/scala/kamon/trace/Trace.scala
@@ -60,6 +60,23 @@ object Trace extends ExtensionId[TraceExtension] with ExtensionIdProvider {
 
   // TODO: FIX
   def newTraceContext(name: String)(implicit system: ActorSystem): TraceContext = TraceContext(Kamon(Trace), tranid.getAndIncrement, name)
+
+  def startSegment(category: Segments.Category, description: String = "", attributes: Map[String, String] = Map()): SegmentCompletionHandle = {
+    val start = Segments.Start(category, description, attributes)
+    SegmentCompletionHandle(start)
+  }
+
+  def startSegment(start: Segments.Start): SegmentCompletionHandle = SegmentCompletionHandle(start)
+
+  case class SegmentCompletionHandle(start: Segments.Start) {
+    def complete(): Unit = {
+      val end = Segments.End()
+      println(s"Completing the Segment: $start - $end")
+    }
+    def complete(end: Segments.End): Unit = {
+      println(s"Completing the Segment: $start - $end")
+    }
+  }
 }
 
 class TraceExtension(system: ExtendedActorSystem) extends Kamon.Extension {
diff --git a/kamon-trace/src/main/scala/kamon/trace/TraceContext.scala b/kamon-trace/src/main/scala/kamon/trace/TraceContext.scala
index eee3e0b0..3698cea1 100644
--- a/kamon-trace/src/main/scala/kamon/trace/TraceContext.scala
+++ b/kamon-trace/src/main/scala/kamon/trace/TraceContext.scala
@@ -23,7 +23,7 @@ import kamon.Kamon
 import kamon.trace.UowTracing.{ Finish, Start }
 
 // TODO: Decide if we need or not an ID, generating it takes time and it doesn't seem necessary.
-protected[kamon] case class TraceContext(private val collector: ActorRef, id: Long, uow: String = "", userContext: Option[Any] = None) {
+case class TraceContext(private val collector: ActorRef, id: Long, uow: String = "", userContext: Option[Any] = None) {
 
   def start(name: String) = collector ! Start(id, name)
 
diff --git a/kamon-trace/src/main/scala/kamon/trace/UowTracing.scala b/kamon-trace/src/main/scala/kamon/trace/UowTracing.scala
index 3d1a7778..7026569c 100644
--- a/kamon-trace/src/main/scala/kamon/trace/UowTracing.scala
+++ b/kamon-trace/src/main/scala/kamon/trace/UowTracing.scala
@@ -19,6 +19,7 @@ import akka.actor._
 import scala.concurrent.duration.Duration
 import kamon.trace.UowTracing._
 
+
 sealed trait UowSegment {
   def id: Long
   def timestamp: Long