/
SimpleObservation.java
402 lines (347 loc) · 14.2 KB
/
SimpleObservation.java
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
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
/*
* Copyright 2022 VMware, Inc.
*
* 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
*
* https://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 io.micrometer.observation;
import io.micrometer.common.KeyValue;
import io.micrometer.common.lang.Nullable;
import io.micrometer.common.util.StringUtils;
import io.micrometer.common.util.internal.logging.InternalLogger;
import io.micrometer.common.util.internal.logging.InternalLoggerFactory;
import io.micrometer.observation.contextpropagation.ObservationThreadLocalAccessor;
import java.util.ArrayDeque;
import java.util.Collection;
import java.util.Deque;
import java.util.Iterator;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
/**
* Default implementation of {@link Observation}.
*
* @author Jonatan Ivanov
* @author Tommy Ludwig
* @author Marcin Grzejszczak
* @author Yanming Zhou
* @since 1.10.0
*/
class SimpleObservation implements Observation {
final ObservationRegistry registry;
private final Context context;
@Nullable
@SuppressWarnings("rawtypes")
private ObservationConvention convention;
@SuppressWarnings("rawtypes")
private final Deque<ObservationHandler> handlers;
private final Collection<ObservationFilter> filters;
final Map<Thread, Scope> lastScope = new ConcurrentHashMap<>();
SimpleObservation(@Nullable String name, ObservationRegistry registry, Context context) {
this.registry = registry;
this.context = context;
this.context.setName(name);
this.convention = getConventionFromConfig(registry, context);
this.handlers = getHandlersFromConfig(registry, context);
this.filters = registry.observationConfig().getObservationFilters();
}
SimpleObservation(ObservationConvention<? extends Context> convention, ObservationRegistry registry,
Context context) {
this.registry = registry;
this.context = context;
// name is set later in start()
this.handlers = getHandlersFromConfig(registry, context);
this.filters = registry.observationConfig().getObservationFilters();
if (convention.supportsContext(context)) {
this.convention = convention;
}
else {
throw new IllegalStateException(
"Convention [" + convention + "] doesn't support context [" + context + "]");
}
}
@Nullable
private static ObservationConvention getConventionFromConfig(ObservationRegistry registry, Context context) {
for (ObservationConvention<?> convention : registry.observationConfig().getObservationConventions()) {
if (convention.supportsContext(context)) {
return convention;
}
}
return null;
}
private static Deque<ObservationHandler> getHandlersFromConfig(ObservationRegistry registry, Context context) {
Collection<ObservationHandler<?>> handlers = registry.observationConfig().getObservationHandlers();
Deque<ObservationHandler> deque = new ArrayDeque<>(handlers.size());
for (ObservationHandler handler : handlers) {
if (handler.supportsContext(context)) {
deque.add(handler);
}
}
return deque;
}
@Override
public Observation contextualName(@Nullable String contextualName) {
this.context.setContextualName(contextualName);
return this;
}
@Override
public Observation parentObservation(@Nullable Observation parentObservation) {
this.context.setParentObservation(parentObservation);
return this;
}
@Override
public Observation lowCardinalityKeyValue(KeyValue keyValue) {
this.context.addLowCardinalityKeyValue(keyValue);
return this;
}
@Override
public Observation highCardinalityKeyValue(KeyValue keyValue) {
this.context.addHighCardinalityKeyValue(keyValue);
return this;
}
@Override
public Observation observationConvention(ObservationConvention<?> convention) {
if (convention.supportsContext(context)) {
this.convention = convention;
}
return this;
}
@Override
public Observation error(Throwable error) {
this.context.setError(error);
notifyOnError();
return this;
}
@Override
public Observation event(Event event) {
notifyOnEvent(event);
return this;
}
@Override
public Observation start() {
if (this.convention != null) {
this.context.addLowCardinalityKeyValues(convention.getLowCardinalityKeyValues(context));
this.context.addHighCardinalityKeyValues(convention.getHighCardinalityKeyValues(context));
String newName = convention.getName();
if (StringUtils.isNotBlank(newName)) {
this.context.setName(newName);
}
}
notifyOnObservationStarted();
return this;
}
@Override
public Context getContext() {
return this.context;
}
@SuppressWarnings({ "rawtypes", "unchecked" })
@Override
public void stop() {
if (this.convention != null) {
this.context.addLowCardinalityKeyValues(convention.getLowCardinalityKeyValues(context));
this.context.addHighCardinalityKeyValues(convention.getHighCardinalityKeyValues(context));
String newContextualName = convention.getContextualName(context);
if (StringUtils.isNotBlank(newContextualName)) {
this.context.setContextualName(newContextualName);
}
}
Context modifiedContext = this.context;
for (ObservationFilter filter : this.filters) {
modifiedContext = filter.map(modifiedContext);
}
notifyOnObservationStopped(modifiedContext);
}
@Override
public Scope openScope() {
Scope scope = new SimpleScope(this.registry, this);
notifyOnScopeOpened();
lastScope.put(Thread.currentThread(), scope);
return scope;
}
@Nullable
@Override
public Scope getEnclosingScope() {
return lastScope.get(Thread.currentThread());
}
@Override
public String toString() {
return "{" + "name=" + this.context.getName() + "(" + this.context.getContextualName() + ")" + ", error="
+ this.context.getError() + ", context=" + this.context + '}';
}
@SuppressWarnings("unchecked")
void notifyOnObservationStarted() {
for (ObservationHandler handler : this.handlers) {
handler.onStart(this.context);
}
}
@SuppressWarnings("unchecked")
void notifyOnError() {
for (ObservationHandler handler : this.handlers) {
handler.onError(this.context);
}
}
@SuppressWarnings("unchecked")
void notifyOnEvent(Event event) {
for (ObservationHandler handler : this.handlers) {
handler.onEvent(event, this.context);
}
}
@SuppressWarnings("unchecked")
void notifyOnScopeOpened() {
for (ObservationHandler handler : this.handlers) {
handler.onScopeOpened(this.context);
}
}
@SuppressWarnings("unchecked")
void notifyOnScopeClosed() {
// We're closing from end till the beginning - e.g. we opened scope with handlers
// with ids 1,2,3 and we need to close the scope in order 3,2,1
Iterator<ObservationHandler> iterator = this.handlers.descendingIterator();
while (iterator.hasNext()) {
ObservationHandler handler = iterator.next();
handler.onScopeClosed(this.context);
}
}
@SuppressWarnings("unchecked")
void notifyOnScopeMakeCurrent() {
for (ObservationHandler handler : this.handlers) {
handler.onScopeOpened(this.context);
}
}
@SuppressWarnings("unchecked")
void notifyOnScopeReset() {
for (ObservationHandler handler : this.handlers) {
handler.onScopeReset(this.context);
}
}
@SuppressWarnings("unchecked")
void notifyOnObservationStopped(Context context) {
// We're closing from end till the beginning - e.g. we started with handlers with
// ids 1,2,3 and we need to call close on 3,2,1
this.handlers.descendingIterator().forEachRemaining(handler -> handler.onStop(context));
}
@Override
public ObservationRegistry getObservationRegistry() {
return this.registry;
}
static class SimpleScope implements Scope {
private static final InternalLogger log = InternalLoggerFactory.getInstance(SimpleScope.class);
final ObservationRegistry registry;
private final Observation currentObservation;
@Nullable
final Scope previousObservationScope;
SimpleScope(ObservationRegistry registry, Observation current) {
this.registry = registry;
this.currentObservation = current;
this.previousObservationScope = registry.getCurrentObservationScope();
this.registry.setCurrentObservationScope(this);
}
@Override
public Observation getCurrentObservation() {
return this.currentObservation;
}
@Override
public void close() {
if (currentObservation instanceof SimpleObservation) {
SimpleObservation observation = (SimpleObservation) currentObservation;
SimpleScope lastScopeForThisObservation = getLastScope(this);
if (lastScopeForThisObservation != null) {
observation.lastScope.put(Thread.currentThread(), lastScopeForThisObservation);
}
else {
observation.lastScope.remove(Thread.currentThread());
}
observation.notifyOnScopeClosed();
}
else if (currentObservation != null && !currentObservation.isNoop()) {
log.debug("Custom observation type was used in combination with SimpleScope - that's unexpected");
}
else {
log.trace("NoOp observation used with SimpleScope");
}
this.registry.setCurrentObservationScope(previousObservationScope);
}
@Nullable
private SimpleScope getLastScope(SimpleScope simpleScope) {
SimpleScope scope = simpleScope;
do {
scope = (SimpleScope) scope.previousObservationScope;
}
while (scope != null && !this.currentObservation.equals(scope.currentObservation));
return scope;
}
@Override
public void reset() {
SimpleScope scope = this;
if (scope.currentObservation instanceof SimpleObservation) {
SimpleObservation simpleObservation = (SimpleObservation) scope.currentObservation;
do {
// We don't want to remove any enclosing scopes when resetting
// we just want to remove any scopes if they are present (that's why
// we're not calling scope#close)
simpleObservation.notifyOnScopeReset();
scope = (SimpleScope) scope.previousObservationScope;
}
while (scope != null);
}
registry.setCurrentObservationScope(null);
}
/**
* This method is called e.g. via
* {@link ObservationThreadLocalAccessor#restore(Observation)}. In that case,
* we're calling {@link ObservationThreadLocalAccessor#reset()} first, and we're
* closing all the scopes, HOWEVER those are called on the Observation scope that
* was present there in thread local at the time of calling the method, NOT on the
* scope that we want to make current (that one can contain some leftovers from
* previous scope openings like creation of e.g. Brave scope in the TracingContext
* that is there inside the Observation's Context.
*
* When we want to go back to the enclosing scope and want to make that scope
* current we need to be sure that there are no remaining scoped objects inside
* Observation's context. This is why BEFORE rebuilding the scope structure we
* need to notify the handlers to clear them first (again this is a separate scope
* to the one that was cleared by the reset method) via calling
* {@link ObservationHandler#onScopeReset(Context)}.
*/
@Override
public void makeCurrent() {
SimpleScope scope = this;
do {
// We don't want to remove any enclosing scopes when resetting
// we just want to remove any scopes if they are present (that's why we're
// not calling scope#close)
if (scope.currentObservation instanceof SimpleObservation) {
((SimpleObservation) scope.currentObservation).notifyOnScopeReset();
}
scope = (SimpleScope) scope.previousObservationScope;
}
while (scope != null);
Deque<SimpleScope> scopes = new ArrayDeque<>();
scope = this;
do {
scopes.addFirst(scope);
scope = (SimpleScope) scope.previousObservationScope;
}
while (scope != null);
for (SimpleScope simpleScope : scopes) {
if (simpleScope.currentObservation instanceof SimpleObservation) {
((SimpleObservation) simpleScope.currentObservation).notifyOnScopeMakeCurrent();
}
}
this.registry.setCurrentObservationScope(this);
}
@Nullable
@Override
public Scope getPreviousObservationScope() {
return this.previousObservationScope;
}
}
}