forked from getsentry/sentry-java
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathBreadcrumb.java
More file actions
522 lines (474 loc) · 14.7 KB
/
Breadcrumb.java
File metadata and controls
522 lines (474 loc) · 14.7 KB
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
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
package io.sentry;
import io.sentry.util.CollectionUtils;
import io.sentry.vendor.gson.stream.JsonToken;
import java.io.IOException;
import java.util.Collections;
import java.util.Date;
import java.util.Locale;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import org.jetbrains.annotations.ApiStatus;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
/** Series of application events */
public final class Breadcrumb implements JsonUnknown, JsonSerializable {
/** A timestamp representing when the breadcrumb occurred. */
private final @NotNull Date timestamp;
/** If a message is provided, its rendered as text and the whitespace is preserved. */
private @Nullable String message;
/** The type of breadcrumb. */
private @Nullable String type;
/** Data associated with this breadcrumb. */
private @NotNull Map<String, @NotNull Object> data = new ConcurrentHashMap<>();
/** Dotted strings that indicate what the crumb is or where it comes from. */
private @Nullable String category;
/** The level of the event. */
private @Nullable SentryLevel level;
/** the unknown fields of breadcrumbs, internal usage only */
private @Nullable Map<String, Object> unknown;
/**
* Breadcrumb ctor
*
* @param timestamp the timestamp
*/
public Breadcrumb(final @NotNull Date timestamp) {
this.timestamp = timestamp;
}
Breadcrumb(final @NotNull Breadcrumb breadcrumb) {
this.timestamp = breadcrumb.timestamp;
this.message = breadcrumb.message;
this.type = breadcrumb.type;
this.category = breadcrumb.category;
final Map<String, Object> dataClone = CollectionUtils.newConcurrentHashMap(breadcrumb.data);
if (dataClone != null) {
this.data = dataClone;
}
this.unknown = CollectionUtils.newConcurrentHashMap(breadcrumb.unknown);
this.level = breadcrumb.level;
}
/**
* Creates HTTP breadcrumb.
*
* @param url - the request URL
* @param method - the request method
* @return the breadcrumb
*/
public static @NotNull Breadcrumb http(final @NotNull String url, final @NotNull String method) {
final Breadcrumb breadcrumb = new Breadcrumb();
breadcrumb.setType("http");
breadcrumb.setCategory("http");
breadcrumb.setData("url", url);
breadcrumb.setData("method", method.toUpperCase(Locale.ROOT));
return breadcrumb;
}
/**
* Creates HTTP breadcrumb.
*
* @param url - the request URL
* @param method - the request method
* @param code - the code result. Code can be null when http request did not finish or ended with
* network error
* @return the breadcrumb
*/
public static @NotNull Breadcrumb http(
final @NotNull String url, final @NotNull String method, final @Nullable Integer code) {
final Breadcrumb breadcrumb = http(url, method);
if (code != null) {
breadcrumb.setData("status_code", code);
}
return breadcrumb;
}
/**
* Creates navigation breadcrumb - a navigation event can be a URL change in a web application, or
* a UI transition in a mobile or desktop application, etc.
*
* @param from - the original application state / location
* @param to - the new application state / location
* @return the breadcrumb
*/
public static @NotNull Breadcrumb navigation(
final @NotNull String from, final @NotNull String to) {
final Breadcrumb breadcrumb = new Breadcrumb();
breadcrumb.setCategory("navigation");
breadcrumb.setType("navigation");
breadcrumb.setData("from", from);
breadcrumb.setData("to", to);
return breadcrumb;
}
/**
* Creates transaction breadcrumb - describing a tracing event.
*
* @param message - the message
* @return the breadcrumb
*/
public static @NotNull Breadcrumb transaction(final @NotNull String message) {
final Breadcrumb breadcrumb = new Breadcrumb();
breadcrumb.setType("default");
breadcrumb.setCategory("sentry.transaction");
breadcrumb.setMessage(message);
return breadcrumb;
}
/**
* Creates debug breadcrumb - typically a log message. The data part is entirely undefined and as
* such, completely rendered as a key/value table.
*
* @param message - the message
* @return the breadcrumb
*/
public static @NotNull Breadcrumb debug(final @NotNull String message) {
final Breadcrumb breadcrumb = new Breadcrumb();
breadcrumb.setType("debug");
breadcrumb.setMessage(message);
breadcrumb.setLevel(SentryLevel.DEBUG);
return breadcrumb;
}
/**
* Creates error breadcrumb.
*
* @param message - the message
* @return the breadcrumb
*/
public static @NotNull Breadcrumb error(final @NotNull String message) {
final Breadcrumb breadcrumb = new Breadcrumb();
breadcrumb.setType("error");
breadcrumb.setMessage(message);
breadcrumb.setLevel(SentryLevel.ERROR);
return breadcrumb;
}
/**
* Creates info breadcrumb - information that helps identify the root cause of the issue or for
* whom the error occurred.
*
* @param message - the message
* @return the breadcrumb
*/
public static @NotNull Breadcrumb info(final @NotNull String message) {
final Breadcrumb breadcrumb = new Breadcrumb();
breadcrumb.setType("info");
breadcrumb.setMessage(message);
breadcrumb.setLevel(SentryLevel.INFO);
return breadcrumb;
}
/**
* Creates query breadcrumb - representing a query that was made in your application.
*
* @param message - the message
* @return the breadcrumb
*/
public static @NotNull Breadcrumb query(final @NotNull String message) {
final Breadcrumb breadcrumb = new Breadcrumb();
breadcrumb.setType("query");
breadcrumb.setMessage(message);
return breadcrumb;
}
/**
* Creates ui breadcrumb - a user interaction with your app's UI.
*
* @param category - the category, for example "click"
* @param message - the message
* @return the breadcrumb
*/
public static @NotNull Breadcrumb ui(
final @NotNull String category, final @NotNull String message) {
final Breadcrumb breadcrumb = new Breadcrumb();
breadcrumb.setType("default");
breadcrumb.setCategory("ui." + category);
breadcrumb.setMessage(message);
return breadcrumb;
}
/**
* Creates user breadcrumb - a user interaction with your app's UI.
*
* @param message - the message
* @return the breadcrumb
*/
public static @NotNull Breadcrumb user(
final @NotNull String category, final @NotNull String message) {
final Breadcrumb breadcrumb = new Breadcrumb();
breadcrumb.setType("user");
breadcrumb.setCategory(category);
breadcrumb.setMessage(message);
return breadcrumb;
}
/**
* Creates user breadcrumb - a user interaction with your app's UI. The breadcrumb can contain
* additional data like {@code viewId} or {@code viewClass}. By default, the breadcrumb is
* captured with {@link SentryLevel} INFO level.
*
* @param subCategory - the category, for example "click"
* @param viewId - the human-readable view id, for example "button_load"
* @param viewClass - the fully qualified class name, for example "android.widget.Button"
* @return the breadcrumb
*/
public static @NotNull Breadcrumb userInteraction(
final @NotNull String subCategory,
final @Nullable String viewId,
final @Nullable String viewClass) {
return userInteraction(subCategory, viewId, viewClass, Collections.emptyMap());
}
/**
* Creates user breadcrumb - a user interaction with your app's UI. The breadcrumb can contain
* additional data like {@code viewId} or {@code viewClass}. By default, the breadcrumb is
* captured with {@link SentryLevel} INFO level.
*
* @param subCategory - the category, for example "click"
* @param viewId - the human-readable view id, for example "button_load"
* @param viewClass - the fully qualified class name, for example "android.widget.Button"
* @param additionalData - additional properties to be put into the data bag
* @return the breadcrumb
*/
public static @NotNull Breadcrumb userInteraction(
final @NotNull String subCategory,
final @Nullable String viewId,
final @Nullable String viewClass,
final @NotNull Map<String, Object> additionalData) {
final Breadcrumb breadcrumb = new Breadcrumb();
breadcrumb.setType("user");
breadcrumb.setCategory("ui." + subCategory);
if (viewId != null) {
breadcrumb.setData("view.id", viewId);
}
if (viewClass != null) {
breadcrumb.setData("view.class", viewClass);
}
for (final Map.Entry<String, Object> entry : additionalData.entrySet()) {
breadcrumb.getData().put(entry.getKey(), entry.getValue());
}
breadcrumb.setLevel(SentryLevel.INFO);
return breadcrumb;
}
/** Breadcrumb ctor */
public Breadcrumb() {
this(DateUtils.getCurrentDateTime());
}
/**
* Breadcrumb ctor
*
* @param message the message
*/
public Breadcrumb(@Nullable String message) {
this();
this.message = message;
}
/**
* Returns the Breadcrumb's timestamp
*
* @return the timestamp
*/
@SuppressWarnings({"JdkObsolete", "JavaUtilDate"})
public @NotNull Date getTimestamp() {
return (Date) timestamp.clone();
}
/**
* Returns the message
*
* @return the message
*/
public @Nullable String getMessage() {
return message;
}
/**
* Sets the message
*
* @param message the message
*/
public void setMessage(@Nullable String message) {
this.message = message;
}
/**
* Returns the type
*
* @return the type
*/
public @Nullable String getType() {
return type;
}
/**
* Sets the type
*
* @param type the type
*/
public void setType(@Nullable String type) {
this.type = type;
}
/**
* Returns the data map
*
* @return the data map
*/
@ApiStatus.Internal
@NotNull
public Map<String, Object> getData() {
return data;
}
/**
* Returns the value of data[key] or null
*
* @param key the key
* @return the value or null
*/
@Nullable
public Object getData(final @NotNull String key) {
return data.get(key);
}
/**
* Sets an entry to the data's map
*
* @param key the key
* @param value the value
*/
public void setData(@NotNull String key, @NotNull Object value) {
data.put(key, value);
}
/**
* Removes an entry from the data's map
*
* @param key the key
*/
public void removeData(@NotNull String key) {
data.remove(key);
}
/**
* Returns the category
*
* @return the category
*/
public @Nullable String getCategory() {
return category;
}
/**
* Sets the category
*
* @param category the category
*/
public void setCategory(@Nullable String category) {
this.category = category;
}
/**
* Returns the SentryLevel
*
* @return the level
*/
public @Nullable SentryLevel getLevel() {
return level;
}
/**
* Sets the level
*
* @param level the level
*/
public void setLevel(@Nullable SentryLevel level) {
this.level = level;
}
// region json
@Nullable
@Override
public Map<String, Object> getUnknown() {
return unknown;
}
@Override
public void setUnknown(@Nullable Map<String, Object> unknown) {
this.unknown = unknown;
}
public static final class JsonKeys {
public static final String TIMESTAMP = "timestamp";
public static final String MESSAGE = "message";
public static final String TYPE = "type";
public static final String DATA = "data";
public static final String CATEGORY = "category";
public static final String LEVEL = "level";
}
@Override
public void serialize(@NotNull JsonObjectWriter writer, @NotNull ILogger logger)
throws IOException {
writer.beginObject();
writer.name(JsonKeys.TIMESTAMP).value(logger, timestamp);
if (message != null) {
writer.name(JsonKeys.MESSAGE).value(message);
}
if (type != null) {
writer.name(JsonKeys.TYPE).value(type);
}
writer.name(JsonKeys.DATA).value(logger, data);
if (category != null) {
writer.name(JsonKeys.CATEGORY).value(category);
}
if (level != null) {
writer.name(JsonKeys.LEVEL).value(logger, level);
}
if (unknown != null) {
for (String key : unknown.keySet()) {
Object value = unknown.get(key);
writer.name(key);
writer.value(logger, value);
}
}
writer.endObject();
}
public static final class Deserializer implements JsonDeserializer<Breadcrumb> {
@SuppressWarnings("unchecked")
@Override
public @NotNull Breadcrumb deserialize(
@NotNull JsonObjectReader reader, @NotNull ILogger logger) throws Exception {
reader.beginObject();
@NotNull Date timestamp = DateUtils.getCurrentDateTime();
String message = null;
String type = null;
@NotNull Map<String, Object> data = new ConcurrentHashMap<>();
String category = null;
SentryLevel level = null;
Map<String, Object> unknown = null;
while (reader.peek() == JsonToken.NAME) {
final String nextName = reader.nextName();
switch (nextName) {
case JsonKeys.TIMESTAMP:
Date deserializedDate = reader.nextDateOrNull(logger);
if (deserializedDate != null) {
timestamp = deserializedDate;
}
break;
case JsonKeys.MESSAGE:
message = reader.nextStringOrNull();
break;
case JsonKeys.TYPE:
type = reader.nextStringOrNull();
break;
case JsonKeys.DATA:
Map<String, Object> deserializedData =
CollectionUtils.newConcurrentHashMap(
(Map<String, Object>) reader.nextObjectOrNull());
if (deserializedData != null) {
data = deserializedData;
}
break;
case JsonKeys.CATEGORY:
category = reader.nextStringOrNull();
break;
case JsonKeys.LEVEL:
try {
level = new SentryLevel.Deserializer().deserialize(reader, logger);
} catch (Exception exception) {
logger.log(SentryLevel.ERROR, exception, "Error when deserializing SentryLevel");
}
break;
default:
if (unknown == null) {
unknown = new ConcurrentHashMap<>();
}
reader.nextUnknown(logger, unknown, nextName);
break;
}
}
Breadcrumb breadcrumb = new Breadcrumb(timestamp);
breadcrumb.message = message;
breadcrumb.type = type;
breadcrumb.data = data;
breadcrumb.category = category;
breadcrumb.level = level;
breadcrumb.setUnknown(unknown);
reader.endObject();
return breadcrumb;
}
}
// endregion
}