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
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
|
/* =========================================================================================
* Copyright © 2013-2017 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
package trace
import kamon.ReporterRegistry.SpanSink
import kamon.context.Key
import kamon.metric.MeasurementUnit
import kamon.trace.SpanContext.SamplingDecision
import kamon.util.Clock
trait Span {
def isEmpty(): Boolean
def isLocal(): Boolean
def nonEmpty(): Boolean = !isEmpty()
def isRemote(): Boolean = !isLocal()
def context(): SpanContext
def annotate(annotation: Span.Annotation): Span
def addTag(key: String, value: String): Span
def addSpanTag(key: String, value: String): Span
def addSpanTag(key: String, value: Long): Span
def addSpanTag(key: String, value: Boolean): Span
def addMetricTag(key: String, value: String): Span
def setOperationName(name: String): Span
def disableMetricsCollection(): Span
def finish(finishTimestampMicros: Long): Unit
def finish(): Unit =
finish(Clock.microTimestamp())
def annotate(name: String): Span =
annotate(Span.Annotation(Clock.microTimestamp(), name, Map.empty))
def annotate(name: String, fields: Map[String, String]): Span =
annotate(Span.Annotation(Clock.microTimestamp(), name, fields))
def annotate(timestampMicroseconds: Long, name: String, fields: Map[String, String]): Span =
annotate(Span.Annotation(timestampMicroseconds, name, fields))
}
object Span {
val ContextKey = Key.broadcast[Span]("span", Span.Empty)
object Empty extends Span {
override val context: SpanContext = SpanContext.EmptySpanContext
override def isEmpty(): Boolean = true
override def isLocal(): Boolean = true
override def annotate(annotation: Annotation): Span = this
override def addTag(key: String, value: String): Span = this
override def addSpanTag(key: String, value: String): Span = this
override def addSpanTag(key: String, value: Long): Span = this
override def addSpanTag(key: String, value: Boolean): Span = this
override def addMetricTag(key: String, value: String): Span = this
override def setOperationName(name: String): Span = this
override def disableMetricsCollection(): Span = this
override def finish(finishTimestampMicros: Long): Unit = {}
}
/**
*
* @param spanContext
* @param initialOperationName
* @param initialSpanTags
* @param startTimestampMicros
* @param spanSink
*/
final class Local(spanContext: SpanContext, parent: Option[Span], initialOperationName: String, initialSpanTags: Map[String, Span.TagValue],
initialMetricTags: Map[String, String], startTimestampMicros: Long, spanSink: SpanSink, scopeSpanMetrics: Boolean) extends Span {
private var collectMetrics: Boolean = true
private var open: Boolean = true
private val sampled: Boolean = spanContext.samplingDecision == SamplingDecision.Sample
private var operationName: String = initialOperationName
private var spanTags: Map[String, Span.TagValue] = initialSpanTags
private var customMetricTags = initialMetricTags
private var annotations = List.empty[Span.Annotation]
override def isEmpty(): Boolean = false
override def isLocal(): Boolean = true
def annotate(annotation: Annotation): Span = synchronized {
if(sampled && open)
annotations = annotation :: annotations
this
}
override def addTag(key: String, value: String): Span = synchronized {
addSpanTag(key, value)
addMetricTag(key, value)
this
}
override def addSpanTag(key: String, value: String): Span = synchronized {
if(sampled && open)
spanTags = spanTags + (key -> TagValue.String(value))
this
}
override def addSpanTag(key: String, value: Long): Span = synchronized {
if(sampled && open)
spanTags = spanTags + (key -> TagValue.Number(value))
this
}
override def addSpanTag(key: String, value: Boolean): Span = synchronized {
if(sampled && open) {
val tagValue = if (value) TagValue.True else TagValue.False
spanTags = spanTags + (key -> tagValue)
}
this
}
override def addMetricTag(key: String, value: String): Span = synchronized {
if(sampled && open && collectMetrics)
customMetricTags = customMetricTags + (key -> value)
this
}
override def disableMetricsCollection(): Span = synchronized {
collectMetrics = false
this
}
override def context(): SpanContext =
spanContext
override def setOperationName(operationName: String): Span = synchronized {
if(open)
this.operationName = operationName
this
}
override def finish(finishMicros: Long): Unit = synchronized {
if (open) {
open = false
if(collectMetrics)
recordSpanMetrics(finishMicros)
if(sampled)
spanSink.reportSpan(toFinishedSpan(finishMicros))
}
}
private def toFinishedSpan(endTimestampMicros: Long): Span.FinishedSpan =
Span.FinishedSpan(spanContext, operationName, startTimestampMicros, endTimestampMicros, spanTags, annotations)
private def recordSpanMetrics(endTimestampMicros: Long): Unit = {
val elapsedTime = endTimestampMicros - startTimestampMicros
val isError = spanTags.get("error").map {
case boolean: TagValue.Boolean => boolean.text
case _ => TagValue.False.text
} getOrElse(TagValue.False.text)
if(scopeSpanMetrics)
parent.foreach(parentSpan => customMetricTags = customMetricTags + ("parentOperation" -> parentSpan.asInstanceOf[Local].operationName))
val metricTags = Map(
"operation" -> operationName,
"error" -> isError
) ++ customMetricTags
Span.Metrics.ProcessingTime.refine(metricTags).record(elapsedTime)
}
}
object Local {
def apply(spanContext: SpanContext, parent: Option[Span], initialOperationName: String, initialSpanTags: Map[String, Span.TagValue],
initialMetricTags: Map[String, String], startTimestampMicros: Long, spanSink: SpanSink,
scopeSpanMetrics: Boolean): Local =
new Local(spanContext, parent, initialOperationName, initialSpanTags, initialMetricTags, startTimestampMicros, spanSink, scopeSpanMetrics)
}
final class Remote(val context: SpanContext) extends Span {
override def isEmpty(): Boolean = false
override def isLocal(): Boolean = false
override def annotate(annotation: Annotation): Span = this
override def addTag(key: String, value: String): Span = this
override def addSpanTag(key: String, value: String): Span = this
override def addSpanTag(key: String, value: Long): Span = this
override def addSpanTag(key: String, value: Boolean): Span = this
override def addMetricTag(key: String, value: String): Span = this
override def setOperationName(name: String): Span = this
override def disableMetricsCollection(): Span = this
override def finish(finishTimestampMicros: Long): Unit = {}
}
object Remote {
def apply(spanContext: SpanContext): Remote =
new Remote(spanContext)
}
sealed trait TagValue
object TagValue {
sealed trait Boolean extends TagValue {
def text: java.lang.String
}
case object True extends Boolean {
override def text: java.lang.String = "true"
}
case object False extends Boolean {
override def text: java.lang.String = "false"
}
case class String(string: java.lang.String) extends TagValue
case class Number(number: Long) extends TagValue
}
object Metrics {
val ProcessingTime = Kamon.histogram("span.processing-time", MeasurementUnit.time.microseconds)
val SpanErrorCount = Kamon.counter("span.error-count")
}
case class Annotation(timestampMicros: Long, name: String, fields: Map[String, String])
case class FinishedSpan(
context: SpanContext,
operationName: String,
startTimestampMicros: Long,
endTimestampMicros: Long,
tags: Map[String, Span.TagValue],
annotations: Seq[Annotation]
)
}
|