+ kamon-play-25: add play 2.5.x support

Author: dspasojevic

kamon-play-2.5.x/src/main/resources/META-INF/aop.xml

@@ -0,0 +1,13 @@
+<!DOCTYPE aspectj PUBLIC "-//AspectJ//DTD//EN" "http://www.eclipse.org/aspectj/dtd/aspectj.dtd">
+
+<aspectj>
+  <aspects>
+    <aspect name="kamon.play.instrumentation.RequestInstrumentation"/>
+    <aspect name="kamon.play.instrumentation.WSInstrumentation"/>
+    <aspect name="kamon.play.instrumentation.LoggerLikeInstrumentation"/>
+  </aspects>
+
+   <weaver>
+       <include within="play.api..*"/>
+   </weaver>
+</aspectj>

kamon-play-2.5.x/src/main/resources/reference.conf

@@ -0,0 +1,34 @@
+# ================================== #
+# Kamon-Play Reference Configuration #
+# ================================== #
+
+kamon {
+  play {
+
+    # Header name used when propagating the `TraceContext.token` value across applications.
+    trace-token-header-name = "X-Trace-Token"
+
+    # When set to true, Kamon will automatically set and propogate the `TraceContext.token` value under the following
+    # conditions:
+    #  - When a server side request is received containing the trace token header, the new `TraceContext` will have that
+    #    some token, and once the response to that request is ready, the trace token header is also included in the
+    #    response.
+    #  - When a WS client request is issued and a `TraceContext` is available, the trace token header will be included
+    #    in the request headers.
+    automatic-trace-token-propagation = true
+
+    # Fully qualified name of the implementation of kamon.play.NameGenerator that will be used for assigning names
+    # to traces and client http segments.
+    name-generator = kamon.play.DefaultNameGenerator
+
+  }
+
+  modules {
+    kamon-play {
+      requires-aspectj = yes
+    }
+  }
+}
+
+#register the module with Play
+play.modules.enabled += "kamon.play.di.KamonModule"

kamon-play-2.5.x/src/main/scala/kamon/play/KamonFilter.scala

@@ -0,0 +1,47 @@
+/*
+ * =========================================================================================
+ * 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
+
+import akka.util.ByteString
+import kamon.trace.Tracer
+import kamon.util.SameThreadExecutionContext
+import play.api.libs.streams.Accumulator
+import play.api.mvc.{ EssentialAction, EssentialFilter, RequestHeader, Result }
+
+class KamonFilter extends EssentialFilter {
+
+  override def apply(next: EssentialAction): EssentialAction = new EssentialAction {
+    override def apply(requestHeader: RequestHeader): Accumulator[ByteString, Result] = {
+
+      def onResult(result: Result): Result = {
+        Tracer.currentContext.collect { ctx ⇒
+          ctx.finish()
+          PlayExtension.httpServerMetrics.recordResponse(ctx.name, result.header.status.toString)
+          if (PlayExtension.includeTraceToken) result.withHeaders(PlayExtension.traceTokenHeaderName -> ctx.token)
+          else result
+
+        } getOrElse result
+      }
+
+      //override the current trace name
+      Tracer.currentContext.rename(PlayExtension.generateTraceName(requestHeader))
+      val nextAccumulator = next.apply(requestHeader)
+      nextAccumulator.map(onResult)(SameThreadExecutionContext)
+    }
+  }
+
+}

kamon-play-2.5.x/src/main/scala/kamon/play/Play.scala

@@ -0,0 +1,76 @@
+/*
+ * =========================================================================================
+ * 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
+
+import akka.actor._
+import kamon.Kamon
+import kamon.util.http.HttpServerMetrics
+import kamon.util.logger.LazyLogger
+import play.api.libs.ws.WSRequest
+import play.api.mvc.RequestHeader
+
+object PlayExtension {
+  val SegmentLibraryName = "WS-client"
+
+  val log = LazyLogger("kamon.play.PlayExtension")
+
+  private val config = Kamon.config.getConfig("kamon.play")
+  private val dynamic = new ReflectiveDynamicAccess(getClass.getClassLoader)
+  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 = dynamic.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.routing.Router
+  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(Router.Tags.RouteVerb).map { verb ⇒
+    val path = requestHeader.tags(Router.Tags.RoutePattern)
+    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.exists(_ != '.')) s"$p."
+          else p
+        }
+        s"$normalisedPath${verb.toLowerCase(Locale.ENGLISH)}"
+      }
+      traceName
+    })
+  } getOrElse "UntaggedTrace"
+
+  def generateHttpClientSegmentName(request: WSRequest): String = request.uri.getAuthority
+}

kamon-play-2.5.x/src/main/scala/kamon/play/action/KamonTraceActions.scala

@@ -0,0 +1,29 @@
+/* ===================================================
+ * 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.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
+}

kamon-play-2.5.x/src/main/scala/kamon/play/di/KamonModule.scala

@@ -0,0 +1,54 @@
+/* =========================================================================================
+ * 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.di
+
+import javax.inject._
+import kamon.metric.MetricsModule
+import kamon.trace.TracerModule
+import play.api.inject.{ ApplicationLifecycle, Module }
+import play.api.{ Logger, Configuration, Environment }
+import scala.concurrent.Future
+
+trait Kamon {
+  def start(): Unit
+  def shutdown(): Unit
+  def metrics(): MetricsModule
+  def tracer(): TracerModule
+}
+
+class KamonModule extends Module {
+  def bindings(environment: Environment, configuration: Configuration) = {
+    Seq(bind[Kamon].to[KamonAPI].eagerly())
+  }
+}
+
+@Singleton
+class KamonAPI @Inject() (lifecycle: ApplicationLifecycle, environment: Environment) extends Kamon {
+  private val log = Logger(classOf[KamonAPI])
+
+  log.info("Registering the Kamon Play Module.")
+
+  start() //force to start kamon eagerly on application startup
+
+  def start(): Unit = kamon.Kamon.start()
+  def shutdown(): Unit = kamon.Kamon.shutdown()
+  def metrics(): MetricsModule = kamon.Kamon.metrics
+  def tracer(): TracerModule = kamon.Kamon.tracer
+
+  lifecycle.addStopHook { () ⇒
+    Future.successful(shutdown())
+  }
+}

kamon-play-2.5.x/src/main/scala/kamon/play/instrumentation/LoggerLikeInstrumentation.scala

@@ -0,0 +1,45 @@
+/* =========================================================================================
+ * 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.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+.debug(..))")
+  def debugPointcut(): 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() || debugPointcut() || warnPointcut() || errorPointcut() || tracePointcut())")
+  def aroundLog(pjp: ProceedingJoinPoint): Any = withMdc {
+    pjp.proceed()
+  }
+}
+

kamon-play-2.5.x/src/main/scala/kamon/play/instrumentation/RequestInstrumentation.scala

@@ -0,0 +1,64 @@
+/* =========================================================================================
+ * 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 akka.util.ByteString
+import kamon.Kamon.tracer
+import kamon.play.{ KamonFilter, PlayExtension }
+import kamon.trace._
+import kamon.util.SameThreadExecutionContext
+import org.aspectj.lang.ProceedingJoinPoint
+import org.aspectj.lang.annotation._
+import play.api.libs.streams.Accumulator
+import play.api.mvc.Results._
+import play.api.mvc.{ EssentialFilter, _ }
+
+@Aspect
+class RequestInstrumentation {
+
+  private lazy val filter: EssentialFilter = new KamonFilter()
+
+  @DeclareMixin("play.api.mvc.RequestHeader+")
+  def mixinContextAwareToRequestHeader: TraceContextAware = TraceContextAware.default
+
+  @Before("call(* play.api.http.DefaultHttpRequestHandler.routeRequest(..)) && args(requestHeader)")
+  def routeRequest(requestHeader: RequestHeader): Unit = {
+    val token = if (PlayExtension.includeTraceToken) {
+      requestHeader.headers.get(PlayExtension.traceTokenHeaderName)
+    } else None
+
+    Tracer.setCurrentContext(tracer.newContext("UnnamedTrace", token))
+  }
+
+  @Around("call(* play.api.http.HttpFilters.filters(..))")
+  def filters(pjp: ProceedingJoinPoint): Any = {
+    pjp.proceed().asInstanceOf[Seq[EssentialFilter]] :+ filter
+  }
+
+  @Before("call(* play.api.http.HttpErrorHandler.onClientServerError(..)) && args(requestContextAware, statusCode, *)")
+  def onClientError(requestContextAware: TraceContextAware, statusCode: Int): Unit = {
+    requestContextAware.traceContext.collect { ctx ⇒
+      PlayExtension.httpServerMetrics.recordResponse(ctx.name, statusCode.toString)
+    }
+  }
+
+  @Before("call(* play.api.http.HttpErrorHandler.onServerError(..)) && args(requestContextAware, ex)")
+  def onServerError(requestContextAware: TraceContextAware, ex: Throwable): Unit = {
+    requestContextAware.traceContext.collect { ctx ⇒
+      PlayExtension.httpServerMetrics.recordResponse(ctx.name, InternalServerError.header.status.toString)
+    }
+  }
+}