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
|
/*
* =========================================================================================
* 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.kamon.instrumentation
import akka.actor._
import akka.dispatch.{ Envelope, MessageDispatcher }
import akka.routing.RoutedActorCell
import kamon.Kamon
import kamon.akka.{ RouterMetrics, ActorMetrics }
import kamon.metric.Entity
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 actorEntity = Entity(ref.path.elements.mkString("/"), ActorMetrics.category)
if (Kamon.metrics.shouldTrack(actorEntity)) {
val actorMetricsRecorder = Kamon.metrics.entity(ActorMetrics, actorEntity)
val cellMetrics = cell.asInstanceOf[ActorCellMetrics]
cellMetrics.entity = actorEntity
cellMetrics.recorder = Some(actorMetricsRecorder)
}
}
@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 {
Tracer.withContext(contextAndTimestamp.traceContext) {
pjp.proceed()
}
} finally {
cellMetrics.recorder.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.recorder.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.recorder.map { _ ⇒
Kamon.metrics.removeEntity(cellMetrics.entity)
}
// 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.routerRecorder.map { _ ⇒
Kamon.metrics.removeEntity(routedCellMetrics.routerEntity)
}
}
}
@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.recorder.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 routerEntity = Entity(ref.path.elements.mkString("/"), RouterMetrics.category)
if (Kamon.metrics.shouldTrack(routerEntity)) {
val cellMetrics = cell.asInstanceOf[RoutedActorCellMetrics]
cellMetrics.routerEntity = routerEntity
cellMetrics.routerRecorder = Some(Kamon.metrics.entity(RouterMetrics, routerEntity))
}
}
@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 {
Tracer.withContext(contextAndTimestamp.traceContext) {
// The router metrics recorder will only be picked up if the message is sent from a tracked router.
RouterAwareEnvelope.dynamicRouterMetricsRecorder.withValue(cellMetrics.routerRecorder) {
pjp.proceed()
}
}
} finally {
cellMetrics.routerRecorder map { routerRecorder ⇒
routerRecorder.routingTime.record(System.nanoTime() - timestampBeforeProcessing)
}
}
}
}
trait ActorCellMetrics {
var entity: Entity = _
var recorder: Option[ActorMetrics] = None
}
trait RoutedActorCellMetrics {
var routerEntity: Entity = _
var routerRecorder: Option[RouterMetrics] = None
}
trait RouterAwareEnvelope {
def routerMetricsRecorder: Option[RouterMetrics]
}
object RouterAwareEnvelope {
import scala.util.DynamicVariable
private[kamon] val dynamicRouterMetricsRecorder = new DynamicVariable[Option[RouterMetrics]](None)
def default: RouterAwareEnvelope = new RouterAwareEnvelope {
val routerMetricsRecorder: Option[RouterMetrics] = 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
}
}
|