+ play: play-2.4.x support

5 files changed, 299 insertions, 0 deletions

diff --git a/kamon-play-2.3.x/src/main/scala/kamon/play/Play.scala b/kamon-play-2.3.x/src/main/scala/kamon/play/Play.scala
new file mode 100644
index 00000000..d9fdfea8
--- /dev/null
+++ b/kamon-play-2.3.x/src/main/scala/kamon/play/Play.scala
@@ -0,0 +1,81 @@
+/*
+ * =========================================================================================
+ * Copyright © 2013-2014 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.play
+
+import akka.actor.{ ExtendedActorSystem, Extension, ExtensionId, ExtensionIdProvider }
+import akka.event.Logging
+import kamon.Kamon
+import kamon.http.HttpServerMetrics
+import play.api.libs.ws.WSRequest
+import play.api.mvc.RequestHeader
+
+object Play extends ExtensionId[PlayExtension] with ExtensionIdProvider {
+  override def lookup(): ExtensionId[_ <: Extension] = Play
+  override def createExtension(system: ExtendedActorSystem): PlayExtension = new PlayExtension(system)
+
+  val SegmentLibraryName = "WS-client"
+}
+
+class PlayExtension(private val system: ExtendedActorSystem) extends Kamon.Extension {
+  val log = Logging(system, classOf[PlayExtension])
+  log.info(s"Starting the Kamon(Play) extension")
+
+  private val config = system.settings.config.getConfig("kamon.play")
+  val httpServerMetrics = Kamon.metrics.entity(HttpServerMetrics, "play-server")
+
+  val includeTraceToken: Boolean = config.getBoolean("automatic-trace-token-propagation")
+  val traceTokenHeaderName: String = config.getString("trace-token-header-name")
+
+  private val nameGeneratorFQN = config.getString("name-generator")
+  private val nameGenerator: NameGenerator = system.dynamicAccess.createInstanceFor[NameGenerator](nameGeneratorFQN, Nil).get
+
+  def generateTraceName(requestHeader: RequestHeader): String = nameGenerator.generateTraceName(requestHeader)
+  def generateHttpClientSegmentName(request: WSRequest): String = nameGenerator.generateHttpClientSegmentName(request)
+}
+
+trait NameGenerator {
+  def generateTraceName(requestHeader: RequestHeader): String
+  def generateHttpClientSegmentName(request: WSRequest): String
+}
+
+class DefaultNameGenerator extends NameGenerator {
+  import scala.collection.concurrent.TrieMap
+  import play.api.Routes
+  import java.util.Locale
+  import kamon.util.TriemapAtomicGetOrElseUpdate.Syntax
+
+  private val cache = TrieMap.empty[String, String]
+  private val normalizePattern = """\$([^<]+)<[^>]+>""".r
+
+  def generateTraceName(requestHeader: RequestHeader): String = requestHeader.tags.get(Routes.ROUTE_VERB).map { verb ⇒
+    val path = requestHeader.tags(Routes.ROUTE_PATTERN)
+    cache.atomicGetOrElseUpdate(s"$verb$path", {
+      val traceName = {
+        // Convert paths of form GET /foo/bar/$paramname<regexp>/blah to foo.bar.paramname.blah.get
+        val p = normalizePattern.replaceAllIn(path, "$1").replace('/', '.').dropWhile(_ == '.')
+        val normalisedPath = {
+          if (p.lastOption.filter(_ != '.').isDefined) s"$p."
+          else p
+        }
+        s"$normalisedPath${verb.toLowerCase(Locale.ENGLISH)}"
+      }
+      traceName
+    })
+  } getOrElse s"${requestHeader.method}: ${requestHeader.uri}"
+
+  def generateHttpClientSegmentName(request: WSRequest): String = request.url
+}
diff --git a/kamon-play-2.3.x/src/main/scala/kamon/play/action/KamonTraceActions.scala b/kamon-play-2.3.x/src/main/scala/kamon/play/action/KamonTraceActions.scala
new file mode 100644
index 00000000..854989a4
--- /dev/null
+++ b/kamon-play-2.3.x/src/main/scala/kamon/play/action/KamonTraceActions.scala
@@ -0,0 +1,29 @@
+/* ===================================================
+ * Copyright © 2013-2014 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.play.action
+
+import kamon.trace.Tracer
+import play.api.mvc._
+import scala.concurrent.Future
+
+case class TraceName[A](name: String)(action: Action[A]) extends Action[A] {
+  def apply(request: Request[A]): Future[Result] = {
+    Tracer.currentContext.rename(name)
+    action(request)
+  }
+  lazy val parser = action.parser
+}
diff --git a/kamon-play-2.3.x/src/main/scala/kamon/play/instrumentation/LoggerLikeInstrumentation.scala b/kamon-play-2.3.x/src/main/scala/kamon/play/instrumentation/LoggerLikeInstrumentation.scala
new file mode 100644
index 00000000..3c79fae4
--- /dev/null
+++ b/kamon-play-2.3.x/src/main/scala/kamon/play/instrumentation/LoggerLikeInstrumentation.scala
@@ -0,0 +1,42 @@
+/* =========================================================================================
+ * Copyright © 2013-2014 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.play.instrumentation
+
+import kamon.trace.logging.MdcKeysSupport
+import org.aspectj.lang.ProceedingJoinPoint
+import org.aspectj.lang.annotation._
+
+@Aspect
+class LoggerLikeInstrumentation extends MdcKeysSupport {
+
+  @Pointcut("execution(* play.api.LoggerLike+.info(..))")
+  def infoPointcut(): Unit = {}
+
+  @Pointcut("execution(* play.api.LoggerLike+.warn(..))")
+  def warnPointcut(): Unit = {}
+
+  @Pointcut("execution(* play.api.LoggerLike+.error(..))")
+  def errorPointcut(): Unit = {}
+
+  @Pointcut("execution(* play.api.LoggerLike+.trace(..))")
+  def tracePointcut(): Unit = {}
+
+  @Around("(infoPointcut() || warnPointcut() || errorPointcut() || tracePointcut())")
+  def aroundLog(pjp: ProceedingJoinPoint): Any = withMdc {
+    pjp.proceed()
+  }
+}
+
diff --git a/kamon-play-2.3.x/src/main/scala/kamon/play/instrumentation/RequestInstrumentation.scala b/kamon-play-2.3.x/src/main/scala/kamon/play/instrumentation/RequestInstrumentation.scala
new file mode 100644
index 00000000..7dcb7913
--- /dev/null
+++ b/kamon-play-2.3.x/src/main/scala/kamon/play/instrumentation/RequestInstrumentation.scala
@@ -0,0 +1,101 @@
+/* =========================================================================================
+ * Copyright © 2013-2015 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.play.instrumentation
+
+import kamon.Kamon
+import kamon.play.Play
+import kamon.trace.TraceLocal.{ HttpContext, HttpContextKey }
+import kamon.trace._
+import kamon.util.SameThreadExecutionContext
+import org.aspectj.lang.ProceedingJoinPoint
+import org.aspectj.lang.annotation._
+import play.api.mvc.Results._
+import play.api.mvc._
+
+@Aspect
+class RequestInstrumentation {
+
+  import RequestInstrumentation._
+
+  @DeclareMixin("play.api.mvc.RequestHeader+")
+  def mixinContextAwareNewRequest: TraceContextAware = TraceContextAware.default
+
+  @Before("call(* play.api.GlobalSettings.onRouteRequest(..)) && args(requestHeader)")
+  def beforeRouteRequest(requestHeader: RequestHeader): Unit = {
+    import Kamon.tracer
+
+    val playExtension = Kamon(Play)
+
+    val token = if (playExtension.includeTraceToken) {
+      requestHeader.headers.get(playExtension.traceTokenHeaderName)
+    } else None
+
+    Tracer.setCurrentContext(tracer.newContext("UnnamedTrace", token))
+  }
+
+  @Around("call(* play.api.GlobalSettings.doFilter(*)) && args(next)")
+  def aroundDoFilter(pjp: ProceedingJoinPoint, next: EssentialAction): Any = {
+    val essentialAction = (requestHeader: RequestHeader) ⇒ {
+
+      val playExtension = Kamon(Play)
+
+      def onResult(result: Result): Result = {
+        Tracer.currentContext.collect { ctx ⇒
+          ctx.finish()
+
+          recordHttpServerMetrics(result.header, ctx.name)
+
+          if (playExtension.includeTraceToken) result.withHeaders(playExtension.traceTokenHeaderName -> ctx.token)
+          else result
+
+        } getOrElse result
+      }
+      //store in TraceLocal useful data to diagnose errors
+      storeDiagnosticData(requestHeader)
+
+      //override the current trace name
+      Tracer.currentContext.rename(playExtension.generateTraceName(requestHeader))
+
+      // Invoke the action
+      next(requestHeader).map(onResult)(SameThreadExecutionContext)
+    }
+
+    pjp.proceed(Array(EssentialAction(essentialAction)))
+  }
+
+  @Before("call(* play.api.GlobalSettings.onError(..)) && args(request, ex)")
+  def beforeOnError(request: TraceContextAware, ex: Throwable): Unit = {
+    Tracer.currentContext.collect { ctx ⇒
+      recordHttpServerMetrics(InternalServerError.header, ctx.name)
+    }
+  }
+
+  def recordHttpServerMetrics(header: ResponseHeader, traceName: String): Unit =
+    Kamon(Play).httpServerMetrics.recordResponse(traceName, header.status.toString)
+
+  def storeDiagnosticData(request: RequestHeader): Unit = {
+    val agent = request.headers.get(UserAgent).getOrElse(Unknown)
+    val forwarded = request.headers.get(XForwardedFor).getOrElse(Unknown)
+
+    TraceLocal.store(HttpContextKey)(HttpContext(agent, request.uri, forwarded))
+  }
+}
+
+object RequestInstrumentation {
+  val UserAgent = "User-Agent"
+  val XForwardedFor = "X-Forwarded-For"
+  val Unknown = "unknown"
+}
diff --git a/kamon-play-2.3.x/src/main/scala/kamon/play/instrumentation/WSInstrumentation.scala b/kamon-play-2.3.x/src/main/scala/kamon/play/instrumentation/WSInstrumentation.scala
new file mode 100644
index 00000000..66c933f6
--- /dev/null
+++ b/kamon-play-2.3.x/src/main/scala/kamon/play/instrumentation/WSInstrumentation.scala
@@ -0,0 +1,46 @@
+/* ===================================================
+ * Copyright © 2013-2014 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.play.instrumentation
+
+import kamon.Kamon
+import kamon.play.Play
+import kamon.trace.{ Tracer, SegmentCategory }
+import kamon.util.SameThreadExecutionContext
+import org.aspectj.lang.ProceedingJoinPoint
+import org.aspectj.lang.annotation.{ Around, Aspect, Pointcut }
+import play.api.libs.ws.{ WSRequest, WSResponse }
+import scala.concurrent.Future
+
+@Aspect
+class WSInstrumentation {
+
+  @Pointcut("execution(* play.api.libs.ws.ning.NingWSRequest.execute()) && this(request)")
+  def onExecuteRequest(request: WSRequest): Unit = {}
+
+  @Around("onExecuteRequest(request)")
+  def aroundExecuteRequest(pjp: ProceedingJoinPoint, request: WSRequest): Any = {
+    Tracer.currentContext.collect { ctx ⇒
+      val playExtension = Kamon(Play)
+      val segmentName = playExtension.generateHttpClientSegmentName(request)
+      val segment = ctx.startSegment(segmentName, SegmentCategory.HttpClient, Play.SegmentLibraryName)
+      val response = pjp.proceed().asInstanceOf[Future[WSResponse]]
+
+      response.onComplete(result ⇒ segment.finish())(SameThreadExecutionContext)
+      response
+    } getOrElse pjp.proceed()
+  }
+}
\ No newline at end of file