aboutsummaryrefslogtreecommitdiff
path: root/kamon-play/src/test/scala/kamon/play/RequestInstrumentationSpec.scala
diff options
context:
space:
mode:
Diffstat (limited to 'kamon-play/src/test/scala/kamon/play/RequestInstrumentationSpec.scala')
-rw-r--r--kamon-play/src/test/scala/kamon/play/RequestInstrumentationSpec.scala135
1 files changed, 97 insertions, 38 deletions
diff --git a/kamon-play/src/test/scala/kamon/play/RequestInstrumentationSpec.scala b/kamon-play/src/test/scala/kamon/play/RequestInstrumentationSpec.scala
index 1ba82dc5..eff6f280 100644
--- a/kamon-play/src/test/scala/kamon/play/RequestInstrumentationSpec.scala
+++ b/kamon-play/src/test/scala/kamon/play/RequestInstrumentationSpec.scala
@@ -1,43 +1,49 @@
-/* ===================================================
+/* =========================================================================================
* 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
+ * 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
+ * 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.
- * ========================================================== */
+ * 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.play
-import play.api.test._
-import play.api.mvc.{ Results, Action }
-import play.api.mvc.Results.Ok
-import scala.Some
-import scala.concurrent.ExecutionContext.Implicits.global
-import scala.concurrent.Future
-import org.junit.runner.RunWith
-import org.specs2.runner.JUnitRunner
-import play.api.test.FakeApplication
+import scala.concurrent.duration._
+import kamon.Kamon
+import kamon.http.HttpServerMetrics
+import kamon.metric.{ CollectionContext, Metrics }
import kamon.play.action.TraceName
+import kamon.trace.{ TraceLocal, TraceRecorder }
+import org.scalatestplus.play._
+import play.api.libs.concurrent.Execution.Implicits.defaultContext
+import play.api.mvc.Results.Ok
+import play.api.mvc._
+import play.api.test.Helpers._
+import play.api.test._
+import play.libs.Akka
-@RunWith(classOf[JUnitRunner])
-class RequestInstrumentationSpec extends PlaySpecification {
+import scala.concurrent.{ Await, Future }
+
+class RequestInstrumentationSpec extends PlaySpec with OneServerPerSuite {
System.setProperty("config.file", "./kamon-play/src/test/resources/conf/application.conf")
- def appWithRoutes = FakeApplication(withRoutes = {
+ val executor = scala.concurrent.ExecutionContext.Implicits.global
+
+ implicit override lazy val app = FakeApplication(withGlobal = Some(MockGlobalTest), withRoutes = {
+
case ("GET", "/async") ⇒
Action.async {
Future {
Ok("Async.async")
- }
+ }(executor)
}
case ("GET", "/notFound") ⇒
Action {
@@ -56,41 +62,94 @@ class RequestInstrumentationSpec extends PlaySpecification {
Action.async {
Future {
Ok("Async.async")
- }
+ }(executor)
}
}
+ case ("GET", "/retrieve") ⇒
+ Action {
+ Ok("retrieve from TraceLocal")
+ }
})
private val traceTokenValue = "kamon-trace-token-test"
private val traceTokenHeaderName = "X-Trace-Token"
private val expectedToken = Some(traceTokenValue)
private val traceTokenHeader = traceTokenHeaderName -> traceTokenValue
+ private val traceLocalStorageValue = "localStorageValue"
+ private val traceLocalStorageKey = "localStorageKey"
+ private val traceLocalStorageHeader = traceLocalStorageKey -> traceLocalStorageValue
"the Request instrumentation" should {
- "respond to the Async Action with X-Trace-Token" in new WithServer(appWithRoutes) {
- val Some(result) = route(FakeRequest(GET, "/async").withHeaders(traceTokenHeader))
- header(traceTokenHeaderName, result) must equalTo(expectedToken)
+ "respond to the Async Action with X-Trace-Token" in {
+ val Some(result) = route(FakeRequest(GET, "/async").withHeaders(traceTokenHeader, traceLocalStorageHeader))
+ header(traceTokenHeaderName, result) must be(expectedToken)
}
- "respond to the NotFound Action with X-Trace-Token" in new WithServer(appWithRoutes) {
+ "respond to the NotFound Action with X-Trace-Token" in {
val Some(result) = route(FakeRequest(GET, "/notFound").withHeaders(traceTokenHeader))
- header(traceTokenHeaderName, result) must equalTo(expectedToken)
+ header(traceTokenHeaderName, result) must be(expectedToken)
}
- "respond to the Default Action with X-Trace-Token" in new WithServer(appWithRoutes) {
+ "respond to the Default Action with X-Trace-Token" in {
val Some(result) = route(FakeRequest(GET, "/default").withHeaders(traceTokenHeader))
- header(traceTokenHeaderName, result) must equalTo(expectedToken)
+ header(traceTokenHeaderName, result) must be(expectedToken)
}
- "respond to the Redirect Action with X-Trace-Token" in new WithServer(appWithRoutes) {
+ "respond to the Redirect Action with X-Trace-Token" in {
val Some(result) = route(FakeRequest(GET, "/redirect").withHeaders(traceTokenHeader))
- header("Location", result) must equalTo(Some("/redirected"))
- header(traceTokenHeaderName, result) must equalTo(expectedToken)
+ header("Location", result) must be(Some("/redirected"))
+ header(traceTokenHeaderName, result) must be(expectedToken)
}
- "respond to the Async Action with X-Trace-Token and the renamed trace" in new WithServer(appWithRoutes) {
+ "respond to the Async Action with X-Trace-Token and the renamed trace" in {
val Some(result) = route(FakeRequest(GET, "/async-renamed").withHeaders(traceTokenHeader))
- header(traceTokenHeaderName, result) must equalTo(expectedToken)
+ Thread.sleep(500) // wait to complete the future
+ TraceRecorder.currentContext.map(_.name) must be(Some("renamed-trace"))
+ header(traceTokenHeaderName, result) must be(expectedToken)
+ }
+
+ "propagate the TraceContext and LocalStorage through of filters in the current request" in {
+ val Some(result) = route(FakeRequest(GET, "/retrieve").withHeaders(traceTokenHeader, traceLocalStorageHeader))
+ TraceLocal.retrieve(TraceLocalKey).get must be(traceLocalStorageValue)
+ }
+
+ "record http server metrics for all processed requests" in {
+ val collectionContext = CollectionContext(100)
+ Kamon(Metrics)(Akka.system()).register(HttpServerMetrics, HttpServerMetrics.Factory).get.collect(collectionContext)
+
+ for (repetition ← 1 to 10) {
+ Await.result(route(FakeRequest(GET, "/default").withHeaders(traceTokenHeader)).get, 10 seconds)
+ }
+
+ for (repetition ← 1 to 5) {
+ Await.result(route(FakeRequest(GET, "/notFound").withHeaders(traceTokenHeader)).get, 10 seconds)
+ }
+
+ val snapshot = Kamon(Metrics)(Akka.system()).register(HttpServerMetrics, HttpServerMetrics.Factory).get.collect(collectionContext)
+ snapshot.countsPerTraceAndStatusCode("GET: /default")("200").count must be(10)
+ snapshot.countsPerTraceAndStatusCode("GET: /notFound")("404").count must be(5)
+ snapshot.countsPerStatusCode("200").count must be(10)
+ snapshot.countsPerStatusCode("404").count must be(5)
}
}
-} \ No newline at end of file
+
+ object MockGlobalTest extends WithFilters(TraceLocalFilter)
+
+ object TraceLocalKey extends TraceLocal.TraceLocalKey {
+ type ValueType = String
+ }
+
+ object TraceLocalFilter extends Filter {
+ override def apply(next: (RequestHeader) ⇒ Future[SimpleResult])(header: RequestHeader): Future[SimpleResult] = {
+ TraceRecorder.withTraceContext(TraceRecorder.currentContext) {
+
+ TraceLocal.store(TraceLocalKey)(header.headers.get(traceLocalStorageKey).getOrElse("unknown"))
+
+ next(header).map {
+ result ⇒ result.withHeaders((traceLocalStorageKey -> TraceLocal.retrieve(TraceLocalKey).get))
+ }
+ }
+ }
+ }
+}
+
generated by cgit v1.2.3 (git 2.39.1) at 2024-06-08 14:08:05 +0000