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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
|
/* =========================================================================================
* 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.akka
import akka.actor.{ Props, ActorRef }
import akka.dispatch.MessageDispatcher
import akka.routing.BalancingPool
import akka.testkit.TestProbe
import com.typesafe.config.ConfigFactory
import kamon.Kamon
import kamon.akka.RouterMetricsTestActor.{ Pong, Ping }
import kamon.metric.{ EntityRecorder, EntitySnapshot }
import kamon.testkit.BaseKamonSpec
import scala.concurrent.duration._
import scala.concurrent.{ Await, Future }
class DispatcherMetricsSpec extends BaseKamonSpec("dispatcher-metrics-spec") {
override lazy val config =
ConfigFactory.parseString(
"""
|kamon.metric {
| tick-interval = 1 hour
| default-collection-context-buffer-size = 10
|
| filters = {
| akka-dispatcher {
| includes = [ "**" ]
| excludes = [ "*/explicitly-excluded" ]
| }
| }
|
| default-instrument-settings {
| gauge.refresh-interval = 1 hour
| min-max-counter.refresh-interval = 1 hour
| }
|}
|
|explicitly-excluded {
| type = "Dispatcher"
| executor = "fork-join-executor"
|}
|
|tracked-fjp {
| type = "Dispatcher"
| executor = "fork-join-executor"
|
| fork-join-executor {
| parallelism-min = 8
| parallelism-factor = 100.0
| parallelism-max = 22
| }
|}
|
|tracked-tpe {
| type = "Dispatcher"
| executor = "thread-pool-executor"
|
| thread-pool-executor {
| core-pool-size-min = 7
| core-pool-size-factor = 100.0
| max-pool-size-factor = 100.0
| max-pool-size-max = 21
| }
|}
|
""".stripMargin)
"the Kamon dispatcher metrics" should {
"respect the configured include and exclude filters" in {
val defaultDispatcher = forceInit(system.dispatchers.lookup("akka.actor.default-dispatcher"))
val fjpDispatcher = forceInit(system.dispatchers.lookup("tracked-fjp"))
val tpeDispatcher = forceInit(system.dispatchers.lookup("tracked-tpe"))
val excludedDispatcher = forceInit(system.dispatchers.lookup("explicitly-excluded"))
findDispatcherRecorder(defaultDispatcher, "fork-join-pool") shouldNot be(empty)
findDispatcherRecorder(fjpDispatcher, "fork-join-pool") shouldNot be(empty)
findDispatcherRecorder(tpeDispatcher, "thread-pool-executor") shouldNot be(empty)
findDispatcherRecorder(excludedDispatcher, "fork-join-pool") should be(empty)
}
"record metrics for a dispatcher with thread-pool-executor" in {
implicit val tpeDispatcher = system.dispatchers.lookup("tracked-tpe")
refreshDispatcherInstruments(tpeDispatcher, "thread-pool-executor")
collectDispatcherMetrics(tpeDispatcher, "thread-pool-executor")
Await.result({
Future.sequence {
for (_ ← 1 to 100) yield submit(tpeDispatcher)
}
}, 5 seconds)
refreshDispatcherInstruments(tpeDispatcher, "thread-pool-executor")
val snapshot = collectDispatcherMetrics(tpeDispatcher, "thread-pool-executor")
snapshot.gauge("active-threads") should not be empty
snapshot.gauge("pool-size").get.min should be >= 7L
snapshot.gauge("pool-size").get.max should be <= 21L
snapshot.gauge("max-pool-size").get.max should be(21)
snapshot.gauge("core-pool-size").get.max should be(21)
snapshot.gauge("processed-tasks").get.max should be(102L +- 5L)
// The processed tasks should be reset to 0 if no more tasks are submitted.
val secondSnapshot = collectDispatcherMetrics(tpeDispatcher, "thread-pool-executor")
secondSnapshot.gauge("processed-tasks").get.max should be(0)
}
"record metrics for a dispatcher with fork-join-executor" in {
implicit val fjpDispatcher = system.dispatchers.lookup("tracked-fjp")
collectDispatcherMetrics(fjpDispatcher, "fork-join-pool")
Await.result({
Future.sequence {
for (_ ← 1 to 100) yield submit(fjpDispatcher)
}
}, 5 seconds)
refreshDispatcherInstruments(fjpDispatcher, "fork-join-pool")
val snapshot = collectDispatcherMetrics(fjpDispatcher, "fork-join-pool")
snapshot.minMaxCounter("parallelism").get.max should be(22)
snapshot.gauge("pool-size").get.min should be >= 0L
snapshot.gauge("pool-size").get.max should be <= 22L
snapshot.gauge("active-threads").get.max should be >= 0L
snapshot.gauge("running-threads").get.max should be >= 0L
snapshot.gauge("queued-task-count").get.max should be(0)
}
"clean up the metrics recorders after a dispatcher is shut down" in {
implicit val tpeDispatcher = system.dispatchers.lookup("tracked-tpe")
implicit val fjpDispatcher = system.dispatchers.lookup("tracked-fjp")
findDispatcherRecorder(fjpDispatcher, "fork-join-pool") shouldNot be(empty)
findDispatcherRecorder(tpeDispatcher, "thread-pool-executor") shouldNot be(empty)
shutdownDispatcher(tpeDispatcher)
shutdownDispatcher(fjpDispatcher)
findDispatcherRecorder(fjpDispatcher, "fork-join-pool") should be(empty)
findDispatcherRecorder(tpeDispatcher, "thread-pool-executor") should be(empty)
}
"play nicely when dispatchers are looked up from a BalancingPool router" in {
val balancingPoolRouter = system.actorOf(BalancingPool(5).props(Props[RouterMetricsTestActor]), "test-balancing-pool")
balancingPoolRouter ! Ping
expectMsg(Pong)
findDispatcherRecorder("BalancingPool-/test-balancing-pool", "fork-join-pool") shouldNot be(empty)
}
}
def actorRecorderName(ref: ActorRef): String = ref.path.elements.mkString("/")
def findDispatcherRecorder(dispatcher: MessageDispatcher, dispatcherType: String): Option[EntityRecorder] =
Kamon.metrics.find(system.name + "/" + dispatcher.id, "akka-dispatcher", tags = Map("dispatcher-type" -> dispatcherType))
def findDispatcherRecorder(dispatcherID: String, dispatcherType: String): Option[EntityRecorder] =
Kamon.metrics.find(system.name + "/" + dispatcherID, "akka-dispatcher", tags = Map("dispatcher-type" -> dispatcherType))
def collectDispatcherMetrics(dispatcher: MessageDispatcher, dispatcherType: String): EntitySnapshot =
findDispatcherRecorder(dispatcher, dispatcherType).map(_.collect(collectionContext)).get
def refreshDispatcherInstruments(dispatcher: MessageDispatcher, dispatcherType: String): Unit = {
findDispatcherRecorder(dispatcher, dispatcherType) match {
case Some(tpe: ThreadPoolExecutorDispatcherMetrics) ⇒
tpe.processedTasks.refreshValue()
tpe.activeThreads.refreshValue()
tpe.maxPoolSize.refreshValue()
tpe.poolSize.refreshValue()
tpe.corePoolSize.refreshValue()
case Some(fjp: ForkJoinPoolDispatcherMetrics) ⇒
fjp.activeThreads.refreshValue()
fjp.poolSize.refreshValue()
fjp.queuedTaskCount.refreshValue()
fjp.paralellism.refreshValues()
fjp.runningThreads.refreshValue()
case other ⇒
}
}
def forceInit(dispatcher: MessageDispatcher): MessageDispatcher = {
val listener = TestProbe()
Future {
listener.ref ! "init done"
}(dispatcher)
listener.expectMsg("init done")
dispatcher
}
def submit(dispatcher: MessageDispatcher): Future[String] = Future {
"hello"
}(dispatcher)
def shutdownDispatcher(dispatcher: MessageDispatcher): Unit = {
val shutdownMethod = dispatcher.getClass.getDeclaredMethod("shutdown")
shutdownMethod.setAccessible(true)
shutdownMethod.invoke(dispatcher)
}
override protected def afterAll(): Unit = system.shutdown()
}
|
