-
-
Notifications
You must be signed in to change notification settings - Fork 427
/
Breadcrumb.java
262 lines (229 loc) · 5.81 KB
/
Breadcrumb.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
package io.sentry;
import io.sentry.util.CollectionUtils;
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;
import org.jetbrains.annotations.TestOnly;
/** Series of application events */
public final class Breadcrumb implements Cloneable, IUnknownPropertiesConsumer {
/** 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;
}
/**
* 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;
}
/** 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;
}
/**
* Sets the unknown fields, internal usage only
*
* @param unknown the unknown's map
*/
@ApiStatus.Internal
@Override
public void acceptUnknownProperties(@NotNull Map<String, Object> unknown) {
this.unknown = new ConcurrentHashMap<>(unknown);
}
/**
* Returns the unknown's map, internal usage only
*
* @return the unknown map
*/
@TestOnly
@Nullable
Map<String, Object> getUnknown() {
return unknown;
}
/**
* Clones the breadcrumb aka deep copy
*
* @return the cloned breadcrumb
* @throws CloneNotSupportedException if a breadcrumb is not cloneable
*/
@Override
public @NotNull Breadcrumb clone() throws CloneNotSupportedException {
final Breadcrumb clone = (Breadcrumb) super.clone();
final Map<String, Object> dataCopy = CollectionUtils.newConcurrentHashMap(this.data);
if (dataCopy != null) {
clone.data = dataCopy;
}
clone.unknown = CollectionUtils.newConcurrentHashMap(unknown);
final SentryLevel levelRef = level;
clone.level =
levelRef != null ? SentryLevel.valueOf(levelRef.name().toUpperCase(Locale.ROOT)) : null;
return clone;
}
}