aboutsummaryrefslogtreecommitdiff
path: root/kamon-spray/src/main/scala/spray/can/client/ClientRequestInstrumentation.scala
blob: 94fc357228b8d242be93e44acc0ee553cbd174cd (plain) (blame)
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
/*
 * =========================================================================================
 * 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 spray.can.client

import org.aspectj.lang.annotation._
import org.aspectj.lang.ProceedingJoinPoint
import spray.http._
import spray.http.HttpHeaders.RawHeader
import kamon.trace._
import kamon.Kamon
import kamon.spray.{ ClientSegmentCollectionStrategy, Spray }
import akka.actor.ActorRef
import scala.concurrent.{ Future, ExecutionContext }
import akka.util.Timeout

@Aspect
class ClientRequestInstrumentation {

  @DeclareMixin("spray.can.client.HttpHostConnector.RequestContext")
  def mixinTraceContextAwareToRequestContext: TraceContextAware = TraceContextAware.default

  @DeclareMixin("spray.can.client.HttpHostConnector.RequestContext")
  def mixinSegmentAwareToRequestContext: SegmentAware = SegmentAware.default

  @DeclareMixin("spray.http.HttpRequest")
  def mixinSegmentAwareToHttpRequest: SegmentAware = SegmentAware.default

  @Pointcut("execution(spray.can.client.HttpHostConnector.RequestContext.new(..)) && this(requestContext) && args(request, *, *, *)")
  def requestContextCreation(requestContext: SegmentAware with TraceContextAware, request: HttpRequest): Unit = {}

  @After("requestContextCreation(requestContext, request)")
  def afterRequestContextCreation(requestContext: SegmentAware with TraceContextAware, request: HttpRequest): Unit = {
    // This read to requestContext.traceContext takes care of initializing the aspect timely.
    requestContext.traceContext

    TraceRecorder.withTraceContextAndSystem { (ctx, system) 
      val sprayExtension = Kamon(Spray)(system)

      if (sprayExtension.clientSegmentCollectionStrategy == ClientSegmentCollectionStrategy.Internal) {
        if (requestContext.segment.isEmpty) {
          val clientRequestName = sprayExtension.generateHostLevelApiSegmentName(request)
          val segment = ctx.startSegment(clientRequestName, SegmentMetricIdentityLabel.HttpClient)
          requestContext.segment = segment
        }

      } else {

        // We have a Request Level API, let's just make sure that we rename it accordingly. The reason for assigning a
        // name again here is that when the request was initially sent it might not have the Host information available
        // and it might be important to decide a proper segment name.

        val clientRequestName = sprayExtension.generateHostLevelApiSegmentName(request)
        request.asInstanceOf[SegmentAware].segment.rename(clientRequestName)
      }
    }
  }

  @Pointcut("execution(* spray.can.client.HttpHostConnector.RequestContext.copy(..)) && this(old)")
  def copyingRequestContext(old: TraceContextAware): Unit = {}

  @Around("copyingRequestContext(old)")
  def aroundCopyingRequestContext(pjp: ProceedingJoinPoint, old: TraceContextAware): Any = {
    TraceRecorder.withInlineTraceContextReplacement(old.traceContext) {
      pjp.proceed()
    }
  }

  @Pointcut("execution(* spray.can.client.HttpHostConnectionSlot.dispatchToCommander(..)) && args(requestContext, message)")
  def dispatchToCommander(requestContext: TraceContextAware, message: Any): Unit = {}

  @Around("dispatchToCommander(requestContext, message)")
  def aroundDispatchToCommander(pjp: ProceedingJoinPoint, requestContext: TraceContextAware, message: Any): Any = {
    if (requestContext.traceContext.nonEmpty) {
      TraceRecorder.withInlineTraceContextReplacement(requestContext.traceContext) {
        if (message.isInstanceOf[HttpMessageEnd])
          requestContext.asInstanceOf[SegmentAware].segment.finish()

        pjp.proceed()
      }
    } else pjp.proceed()
  }

  @Pointcut("execution(* spray.http.HttpRequest.copy(..)) && this(old)")
  def copyingHttpRequest(old: SegmentAware): Unit = {}

  @Around("copyingHttpRequest(old)")
  def aroundCopyingHttpRequest(pjp: ProceedingJoinPoint, old: SegmentAware): Any = {
    val copiedHttpRequest = pjp.proceed().asInstanceOf[SegmentAware]
    copiedHttpRequest.segment = old.segment
    copiedHttpRequest
  }

  @Pointcut("execution(* spray.client.pipelining$.sendReceive(akka.actor.ActorRef, *, *)) && args(transport, ec, timeout)")
  def requestLevelApiSendReceive(transport: ActorRef, ec: ExecutionContext, timeout: Timeout): Unit = {}

  @Around("requestLevelApiSendReceive(transport, ec, timeout)")
  def aroundRequestLevelApiSendReceive(pjp: ProceedingJoinPoint, transport: ActorRef, ec: ExecutionContext, timeout: Timeout): Any = {
    val originalSendReceive = pjp.proceed().asInstanceOf[HttpRequest  Future[HttpResponse]]

    (request: HttpRequest)  {
      TraceRecorder.withTraceContextAndSystem { (ctx, system) 
        val sprayExtension = Kamon(Spray)(system)
        val segment =
          if (sprayExtension.clientSegmentCollectionStrategy == ClientSegmentCollectionStrategy.Pipelining)
            ctx.startSegment(sprayExtension.generateRequestLevelApiSegmentName(request), SegmentMetricIdentityLabel.HttpClient)
          else
            EmptyTraceContext.EmptySegment

        request.asInstanceOf[SegmentAware].segment = segment

        val responseFuture = originalSendReceive.apply(request)
        responseFuture.onComplete { result 
          segment.finish()
        }(ec)

        responseFuture

      } getOrElse (originalSendReceive.apply(request))
    }
  }

  @Pointcut("execution(* spray.http.HttpMessage.withDefaultHeaders(*)) && this(request) && args(defaultHeaders)")
  def includingDefaultHeadersAtHttpHostConnector(request: HttpMessage, defaultHeaders: List[HttpHeader]): Unit = {}

  @Around("includingDefaultHeadersAtHttpHostConnector(request, defaultHeaders)")
  def aroundIncludingDefaultHeadersAtHttpHostConnector(pjp: ProceedingJoinPoint, request: HttpMessage, defaultHeaders: List[HttpHeader]): Any = {

    val modifiedHeaders = TraceRecorder.withTraceContextAndSystem { (ctx, system) 
      val sprayExtension = Kamon(Spray)(system)
      if (sprayExtension.includeTraceToken)
        RawHeader(sprayExtension.traceTokenHeaderName, ctx.token) :: defaultHeaders
      else
        defaultHeaders

    } getOrElse (defaultHeaders)

    pjp.proceed(Array[AnyRef](request, modifiedHeaders))
  }
}