diff options
author | Diego <diegolparra@gmail.com> | 2014-02-28 16:32:13 -0300 |
---|---|---|
committer | Diego <diegolparra@gmail.com> | 2014-02-28 16:32:13 -0300 |
commit | 029fe5d1cc0f4b190fb382626edf954df11c6b00 (patch) | |
tree | f00123708a586a9972a4d8e4c6071a5057720a44 /kamon-play | |
parent | 753bd44440282141896a5f511c1fa53927acf511 (diff) | |
download | Kamon-029fe5d1cc0f4b190fb382626edf954df11c6b00.tar.gz Kamon-029fe5d1cc0f4b190fb382626edf954df11c6b00.tar.bz2 Kamon-029fe5d1cc0f4b190fb382626edf954df11c6b00.zip |
WIP: added tests to play requests instrumentation
Diffstat (limited to 'kamon-play')
6 files changed, 215 insertions, 2 deletions
diff --git a/kamon-play/src/main/resources/META-INF/aop.xml b/kamon-play/src/main/resources/META-INF/aop.xml index 3b3314d1..ca119c2b 100644 --- a/kamon-play/src/main/resources/META-INF/aop.xml +++ b/kamon-play/src/main/resources/META-INF/aop.xml @@ -2,7 +2,7 @@ <aspectj> <aspects> - <aspect name="kamon.play.filter.RequestTracing"/> + <aspect name="kamon.play.instrumentation.RequestInstrumentation"/> </aspects> <weaver options="-verbose -showWeaveInfo"> diff --git a/kamon-play/src/main/scala/kamon/play/Play.scala b/kamon-play/src/main/scala/kamon/play/Play.scala index da8622c0..2e1f789f 100644 --- a/kamon-play/src/main/scala/kamon/play/Play.scala +++ b/kamon-play/src/main/scala/kamon/play/Play.scala @@ -25,6 +25,11 @@ object Play extends ExtensionId[PlayExtension] with ExtensionIdProvider { } class PlayExtension(private val system: ExtendedActorSystem) extends Kamon.Extension { - println("Play extension loaded") + publishInfoMessage(system, "Play Extension Loaded!!") + private val config = system.settings.config.getConfig("kamon.play") + + val includeTraceToken: Boolean = config.getBoolean("include-trace-token-header") + val traceTokenHeaderName: String = config.getString("trace-token-header-name") } + diff --git a/kamon-play/src/main/scala/kamon/play/instrumentation/RequestInstrumentation.scala b/kamon-play/src/main/scala/kamon/play/instrumentation/RequestInstrumentation.scala new file mode 100644 index 00000000..a983cc17 --- /dev/null +++ b/kamon-play/src/main/scala/kamon/play/instrumentation/RequestInstrumentation.scala @@ -0,0 +1,91 @@ +/* =================================================== + * 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 org.aspectj.lang.annotation._ +import play.api.mvc._ +import kamon.trace.{ TraceRecorder, TraceContextAware } +import kamon.Kamon +import kamon.play.Play +import akka.actor.ActorSystem +import play.libs.Akka +import scala.Some +import org.aspectj.lang.ProceedingJoinPoint + +@Aspect +class RequestInstrumentation { + + @DeclareMixin("play.api.mvc.Request || play.api.mvc.WrappedRequest || play.api.test.FakeRequest") + def mixinContextAwareNewRequest: TraceContextAware = TraceContextAware.default + + @Pointcut("execution(* play.api.GlobalSettings+.onStart(*)) && args(application)") + def onStart(application: play.api.Application): Unit = {} + + @After("onStart(application)") + def afterApplicationStart(application: play.api.Application): Unit = { + Kamon(Play)(Akka.system()) + } + + @Pointcut("execution(* play.api.GlobalSettings+.onRouteRequest(*)) && args(request)") + def onRouteRequest(request: TraceContextAware): Unit = {} + + @After("onRouteRequest(request)") + def afterRouteRequest(request: TraceContextAware): Unit = { + val system: ActorSystem = Akka.system() + val playExtension = Kamon(Play)(system) + + val requestHeader: RequestHeader = request.asInstanceOf[RequestHeader] + val defaultTraceName: String = requestHeader.method + ": " + requestHeader.uri + val token = if (playExtension.includeTraceToken) { + requestHeader.headers.toSimpleMap.find(_._1 == playExtension.traceTokenHeaderName).map(_._2) + } else None + + TraceRecorder.start(defaultTraceName, token)(system) + + //Necessary to force initialization of traceContext when initiating the request. + request.traceContext + } + + @Pointcut("execution(* play.api.GlobalSettings+.doFilter(*)) && args(next)") + def doFilter(next: EssentialAction): Unit = {} + + @Around("doFilter(next)") + def afterDoFilter(pjp: ProceedingJoinPoint, next: EssentialAction): Any = { + Filters(pjp.proceed(Array(next)).asInstanceOf[EssentialAction], kamonRequestFilter) + } + + private[this] val kamonRequestFilter = Filter { (nextFilter, requestHeader) ⇒ + import scala.concurrent.ExecutionContext.Implicits.global + + val incomingContext = TraceRecorder.currentContext + + nextFilter(requestHeader).map { result ⇒ + TraceRecorder.finish() + + val simpleResult = incomingContext match { + case None ⇒ result + case Some(traceContext) ⇒ { + val playExtension = Kamon(Play)(traceContext.system) + if (playExtension.includeTraceToken) { + result.withHeaders(playExtension.traceTokenHeaderName -> traceContext.token) + } else result + } + } + simpleResult + } + } +} diff --git a/kamon-play/src/test/resources/conf/application.conf b/kamon-play/src/test/resources/conf/application.conf new file mode 100644 index 00000000..f2c654a8 --- /dev/null +++ b/kamon-play/src/test/resources/conf/application.conf @@ -0,0 +1,7 @@ +kamon { + play { + include-trace-token-header = true + trace-token-header-name = "X-UOW" + } +} + diff --git a/kamon-play/src/test/resources/logger.xml b/kamon-play/src/test/resources/logger.xml new file mode 100644 index 00000000..84126e9d --- /dev/null +++ b/kamon-play/src/test/resources/logger.xml @@ -0,0 +1,16 @@ +<configuration scan="true"> + <conversionRule conversionWord="traceToken" converterClass="kamon.trace.logging.LogbackTraceTokenConverter" /> + <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> + <encoder> + <pattern>%date{HH:mm:ss.SSS} %-5level [%traceToken][%X{akkaSource}] [%thread] %logger{55} - %msg%n</pattern> + </encoder> + </appender> + + <logger name="play" level="INFO" /> + <logger name="application" level="INFO" /> + + <root level="INFO"> + <appender-ref ref="STDOUT" /> + </root> + +</configuration> diff --git a/kamon-play/src/test/scala/kamon/play/filter/RequestInstrumentationSpec.scala b/kamon-play/src/test/scala/kamon/play/filter/RequestInstrumentationSpec.scala new file mode 100644 index 00000000..65f0219e --- /dev/null +++ b/kamon-play/src/test/scala/kamon/play/filter/RequestInstrumentationSpec.scala @@ -0,0 +1,94 @@ +/* =================================================== + * 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.filter + +import play.api.test._ +import play.api.mvc.{ Results, Action } +import play.api.mvc.Results.Ok +import scala.Some +import scala.concurrent.ExecutionContext.Implicits.global +import scala.concurrent.Future +import org.junit.runner.RunWith +import org.specs2.runner.JUnitRunner +import play.api.mvc.AsyncResult +import play.api.test.FakeApplication + +@RunWith(classOf[JUnitRunner]) +class RequestInstrumentationSpec extends PlaySpecification { + + System.setProperty("config.file", "./kamon-play/src/test/resources/conf/application.conf") + + val appWithRoutes = FakeApplication(withRoutes = { + case ("GET", "/asyncResult") ⇒ + Action { + AsyncResult { + scala.concurrent.Future { + Ok("AsyncResult") + } + } + } + case ("GET", "/async") ⇒ + Action.async { + Future { + Ok("Async.async") + } + } + case ("GET", "/notFound") ⇒ + Action { + Results.NotFound + } + case ("GET", "/redirect") ⇒ + Action { + Results.Redirect("/redirected", MOVED_PERMANENTLY) + } + case ("GET", "/default") ⇒ + Action { + Ok("default") + } + }) + + private val traceTokenValue = "kamon-trace-token-test" + private val traceTokenHeaderName = "X-UOW" + private val expectedToken = Some(traceTokenValue) + private val traceTokenHeader = (traceTokenHeaderName -> traceTokenValue) + + "respond to the asyncResult action with X-Trace-Token" in new WithServer(appWithRoutes) { + val Some(result) = route(FakeRequest(GET, "/asyncResult").withHeaders(traceTokenHeader)) + header(traceTokenHeaderName, result) must equalTo(expectedToken) + } + + "respond to the async action with X-Trace-Token" in new WithServer(appWithRoutes) { + val Some(result) = route(FakeRequest(GET, "/async").withHeaders(traceTokenHeader)) + header(traceTokenHeaderName, result) must equalTo(expectedToken) + } + + "respond to the notFound action with X-Trace-Token" in new WithServer(appWithRoutes) { + val Some(result) = route(FakeRequest(GET, "/notFound").withHeaders(traceTokenHeader)) + header(traceTokenHeaderName, result) must equalTo(expectedToken) + } + + "respond to the default action with X-Trace-Token" in new WithServer(appWithRoutes) { + val Some(result) = route(FakeRequest(GET, "/default").withHeaders(traceTokenHeader)) + header(traceTokenHeaderName, result) must equalTo(expectedToken) + } + + "respond to the redirect action with X-Trace-Token" in new WithServer(appWithRoutes) { + val Some(result) = route(FakeRequest(GET, "/redirect").withHeaders(traceTokenHeader)) + header("Location", result) must equalTo(Some("/redirected")) + header(traceTokenHeaderName, result) must equalTo(expectedToken) + } +}
\ No newline at end of file |