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
|
package kamon.instrumentation
import kamon.context.Context
import kamon.metric.Counter
import kamon.testkit.{MetricInspection, SpanInspection}
import org.scalatest.{Matchers, OptionValues, WordSpec}
import scala.collection.mutable
class HttpServerInstrumentationSpec extends WordSpec with Matchers with SpanInspection with OptionValues with MetricInspection {
"the HTTP server instrumentation" when {
"configured for context propagation" should {
"read context entries and tags from the incoming request" in {
val handler = httpServer().receive(fakeRequest("http://localhost:8080/", "/", "GET", Map(
"context-tags" -> "tag=value;none=0011223344556677;",
"custom-trace-id" -> "0011223344556677"
)))
handler.context.tags should contain only(
"tag" -> "value",
"none" -> "0011223344556677"
)
}
"use the configured HTTP propagation channel" in {
val handler = httpServer().receive(fakeRequest("http://localhost:8080/", "/", "GET", Map(
"context-tags" -> "tag=value;none=0011223344556677;",
"custom-trace-id" -> "0011223344556677"
)))
handler.context.tags should contain only(
"tag" -> "value",
"none" -> "0011223344556677"
)
val span = inspect(handler.span)
span.context().traceID.string shouldNot be("0011223344556677")
span.tag("http.method").value shouldBe "GET"
span.tag("http.url").value shouldBe "http://localhost:8080/"
val responseHeaders = mutable.Map.empty[String, String]
handler.send(fakeResponse(200, responseHeaders), handler.context.withTag("hello", "world"))
}
}
"configured for distributed tracing" should {
"create a span representing the current HTTP operation" in {
val handler = httpServer().receive(fakeRequest("http://localhost:8080/", "/", "GET", Map.empty))
handler.send(fakeResponse(200, mutable.Map.empty), handler.context)
val span = inspect(handler.span)
span.tag("http.method").value shouldBe "GET"
span.tag("http.url").value shouldBe "http://localhost:8080/"
span.tag("http.status_code").value shouldBe "200"
}
"adopt a traceID when explicitly provided" in {
val handler = httpServer().receive(fakeRequest("http://localhost:8080/", "/", "GET", Map(
"context-tags" -> "tag=value;none=0011223344556677;",
"x-correlation-id" -> "0011223344556677"
)))
handler.span.context().traceID.string shouldBe "0011223344556677"
}
"record span metrics when enabled" in {
val handler = httpServer().receive(fakeRequest("http://localhost:8080/", "/", "GET", Map.empty))
handler.send(fakeResponse(200, mutable.Map.empty), handler.context)
val span = inspect(handler.span)
span.hasMetricsEnabled() shouldBe true
}
"not record span metrics when disabled" in {
val handler = noSpanMetricsHttpServer()
.receive(fakeRequest("http://localhost:8080/", "/", "GET", Map.empty))
handler.send(fakeResponse(200, mutable.Map.empty), handler.context)
val span = inspect(handler.span)
span.hasMetricsEnabled() shouldBe false
}
"receive tags from context when available" in {
val handler = httpServer().receive(fakeRequest("http://localhost:8080/", "/", "GET", Map(
"context-tags" -> "tag=value;none=0011223344556677;peer=superservice;",
"custom-trace-id" -> "0011223344556677"
)))
val span = inspect(handler.span)
span.tag("peer").value shouldBe "superservice"
}
}
"all capabilities are disabled" should {
"not read any context from the incoming requests" in {
val httpServer = noopHttpServer()
val handler = httpServer.receive(fakeRequest("http://localhost:8080/", "/", "GET", Map(
"context-tags" -> "tag=value;none=0011223344556677;",
"custom-trace-id" -> "0011223344556677"
)))
handler.context shouldBe Context.Empty
}
"not create any span to represent the server request" in {
val httpServer = noopHttpServer()
val handler = httpServer.receive(fakeRequest("http://localhost:8080/", "/", "GET", Map(
"context-tags" -> "tag=value;none=0011223344556677;",
"custom-trace-id" -> "0011223344556677"
)))
handler.span.isEmpty() shouldBe true
}
"not record any HTTP server metrics" in {
val request = fakeRequest("http://localhost:8080/", "/", "GET", Map.empty)
noopHttpServer().receive(request).send(fakeResponse(200, mutable.Map.empty), Context.Empty)
noopHttpServer().receive(request).send(fakeResponse(302, mutable.Map.empty), Context.Empty)
noopHttpServer().receive(request).send(fakeResponse(404, mutable.Map.empty), Context.Empty)
noopHttpServer().receive(request).send(fakeResponse(504, mutable.Map.empty), Context.Empty)
noopHttpServer().receive(request).send(fakeResponse(110, mutable.Map.empty), Context.Empty)
completedRequests(8083, 100).value() shouldBe 0L
completedRequests(8083, 200).value() shouldBe 0L
completedRequests(8083, 300).value() shouldBe 0L
completedRequests(8083, 400).value() shouldBe 0L
completedRequests(8083, 500).value() shouldBe 0L
}
}
}
val TestComponent = "http.server"
val TestInterface = "0.0.0.0"
def httpServer(): HttpServer = HttpServer.from("default", component = TestComponent, interface = TestInterface, port = 8081)
def noSpanMetricsHttpServer(): HttpServer = HttpServer.from("no-span-metrics", component = TestComponent, interface = TestInterface, port = 8082)
def noopHttpServer(): HttpServer = HttpServer.from("noop", component = TestComponent, interface = TestInterface, port = 8083)
def fakeRequest(requestUrl: String, requestPath: String, requestMethod: String, headers: Map[String, String]): HttpRequest =
new HttpRequest {
override def url: String = requestUrl
override def path: String = requestPath
override def method: String = requestMethod
override def readHeader(header: String): Option[String] = headers.get(header)
}
def fakeResponse(responseStatusCode: Int, headers: mutable.Map[String, String]): HttpResponse.Writable[HttpResponse] =
new HttpResponse.Writable[HttpResponse] {
override def statusCode: Int = responseStatusCode
override def writeHeader(header: String, value: String): Unit = headers.put(header, value)
override def build(): HttpResponse = this
}
def completedRequests(port: Int, statusCode: Int): Counter = {
val metrics = HttpServer.Metrics.of(TestComponent, TestInterface, port)
statusCode match {
case sc if sc >= 100 && sc <= 199 => metrics.requestsInformational
case sc if sc >= 200 && sc <= 299 => metrics.requestsSuccessful
case sc if sc >= 300 && sc <= 399 => metrics.requestsRedirection
case sc if sc >= 400 && sc <= 499 => metrics.requestsClientError
case sc if sc >= 500 && sc <= 599 => metrics.requestsServerError
}
}
}
|
