/* * ========================================================================================= * Copyright © 2013-2014 the kamon project * * 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 akka.kamon.instrumentation import akka.actor._ import akka.dispatch.{ Envelope, MessageDispatcher } import akka.routing.RoutedActorCell import kamon.Kamon import kamon.akka.{ RouterMetrics, ActorMetrics } import ActorMetrics.ActorMetricsRecorder import RouterMetrics.RouterMetricsRecorder import kamon.metric.Metrics import kamon.trace._ import org.aspectj.lang.ProceedingJoinPoint import org.aspectj.lang.annotation._ @Aspect class ActorCellInstrumentation { @Pointcut("execution(akka.actor.ActorCell.new(..)) && this(cell) && args(system, ref, props, dispatcher, parent)") def actorCellCreation(cell: ActorCell, system: ActorSystem, ref: ActorRef, props: Props, dispatcher: MessageDispatcher, parent: ActorRef): Unit = {} @After("actorCellCreation(cell, system, ref, props, dispatcher, parent)") def afterCreation(cell: ActorCell, system: ActorSystem, ref: ActorRef, props: Props, dispatcher: MessageDispatcher, parent: ActorRef): Unit = { val metricsExtension = Kamon(Metrics)(system) val metricIdentity = ActorMetrics(ref.path.elements.mkString("/")) val cellMetrics = cell.asInstanceOf[ActorCellMetrics] cellMetrics.actorMetricIdentity = metricIdentity cellMetrics.actorMetricsRecorder = metricsExtension.register(metricIdentity, ActorMetrics.Factory) } @Pointcut("execution(* akka.actor.ActorCell.invoke(*)) && this(cell) && args(envelope)") def invokingActorBehaviourAtActorCell(cell: ActorCell, envelope: Envelope) = {} @Around("invokingActorBehaviourAtActorCell(cell, envelope)") def aroundBehaviourInvoke(pjp: ProceedingJoinPoint, cell: ActorCell, envelope: Envelope): Any = { val cellMetrics = cell.asInstanceOf[ActorCellMetrics] val timestampBeforeProcessing = System.nanoTime() val contextAndTimestamp = envelope.asInstanceOf[TimestampedTraceContextAware] try { TraceRecorder.withInlineTraceContextReplacement(contextAndTimestamp.traceContext) { pjp.proceed() } } finally { cellMetrics.actorMetricsRecorder.map { am ⇒ val processingTime = System.nanoTime() - timestampBeforeProcessing val timeInMailbox = timestampBeforeProcessing - contextAndTimestamp.captureNanoTime am.processingTime.record(processingTime) am.timeInMailbox.record(timeInMailbox) am.mailboxSize.decrement() // In case that this actor is behind a router, record the metrics for the router. envelope.asInstanceOf[RouterAwareEnvelope].routerMetricsRecorder.map { rm ⇒ rm.processingTime.record(processingTime) rm.timeInMailbox.record(timeInMailbox) } } } } @Pointcut("execution(* akka.actor.ActorCell.sendMessage(*)) && this(cell) && args(envelope)") def sendMessageInActorCell(cell: ActorCell, envelope: Envelope): Unit = {} @After("sendMessageInActorCell(cell, envelope)") def afterSendMessageInActorCell(cell: ActorCell, envelope: Envelope): Unit = { val cellMetrics = cell.asInstanceOf[ActorCellMetrics] cellMetrics.actorMetricsRecorder.map(_.mailboxSize.increment()) } @Pointcut("execution(* akka.actor.ActorCell.stop()) && this(cell)") def actorStop(cell: ActorCell): Unit = {} @After("actorStop(cell)") def afterStop(cell: ActorCell): Unit = { val cellMetrics = cell.asInstanceOf[ActorCellMetrics] cellMetrics.actorMetricsRecorder.map { _ ⇒ Kamon(Metrics)(cell.system).unregister(cellMetrics.actorMetricIdentity) } // The Stop can't be captured from the RoutedActorCell so we need to put this piece of cleanup here. if (cell.isInstanceOf[RoutedActorCell]) { val routedCellMetrics = cell.asInstanceOf[RoutedActorCellMetrics] routedCellMetrics.routerMetricsRecorder.map { _ ⇒ Kamon(Metrics)(cell.system).unregister(routedCellMetrics.routerMetricIdentity) } } } @Pointcut("execution(* akka.actor.ActorCell.handleInvokeFailure(..)) && this(cell)") def actorInvokeFailure(cell: ActorCell): Unit = {} @Before("actorInvokeFailure(cell)") def beforeInvokeFailure(cell: ActorCell): Unit = { val cellWithMetrics = cell.asInstanceOf[ActorCellMetrics] cellWithMetrics.actorMetricsRecorder.map(_.errors.increment()) // In case that this actor is behind a router, count the errors for the router as well. val envelope = cell.currentMessage.asInstanceOf[RouterAwareEnvelope] envelope.routerMetricsRecorder.map(_.errors.increment()) } } @Aspect class RoutedActorCellInstrumentation { @Pointcut("execution(akka.routing.RoutedActorCell.new(..)) && this(cell) && args(system, ref, props, dispatcher, routeeProps, supervisor)") def routedActorCellCreation(cell: RoutedActorCell, system: ActorSystem, ref: ActorRef, props: Props, dispatcher: MessageDispatcher, routeeProps: Props, supervisor: ActorRef): Unit = {} @After("routedActorCellCreation(cell, system, ref, props, dispatcher, routeeProps, supervisor)") def afterRoutedActorCellCreation(cell: RoutedActorCell, system: ActorSystem, ref: ActorRef, props: Props, dispatcher: MessageDispatcher, routeeProps: Props, supervisor: ActorRef): Unit = { val metricsExtension = Kamon(Metrics)(system) val metricIdentity = RouterMetrics(ref.path.elements.mkString("/")) val cellMetrics = cell.asInstanceOf[RoutedActorCellMetrics] cellMetrics.routerMetricIdentity = metricIdentity cellMetrics.routerMetricsRecorder = metricsExtension.register(metricIdentity, RouterMetrics.Factory) } @Pointcut("execution(* akka.routing.RoutedActorCell.sendMessage(*)) && this(cell) && args(envelope)") def sendMessageInRouterActorCell(cell: RoutedActorCell, envelope: Envelope) = {} @Around("sendMessageInRouterActorCell(cell, envelope)") def aroundSendMessageInRouterActorCell(pjp: ProceedingJoinPoint, cell: RoutedActorCell, envelope: Envelope): Any = { val cellMetrics = cell.asInstanceOf[RoutedActorCellMetrics] val timestampBeforeProcessing = System.nanoTime() val contextAndTimestamp = envelope.asInstanceOf[TimestampedTraceContextAware] try { TraceRecorder.withInlineTraceContextReplacement(contextAndTimestamp.traceContext) { // The router metrics recorder will only be picked up if the message is sent from a tracked router. RouterAwareEnvelope.dynamicRouterMetricsRecorder.withValue(cellMetrics.routerMetricsRecorder) { pjp.proceed() } } } finally { cellMetrics.routerMetricsRecorder map { routerRecorder ⇒ routerRecorder.routingTime.record(System.nanoTime() - timestampBeforeProcessing) } } } } trait ActorCellMetrics { var actorMetricIdentity: ActorMetrics = _ var actorMetricsRecorder: Option[ActorMetricsRecorder] = _ } trait RoutedActorCellMetrics { var routerMetricIdentity: RouterMetrics = _ var routerMetricsRecorder: Option[RouterMetricsRecorder] = _ } trait RouterAwareEnvelope { def routerMetricsRecorder: Option[RouterMetricsRecorder] } object RouterAwareEnvelope { import scala.util.DynamicVariable private[kamon] val dynamicRouterMetricsRecorder = new DynamicVariable[Option[RouterMetricsRecorder]](None) def default: RouterAwareEnvelope = new RouterAwareEnvelope { val routerMetricsRecorder: Option[RouterMetricsRecorder] = dynamicRouterMetricsRecorder.value } } @Aspect class MetricsIntoActorCellsMixin { @DeclareMixin("akka.actor.ActorCell") def mixinActorCellMetricsToActorCell: ActorCellMetrics = new ActorCellMetrics {} @DeclareMixin("akka.routing.RoutedActorCell") def mixinActorCellMetricsToRoutedActorCell: RoutedActorCellMetrics = new RoutedActorCellMetrics {} } @Aspect class TraceContextIntoEnvelopeMixin { @DeclareMixin("akka.dispatch.Envelope") def mixinTraceContextAwareToEnvelope: TimestampedTraceContextAware = TimestampedTraceContextAware.default @DeclareMixin("akka.dispatch.Envelope") def mixinRouterAwareToEnvelope: RouterAwareEnvelope = RouterAwareEnvelope.default @Pointcut("execution(akka.dispatch.Envelope.new(..)) && this(ctx)") def envelopeCreation(ctx: TimestampedTraceContextAware): Unit = {} @After("envelopeCreation(ctx)") def afterEnvelopeCreation(ctx: TimestampedTraceContextAware with RouterAwareEnvelope): Unit = { // Necessary to force the initialization of ContextAware at the moment of creation. ctx.traceContext ctx.routerMetricsRecorder } }