-
Notifications
You must be signed in to change notification settings - Fork 7
/
SpansServiceImpl.kt
294 lines (263 loc) · 11.2 KB
/
SpansServiceImpl.kt
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
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
package io.embrace.android.embracesdk.internal.spans
import io.embrace.android.embracesdk.BuildConfig
import io.embrace.android.embracesdk.annotation.InternalApi
import io.embrace.android.embracesdk.internal.Systrace
import io.embrace.android.embracesdk.spans.EmbraceSpan
import io.embrace.android.embracesdk.spans.EmbraceSpanEvent
import io.embrace.android.embracesdk.spans.ErrorCode
import io.opentelemetry.api.OpenTelemetry
import io.opentelemetry.api.common.Attributes
import io.opentelemetry.api.trace.Span
import io.opentelemetry.api.trace.SpanBuilder
import io.opentelemetry.api.trace.Tracer
import io.opentelemetry.sdk.OpenTelemetrySdk
import io.opentelemetry.sdk.common.Clock
import io.opentelemetry.sdk.common.CompletableResultCode
import io.opentelemetry.sdk.trace.SdkTracerProvider
import io.opentelemetry.sdk.trace.data.SpanData
import java.util.concurrent.TimeUnit
import java.util.concurrent.atomic.AtomicInteger
import java.util.concurrent.atomic.AtomicReference
/**
* Implementation of the core logic for [SpansService]
*/
@InternalApi
internal class SpansServiceImpl(
sdkInitStartTimeNanos: Long,
sdkInitEndTimeNanos: Long,
private val clock: Clock
) : SpansService {
private val sdkTracerProvider: SdkTracerProvider
by lazy {
Systrace.start("spans-service-init")
Systrace.trace("init-sdk-tracer-provider") {
SdkTracerProvider
.builder()
.addSpanProcessor(EmbraceSpanProcessor(EmbraceSpanExporter(this)))
.setClock(clock)
.build()
}
}
private val openTelemetry: OpenTelemetry
by lazy {
Systrace.trace("init-otel-sdk") {
OpenTelemetrySdk.builder()
.setTracerProvider(sdkTracerProvider)
.build()
}
}
private val tracer: Tracer
by lazy {
Systrace.trace("init-tracer") {
openTelemetry.getTracer(BuildConfig.LIBRARY_PACKAGE_NAME, BuildConfig.VERSION_NAME)
}
}
/**
* Number of traces created in the current session. This value should be reset when a new session is created.
*/
private val currentSessionTraceCount = AtomicInteger(0)
private val currentSessionChildSpansCount = mutableMapOf<String, Int>()
/**
* The span that models the lifetime of the current session or background activity
*/
private val currentSessionSpan: AtomicReference<Span> = AtomicReference(startSessionSpan(sdkInitStartTimeNanos))
/**
* Spans that have finished, successfully or not, that will be sent with the next session or background activity payload. These
* should be cached along with the other data in the payload.
*/
private val completedSpans: MutableList<EmbraceSpanData> = mutableListOf()
init {
Systrace.trace("log-sdk-init") {
val events = EmbraceSpanEvent.create(
name = "start-time",
timestampNanos = sdkInitStartTimeNanos,
attributes = null
)?.let { listOf(it) } ?: emptyList()
recordCompletedSpan(
name = "sdk-init",
startTimeNanos = sdkInitStartTimeNanos,
endTimeNanos = sdkInitEndTimeNanos,
events = events
)
}
Systrace.end()
}
override fun createSpan(name: String, parent: EmbraceSpan?, type: EmbraceAttributes.Type, internal: Boolean): EmbraceSpan? {
return if (EmbraceSpanImpl.inputsValid(name) && validateAndUpdateContext(parent, internal)) {
EmbraceSpanImpl(
spanBuilder = createRootSpanBuilder(name = name, type = type, internal = internal),
parent = parent
)
} else {
null
}
}
override fun <T> recordSpan(
name: String,
parent: EmbraceSpan?,
type: EmbraceAttributes.Type,
internal: Boolean,
code: () -> T
): T {
return if (EmbraceSpanImpl.inputsValid(name) && validateAndUpdateContext(parent, internal)) {
Systrace.start("log-span-$name")
try {
createRootSpanBuilder(name = name, type = type, internal = internal).updateParent(parent).record(code)
} finally {
Systrace.end()
}
} else {
code()
}
}
override fun recordCompletedSpan(
name: String,
startTimeNanos: Long,
endTimeNanos: Long,
parent: EmbraceSpan?,
type: EmbraceAttributes.Type,
internal: Boolean,
attributes: Map<String, String>,
events: List<EmbraceSpanEvent>,
errorCode: ErrorCode?
): Boolean {
if (startTimeNanos > endTimeNanos) {
return false
}
return if (EmbraceSpanImpl.inputsValid(name, events, attributes) && validateAndUpdateContext(parent, internal)) {
Systrace.trace("log-completed-span-$name") {
val span = createRootSpanBuilder(name = name, type = type, internal = internal)
.updateParent(parent)
.setStartTimestamp(startTimeNanos, TimeUnit.NANOSECONDS)
.startSpan()
.setAllAttributes(Attributes.builder().fromMap(attributes).build())
events.forEach { event ->
if (EmbraceSpanEvent.inputsValid(event.name, event.attributes)) {
span.addEvent(
event.name,
Attributes.builder().fromMap(event.attributes).build(),
event.timestampNanos,
TimeUnit.NANOSECONDS
)
}
}
span.endSpan(errorCode, endTimeNanos)
}
true
} else {
false
}
}
override fun storeCompletedSpans(spans: List<SpanData>): CompletableResultCode {
try {
synchronized(completedSpans) {
completedSpans += spans.map { EmbraceSpanData(spanData = it) }
}
} catch (t: Throwable) {
return CompletableResultCode.ofFailure()
}
return CompletableResultCode.ofSuccess()
}
override fun completedSpans(): List<EmbraceSpanData> {
synchronized(completedSpans) {
return completedSpans.toList()
}
}
override fun flushSpans(appTerminationCause: EmbraceAttributes.AppTerminationCause?): List<EmbraceSpanData> {
synchronized(completedSpans) {
if (appTerminationCause == null) {
currentSessionSpan.get().endSpan()
currentSessionSpan.set(startSessionSpan(TimeUnit.MILLISECONDS.toNanos(clock.now())))
} else {
currentSessionSpan.get()?.let {
it.setAttribute(appTerminationCause.keyName(), appTerminationCause.name)
it.endSpan()
}
}
val flushedSpans = completedSpans.toList()
completedSpans.clear()
return flushedSpans
}
}
/**
* Creating a new Span is only possible if the current session span is active, the parent has already been started, and the total
* session trace limit has not been reached. Once this method returns true, a new span is assumed to have been created and will
* be counted as such towards the limits, so make sure there's no case afterwards where a Span is not created.
*/
private fun validateAndUpdateContext(parent: EmbraceSpan?, internal: Boolean): Boolean {
if (!currentSessionSpan.get().isRecording || (parent != null && parent.spanId == null)) {
return false
}
if (!internal) {
if (parent == null) {
if (currentSessionTraceCount.get() < MAX_TRACE_COUNT_PER_SESSION) {
synchronized(currentSessionTraceCount) {
if (currentSessionTraceCount.get() < MAX_TRACE_COUNT_PER_SESSION) {
currentSessionTraceCount.incrementAndGet()
} else {
return false
}
}
} else {
return false
}
} else {
val rootSpanId = getRootSpanId(parent)
val currentSpanCount = currentSessionChildSpansCount[rootSpanId]
if (currentSpanCount == null) {
updateChildrenCount(rootSpanId)
} else if (currentSpanCount < MAX_SPAN_COUNT_PER_TRACE) {
synchronized(currentSessionChildSpansCount) {
val currentSpanCountAgain = currentSessionChildSpansCount[rootSpanId]
if (currentSpanCountAgain == null || currentSpanCountAgain < MAX_SPAN_COUNT_PER_TRACE) {
updateChildrenCount(rootSpanId)
} else {
return false
}
}
} else {
return false
}
}
}
return true
}
private fun getRootSpanId(span: EmbraceSpan): String {
var currentSpan: EmbraceSpan = span
while (currentSpan.parent != null) {
currentSpan.parent?.let { currentSpan = it }
}
return currentSpan.spanId ?: ""
}
private fun updateChildrenCount(rootSpanId: String) {
val currentCount = currentSessionChildSpansCount[rootSpanId]
if (currentCount == null) {
// The first time we'll know a root span ID is when a child is being added to it. Prior to that, when adding a prospective
// root span, the ID is not known yet. So the first time a root span is encountered add both it and the new child to the count.
//
// NOTE: Because we don't know whether the root span is internal or not at this point, it is assumed that it isn't.
// Therefore, it will count towards the limit if a non-internal span is added to the trace.
currentSessionChildSpansCount[rootSpanId] = 2
} else {
currentSessionChildSpansCount[rootSpanId] = currentCount + 1
}
}
/**
* This method should always be used when starting a new session span
*/
private fun startSessionSpan(startTimeNanos: Long): Span {
currentSessionTraceCount.set(0)
return createEmbraceSpanBuilder(name = "session-span", type = EmbraceAttributes.Type.SESSION)
.setNoParent()
.setStartTimestamp(startTimeNanos, TimeUnit.NANOSECONDS)
.startSpan()
}
private fun createRootSpanBuilder(name: String, type: EmbraceAttributes.Type, internal: Boolean): SpanBuilder =
createEmbraceSpanBuilder(name = name, type = type, internal = internal).setNoParent()
private fun createEmbraceSpanBuilder(name: String, type: EmbraceAttributes.Type, internal: Boolean = true): SpanBuilder =
tracer.embraceSpanBuilder(name, internal).setType(type)
companion object {
const val MAX_TRACE_COUNT_PER_SESSION = 100
const val MAX_SPAN_COUNT_PER_TRACE = 10
}
}