aboutsummaryrefslogtreecommitdiff
path: root/kamon-core/src/main/scala/akka/instrumentation/DispatcherTracing.scala
blob: 69b78e5ed55d3b34ec2e4f7cc4fa1d324a95dd00 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
/*
 * =========================================================================================
 * 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 akka.instrumentation

import org.aspectj.lang.annotation._
import akka.dispatch.{ Dispatchers, ExecutorServiceDelegate, Dispatcher, MessageDispatcher }
import kamon.metrics.{ Metrics, DispatcherMetrics }
import kamon.metrics.DispatcherMetrics.DispatcherMetricRecorder
import kamon.Kamon
import akka.actor.{ Cancellable, ActorSystemImpl }
import scala.concurrent.forkjoin.ForkJoinPool
import java.util.concurrent.ThreadPoolExecutor
import java.lang.reflect.Method
import akka.instrumentation.DispatcherMetricsCollector.DispatcherMetricsMeasurement

@Aspect
class DispatcherTracing {

  @Pointcut("execution(akka.dispatch.Dispatchers.new(..)) && this(dispatchers) && cflow(execution(akka.actor.ActorSystemImpl.new(..)) && this(system))")
  def onActorSystemStartup(dispatchers: Dispatchers, system: ActorSystemImpl) = {}

  @Before("onActorSystemStartup(dispatchers, system)")
  def beforeActorSystemStartup(dispatchers: Dispatchers, system: ActorSystemImpl): Unit = {
    val currentDispatchers = dispatchers.asInstanceOf[DispatchersWithActorSystem]
    currentDispatchers.actorSystem = system
  }

  @Pointcut("execution(* akka.dispatch.Dispatchers.lookup(..)) && this(dispatchers)")
  def onDispatchersLookup(dispatchers: Dispatchers) = {}

  @AfterReturning(pointcut = "onDispatchersLookup(dispatchers)", returning = "dispatcher")
  def afterReturningLookup(dispatchers: Dispatchers, dispatcher: Dispatcher): Unit = {
    val dispatchersWithActorSystem = dispatchers.asInstanceOf[DispatchersWithActorSystem]
    val dispatcherWithMetrics = dispatcher.asInstanceOf[DispatcherMessageMetrics]

    dispatcherWithMetrics.actorSystem = dispatchersWithActorSystem.actorSystem
  }

  @Pointcut("call(* akka.dispatch.ExecutorServiceFactory.createExecutorService(..))")
  def onCreateExecutorService(): Unit = {}

  @Pointcut("cflow((execution(* akka.dispatch.MessageDispatcher.registerForExecution(..)) || execution(* akka.dispatch.MessageDispatcher.executeTask(..))) && this(dispatcher))")
  def onCflowMessageDispatcher(dispatcher: Dispatcher): Unit = {}

  @Pointcut("onCreateExecutorService() && onCflowMessageDispatcher(dispatcher)")
  def onDispatcherStartup(dispatcher: Dispatcher): Unit = {}

  @After("onDispatcherStartup(dispatcher)")
  def afterDispatcherStartup(dispatcher: MessageDispatcher): Unit = {

    val dispatcherWithMetrics = dispatcher.asInstanceOf[DispatcherMessageMetrics]
    val metricsExtension = Kamon(Metrics)(dispatcherWithMetrics.actorSystem)
    val metricIdentity = DispatcherMetrics(dispatcher.id)

    dispatcherWithMetrics.metricIdentity = metricIdentity
    dispatcherWithMetrics.dispatcherMetricsRecorder = metricsExtension.register(metricIdentity, DispatcherMetrics.Factory)

    if (dispatcherWithMetrics.dispatcherMetricsRecorder.isDefined) {
      dispatcherWithMetrics.dispatcherCollectorCancellable = metricsExtension.scheduleGaugeRecorder {
        dispatcherWithMetrics.dispatcherMetricsRecorder.map {
          dm 
            val DispatcherMetricsMeasurement(maximumPoolSize, runningThreadCount, queueTaskCount, poolSize) =
              DispatcherMetricsCollector.collect(dispatcher)

            dm.maximumPoolSize.record(maximumPoolSize)
            dm.runningThreadCount.record(runningThreadCount)
            dm.queueTaskCount.record(queueTaskCount)
            dm.poolSize.record(poolSize)
        }
      }
    }
  }

  @Pointcut("execution(* akka.dispatch.MessageDispatcher.shutdown(..)) && this(dispatcher)")
  def onDispatcherShutdown(dispatcher: MessageDispatcher): Unit = {}

  @After("onDispatcherShutdown(dispatcher)")
  def afterDispatcherShutdown(dispatcher: MessageDispatcher): Unit = {
    val dispatcherWithMetrics = dispatcher.asInstanceOf[DispatcherMessageMetrics]

    dispatcherWithMetrics.dispatcherMetricsRecorder.map {
      dispatcher 
        println("dispatcher down => " + dispatcher)
        dispatcherWithMetrics.dispatcherCollectorCancellable.cancel()
        Kamon(Metrics)(dispatcherWithMetrics.actorSystem).unregister(dispatcherWithMetrics.metricIdentity)
    }
  }
}

@Aspect
class DispatcherMetricsMixin {

  @DeclareMixin("akka.dispatch.Dispatcher")
  def mixinDispatcherMetricsToMessageDispatcher: DispatcherMessageMetrics = new DispatcherMessageMetrics {}

  @DeclareMixin("akka.dispatch.Dispatchers")
  def mixinDispatchersToDispatchersWithActorSystem: DispatchersWithActorSystem = new DispatchersWithActorSystem {}
}

trait DispatcherMessageMetrics {
  var metricIdentity: DispatcherMetrics = _
  var dispatcherMetricsRecorder: Option[DispatcherMetricRecorder] = _
  var dispatcherCollectorCancellable: Cancellable = _
  var actorSystem: ActorSystemImpl = _
}

trait DispatchersWithActorSystem {
  var actorSystem: ActorSystemImpl = _
}

object DispatcherMetricsCollector {

  case class DispatcherMetricsMeasurement(maximumPoolSize: Long, runningThreadCount: Long, queueTaskCount: Long, poolSize: Long)

  private def collectForkJoinMetrics(pool: ForkJoinPool): DispatcherMetricsMeasurement = {
    DispatcherMetricsMeasurement(pool.getParallelism, pool.getActiveThreadCount,
      (pool.getQueuedTaskCount + pool.getQueuedSubmissionCount), pool.getPoolSize)
  }

  private def collectExecutorMetrics(pool: ThreadPoolExecutor): DispatcherMetricsMeasurement = {
    DispatcherMetricsMeasurement(pool.getMaximumPoolSize, pool.getActiveCount, pool.getQueue.size(), pool.getPoolSize)
  }

  private val executorServiceMethod: Method = {
    // executorService is protected
    val method = classOf[Dispatcher].getDeclaredMethod("executorService")
    method.setAccessible(true)
    method
  }

  def collect(dispatcher: MessageDispatcher): DispatcherMetricsMeasurement = {
    dispatcher match {
      case x: Dispatcher  {
        val executor = executorServiceMethod.invoke(x) match {
          case delegate: ExecutorServiceDelegate  delegate.executor
          case other                              other
        }

        executor match {
          case fjp: ForkJoinPool        collectForkJoinMetrics(fjp)
          case tpe: ThreadPoolExecutor  collectExecutorMetrics(tpe)
          case anything                 DispatcherMetricsMeasurement(0L, 0L, 0L, 0L)
        }
      }
      case _  new DispatcherMetricsMeasurement(0L, 0L, 0L, 0L)
    }
  }
}