diff options
Diffstat (limited to 'kamon-scala/src')
5 files changed, 238 insertions, 0 deletions
diff --git a/kamon-scala/src/main/resources/META-INF/aop.xml b/kamon-scala/src/main/resources/META-INF/aop.xml new file mode 100644 index 00000000..a1e98a9f --- /dev/null +++ b/kamon-scala/src/main/resources/META-INF/aop.xml @@ -0,0 +1,17 @@ +<!DOCTYPE aspectj PUBLIC "-//AspectJ//DTD//EN" "http://www.eclipse.org/aspectj/dtd/aspectj.dtd"> + +<aspectj> + <aspects> + + <!-- Futures --> + <aspect name="kamon.scala.instrumentation.FutureInstrumentation"/> + <aspect name="kamon.scalaz.instrumentation.FutureInstrumentation"/> + + </aspects> + + <weaver> + <include within="scala.concurrent..*"/> + <include within="scalaz.concurrent..*"/> + </weaver> + +</aspectj>
\ No newline at end of file diff --git a/kamon-scala/src/main/scala/kamon/scala/instrumentation/FutureInstrumentation.scala b/kamon-scala/src/main/scala/kamon/scala/instrumentation/FutureInstrumentation.scala new file mode 100644 index 00000000..01514869 --- /dev/null +++ b/kamon-scala/src/main/scala/kamon/scala/instrumentation/FutureInstrumentation.scala @@ -0,0 +1,48 @@ +/* + * ========================================================================================= + * 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.scala.instrumentation + +import kamon.trace.{ TraceContext, TraceContextAware } +import org.aspectj.lang.ProceedingJoinPoint +import org.aspectj.lang.annotation._ + +@Aspect +class FutureInstrumentation { + + @DeclareMixin("scala.concurrent.impl.CallbackRunnable || scala.concurrent.impl.Future.PromiseCompletingRunnable") + def mixinTraceContextAwareToFutureRelatedRunnable: TraceContextAware = TraceContextAware.default + + @Pointcut("execution((scala.concurrent.impl.CallbackRunnable || scala.concurrent.impl.Future.PromiseCompletingRunnable).new(..)) && this(runnable)") + def futureRelatedRunnableCreation(runnable: TraceContextAware): Unit = {} + + @After("futureRelatedRunnableCreation(runnable)") + def afterCreation(runnable: TraceContextAware): Unit = { + // Force traceContext initialization. + runnable.traceContext + } + + @Pointcut("execution(* (scala.concurrent.impl.CallbackRunnable || scala.concurrent.impl.Future.PromiseCompletingRunnable).run()) && this(runnable)") + def futureRelatedRunnableExecution(runnable: TraceContextAware) = {} + + @Around("futureRelatedRunnableExecution(runnable)") + def aroundExecution(pjp: ProceedingJoinPoint, runnable: TraceContextAware): Any = { + TraceContext.withContext(runnable.traceContext) { + pjp.proceed() + } + } + +} diff --git a/kamon-scala/src/main/scala/kamon/scalaz/instrumentation/FutureInstrumentation.scala b/kamon-scala/src/main/scala/kamon/scalaz/instrumentation/FutureInstrumentation.scala new file mode 100644 index 00000000..b5aadbd3 --- /dev/null +++ b/kamon-scala/src/main/scala/kamon/scalaz/instrumentation/FutureInstrumentation.scala @@ -0,0 +1,47 @@ +/* + * ========================================================================================= + * 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.scalaz.instrumentation + +import kamon.trace.{ TraceContext, TraceContextAware } +import org.aspectj.lang.ProceedingJoinPoint +import org.aspectj.lang.annotation._ + +@Aspect +class FutureInstrumentation { + + @DeclareMixin("scalaz.concurrent..* && java.util.concurrent.Callable+") + def mixinTraceContextAwareToFutureRelatedCallable: TraceContextAware = + TraceContextAware.default + + @Pointcut("execution((scalaz.concurrent..* && java.util.concurrent.Callable+).new(..)) && this(callable)") + def futureRelatedCallableCreation(callable: TraceContextAware): Unit = {} + + @After("futureRelatedCallableCreation(callable)") + def afterCreation(callable: TraceContextAware): Unit = + // Force traceContext initialization. + callable.traceContext + + @Pointcut("execution(* (scalaz.concurrent..* && java.util.concurrent.Callable+).call()) && this(callable)") + def futureRelatedCallableExecution(callable: TraceContextAware): Unit = {} + + @Around("futureRelatedCallableExecution(callable)") + def aroundExecution(pjp: ProceedingJoinPoint, callable: TraceContextAware): Any = + TraceContext.withContext(callable.traceContext) { + pjp.proceed() + } + +} diff --git a/kamon-scala/src/test/scala/kamon/scala/instrumentation/FutureInstrumentationSpec.scala b/kamon-scala/src/test/scala/kamon/scala/instrumentation/FutureInstrumentationSpec.scala new file mode 100644 index 00000000..d70e88ae --- /dev/null +++ b/kamon-scala/src/test/scala/kamon/scala/instrumentation/FutureInstrumentationSpec.scala @@ -0,0 +1,62 @@ +/* =================================================== + * 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.scala.instrumentation + +import kamon.testkit.BaseKamonSpec +import kamon.trace.TraceContext +import org.scalatest.OptionValues +import org.scalatest.concurrent.{ PatienceConfiguration, ScalaFutures } + +import scala.concurrent.Future + +class FutureInstrumentationSpec extends BaseKamonSpec("future-instrumentation-spec") with ScalaFutures + with PatienceConfiguration with OptionValues { + + implicit val execContext = system.dispatcher + + "a Future created with FutureTracing" should { + "capture the TraceContext available when created" which { + "must be available when executing the future's body" in { + + val (future, testTraceContext) = TraceContext.withContext(newContext("future-body")) { + val future = Future(TraceContext.currentContext) + + (future, TraceContext.currentContext) + } + + whenReady(future)(ctxInFuture ⇒ + ctxInFuture should equal(testTraceContext)) + } + + "must be available when executing callbacks on the future" in { + + val (future, testTraceContext) = TraceContext.withContext(newContext("future-body")) { + val future = Future("Hello Kamon!") + // The TraceContext is expected to be available during all intermediate processing. + .map(_.length) + .flatMap(len ⇒ Future(len.toString)) + .map(s ⇒ TraceContext.currentContext) + + (future, TraceContext.currentContext) + } + + whenReady(future)(ctxInFuture ⇒ + ctxInFuture should equal(testTraceContext)) + } + } + } +} + diff --git a/kamon-scala/src/test/scala/kamon/scalaz/instrumentation/FutureInstrumentationSpec.scala b/kamon-scala/src/test/scala/kamon/scalaz/instrumentation/FutureInstrumentationSpec.scala new file mode 100644 index 00000000..ba8fa18c --- /dev/null +++ b/kamon-scala/src/test/scala/kamon/scalaz/instrumentation/FutureInstrumentationSpec.scala @@ -0,0 +1,64 @@ +/* =================================================== + * 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.scalaz.instrumentation + +import java.util.concurrent.Executors + +import kamon.testkit.BaseKamonSpec +import kamon.trace.TraceContext +import org.scalatest.OptionValues +import org.scalatest.concurrent.{ PatienceConfiguration, ScalaFutures } + +import scalaz.concurrent.Future + +class FutureInstrumentationSpec extends BaseKamonSpec("future-instrumentation-spec") with ScalaFutures + with PatienceConfiguration with OptionValues { + + implicit val execContext = Executors.newCachedThreadPool() + + "a Future created with FutureTracing" should { + "capture the TraceContext available when created" which { + "must be available when executing the future's body" in { + + val (future, testTraceContext) = TraceContext.withContext(newContext("future-body")) { + val future = Future(TraceContext.currentContext).start + + (future, TraceContext.currentContext) + } + + val ctxInFuture = future.run + ctxInFuture should equal(testTraceContext) + } + + "must be available when executing callbacks on the future" in { + + val (future, testTraceContext) = TraceContext.withContext(newContext("future-body")) { + val future = Future("Hello Kamon!") + // The TraceContext is expected to be available during all intermediate processing. + .map(_.length) + .flatMap(len ⇒ Future(len.toString)) + .map(s ⇒ TraceContext.currentContext) + + (future.start, TraceContext.currentContext) + } + + val ctxInFuture = future.run + ctxInFuture should equal(testTraceContext) + } + } + } +} + |