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
222
223
224
225
226
227
228
229
230
|
/*
* =========================================================================================
* 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.spray
import akka.testkit.{ TestKitBase, TestProbe }
import akka.actor.ActorSystem
import org.scalatest.{ Matchers, WordSpecLike }
import spray.httpx.RequestBuilding
import spray.http.{ HttpResponse, HttpRequest }
import kamon.trace.TraceRecorder
import com.typesafe.config.ConfigFactory
import spray.can.Http
import spray.http.HttpHeaders.RawHeader
import kamon.Kamon
import kamon.metrics.{ TraceMetrics, Metrics }
import spray.client.pipelining
import kamon.metrics.Subscriptions.TickMetricSnapshot
import spray.can.client.ClientRequestInstrumentation
import scala.concurrent.duration._
import akka.pattern.pipe
import kamon.metrics.TraceMetrics.TraceMetricSnapshot
class ClientRequestInstrumentationSpec extends TestKitBase with WordSpecLike with Matchers with RequestBuilding with TestServer {
implicit lazy val system: ActorSystem = ActorSystem("client-request-instrumentation-spec", ConfigFactory.parseString(
"""
|akka {
| loglevel = ERROR
|}
|
|kamon {
| metrics {
| tick-interval = 2 seconds
|
| filters = [
| {
| trace {
| includes = [ "*" ]
| excludes = []
| }
| }
| ]
| }
|}
""".stripMargin))
implicit def ec = system.dispatcher
"the client instrumentation" when {
"configured to do automatic-trace-token-propagation" should {
"include the trace token header on spray-client requests" in {
enableAutomaticTraceTokenPropagation()
val (hostConnector, server) = buildSHostConnectorAndServer
val client = TestProbe()
// Initiate a request within the context of a trace
val testContext = TraceRecorder.withNewTraceContext("include-trace-token-header-on-http-client-request") {
client.send(hostConnector, Get("/dummy-path"))
TraceRecorder.currentContext
}
// Accept the connection at the server side
server.expectMsgType[Http.Connected]
server.reply(Http.Register(server.ref))
// Receive the request and reply back
val request = server.expectMsgType[HttpRequest]
request.headers should contain(RawHeader(Kamon(Spray).traceTokenHeaderName, testContext.get.token))
// Finish the request cycle, just to avoid error messages on the logs.
server.reply(HttpResponse(entity = "ok"))
client.expectMsgType[HttpResponse]
testContext.map(_.finish(Map.empty))
}
}
"not configured to do automatic-trace-token-propagation" should {
"not include the trace token header on spray-client requests" in {
disableAutomaticTraceTokenPropagation()
val (hostConnector, server) = buildSHostConnectorAndServer
val client = TestProbe()
// Initiate a request within the context of a trace
val testContext = TraceRecorder.withNewTraceContext("not-include-trace-token-header-on-http-client-request") {
client.send(hostConnector, Get("/dummy-path"))
TraceRecorder.currentContext
}
// Accept the connection at the server side
server.expectMsgType[Http.Connected]
server.reply(Http.Register(server.ref))
// Receive the request and reply back
val request = server.expectMsgType[HttpRequest]
request.headers should not contain (RawHeader(Kamon(Spray).traceTokenHeaderName, testContext.get.token))
// Finish the request cycle, just to avoid error messages on the logs.
server.reply(HttpResponse(entity = "ok"))
client.expectMsgType[HttpResponse]
testContext.map(_.finish(Map.empty))
}
}
"configured to use pipelining segment collection strategy" should {
"open a segment when sendReceive is called and close it when the resulting Future[HttpResponse] is completed" in {
enablePipeliningSegmentCollectionStrategy()
val (hostConnector, server) = buildSHostConnectorAndServer
val client = TestProbe()
val pipeline = pipelining.sendReceive(hostConnector)(system.dispatcher, 3 seconds)
val metricListener = TestProbe()
Kamon(Metrics)(system).subscribe(TraceMetrics, "*", metricListener.ref, permanently = true)
metricListener.expectMsgType[TickMetricSnapshot]
// Initiate a request within the context of a trace
val testContext = TraceRecorder.withNewTraceContext("pipelining-strategy-client-request") {
pipeline(Get("/dummy-path")) to client.ref
TraceRecorder.currentContext
}
// Accept the connection at the server side
server.expectMsgType[Http.Connected]
server.reply(Http.Register(server.ref))
// Receive the request and reply back
val req = server.expectMsgType[HttpRequest]
server.reply(HttpResponse(entity = "ok"))
client.expectMsgType[HttpResponse]
// Finish the trace
testContext.map(_.finish(Map.empty))
val traceMetrics = expectTraceMetrics("pipelining-strategy-client-request", metricListener, 3 seconds)
traceMetrics.elapsedTime.numberOfMeasurements should be(1L)
traceMetrics.segments should not be empty
val recordedSegment = traceMetrics.segments.find { case (k, v) ⇒ k.tag == ClientRequestInstrumentation.UserTime } map (_._2)
recordedSegment should not be empty
recordedSegment map { segmentMetrics ⇒
segmentMetrics.numberOfMeasurements should be(1L)
}
}
}
"configured to use internal segment collection strategy" should {
"open a segment upon reception of a request by the HttpHostConnector and close it when sending the response" in {
enableInternalSegmentCollectionStrategy()
val (hostConnector, server) = buildSHostConnectorAndServer
val client = TestProbe()
val pipeline = pipelining.sendReceive(hostConnector)(system.dispatcher, 3 seconds)
val metricListener = TestProbe()
Kamon(Metrics)(system).subscribe(TraceMetrics, "*", metricListener.ref, permanently = true)
metricListener.expectMsgType[TickMetricSnapshot]
// Initiate a request within the context of a trace
val testContext = TraceRecorder.withNewTraceContext("internal-strategy-client-request") {
pipeline(Get("/dummy-path")) to client.ref
TraceRecorder.currentContext
}
// Accept the connection at the server side
server.expectMsgType[Http.Connected]
server.reply(Http.Register(server.ref))
// Receive the request and reply back
server.expectMsgType[HttpRequest]
server.reply(HttpResponse(entity = "ok"))
client.expectMsgType[HttpResponse]
// Finish the trace
testContext.map(_.finish(Map.empty))
val traceMetrics = expectTraceMetrics("internal-strategy-client-request", metricListener, 3 seconds)
traceMetrics.elapsedTime.numberOfMeasurements should be(1L)
traceMetrics.segments should not be empty
val recordedSegment = traceMetrics.segments.find { case (k, v) ⇒ k.tag == ClientRequestInstrumentation.SprayTime } map (_._2)
recordedSegment should not be empty
recordedSegment map { segmentMetrics ⇒
segmentMetrics.numberOfMeasurements should be(1L)
}
}
}
}
def expectTraceMetrics(traceName: String, listener: TestProbe, timeout: FiniteDuration): TraceMetricSnapshot = {
val tickSnapshot = within(timeout) {
listener.expectMsgType[TickMetricSnapshot]
}
val metricsOption = tickSnapshot.metrics.get(TraceMetrics(traceName))
metricsOption should not be empty
metricsOption.get.asInstanceOf[TraceMetricSnapshot]
}
def enableInternalSegmentCollectionStrategy(): Unit = setSegmentCollectionStrategy(ClientSegmentCollectionStrategy.Internal)
def enablePipeliningSegmentCollectionStrategy(): Unit = setSegmentCollectionStrategy(ClientSegmentCollectionStrategy.Pipelining)
def enableAutomaticTraceTokenPropagation(): Unit = setIncludeTraceToken(true)
def disableAutomaticTraceTokenPropagation(): Unit = setIncludeTraceToken(false)
def setSegmentCollectionStrategy(strategy: ClientSegmentCollectionStrategy.Strategy): Unit = {
val target = Kamon(Spray)(system)
val field = target.getClass.getDeclaredField("clientSegmentCollectionStrategy")
field.setAccessible(true)
field.set(target, strategy)
}
def setIncludeTraceToken(include: Boolean): Unit = {
val target = Kamon(Spray)(system)
val field = target.getClass.getDeclaredField("includeTraceToken")
field.setAccessible(true)
field.set(target, include)
}
}
|
