forked from getsentry/sentry-java
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathSentry.java
More file actions
510 lines (445 loc) · 15 KB
/
Copy pathSentry.java
File metadata and controls
510 lines (445 loc) · 15 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
package io.sentry;
import io.sentry.cache.EnvelopeCache;
import io.sentry.config.PropertiesProviderFactory;
import io.sentry.protocol.SentryId;
import io.sentry.protocol.User;
import java.io.File;
import java.lang.reflect.InvocationTargetException;
import java.util.List;
import org.jetbrains.annotations.ApiStatus;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
/** Sentry SDK main API entry point */
public final class Sentry {
private Sentry() {}
/** Holds Hubs per thread or only mainHub if globalHubMode is enabled. */
private static final @NotNull ThreadLocal<IHub> currentHub = new ThreadLocal<>();
/** The Main Hub or NoOp if Sentry is disabled. */
private static volatile @NotNull IHub mainHub = NoOpHub.getInstance();
/** Default value for globalHubMode is false */
private static final boolean GLOBAL_HUB_DEFAULT_MODE = false;
/** whether to use a single (global) Hub as opposed to one per thread. */
private static volatile boolean globalHubMode = GLOBAL_HUB_DEFAULT_MODE;
/**
* Returns the current (threads) hub, if none, clones the mainHub and returns it.
*
* @return the hub
*/
static @NotNull IHub getCurrentHub() {
if (globalHubMode) {
return mainHub;
}
IHub hub = currentHub.get();
if (hub == null) {
hub = mainHub.clone();
currentHub.set(hub);
}
return hub;
}
/**
* Check if the current Hub is enabled/active.
*
* @return true if its enabled or false otherwise.
*/
public static boolean isEnabled() {
return getCurrentHub().isEnabled();
}
/** Initializes the SDK */
public static void init() {
init(options -> options.setEnableExternalConfiguration(true), GLOBAL_HUB_DEFAULT_MODE);
}
/**
* Initializes the SDK
*
* @param clazz OptionsContainer for SentryOptions
* @param optionsConfiguration configuration options callback
* @param <T> class that extends SentryOptions
* @throws IllegalAccessException the IllegalAccessException
* @throws InstantiationException the InstantiationException
* @throws NoSuchMethodException the NoSuchMethodException
* @throws InvocationTargetException the InvocationTargetException
*/
public static <T extends SentryOptions> void init(
final @NotNull OptionsContainer<T> clazz,
final @NotNull OptionsConfiguration<T> optionsConfiguration)
throws IllegalAccessException, InstantiationException, NoSuchMethodException,
InvocationTargetException {
init(clazz, optionsConfiguration, GLOBAL_HUB_DEFAULT_MODE);
}
/**
* Initializes the SDK
*
* @param clazz OptionsContainer for SentryOptions
* @param optionsConfiguration configuration options callback
* @param globalHubMode the globalHubMode
* @param <T> class that extends SentryOptions
* @throws IllegalAccessException the IllegalAccessException
* @throws InstantiationException the InstantiationException
* @throws NoSuchMethodException the NoSuchMethodException
* @throws InvocationTargetException the InvocationTargetException
*/
public static <T extends SentryOptions> void init(
final @NotNull OptionsContainer<T> clazz,
final @NotNull OptionsConfiguration<T> optionsConfiguration,
final boolean globalHubMode)
throws IllegalAccessException, InstantiationException, NoSuchMethodException,
InvocationTargetException {
final T options = clazz.createInstance();
optionsConfiguration.configure(options);
init(options, globalHubMode);
}
/**
* Initializes the SDK with an optional configuration options callback.
*
* @param optionsConfiguration configuration options callback
*/
public static void init(final @NotNull OptionsConfiguration<SentryOptions> optionsConfiguration) {
init(optionsConfiguration, GLOBAL_HUB_DEFAULT_MODE);
}
/**
* Initializes the SDK with an optional configuration options callback.
*
* @param optionsConfiguration configuration options callback
* @param globalHubMode the globalHubMode
*/
public static void init(
final @NotNull OptionsConfiguration<SentryOptions> optionsConfiguration,
final boolean globalHubMode) {
final SentryOptions options = new SentryOptions();
optionsConfiguration.configure(options);
init(options, globalHubMode);
}
/**
* Initializes the SDK with a SentryOptions.
*
* @param options options the SentryOptions
*/
@ApiStatus.Internal
public static void init(final @NotNull SentryOptions options) {
init(options, GLOBAL_HUB_DEFAULT_MODE);
}
/**
* Initializes the SDK with a SentryOptions and globalHubMode
*
* @param options options the SentryOptions
* @param globalHubMode the globalHubMode
*/
private static synchronized void init(
final @NotNull SentryOptions options, final boolean globalHubMode) {
if (isEnabled()) {
options
.getLogger()
.log(
SentryLevel.WARNING,
"Sentry has been already initialized. Previous configuration will be overwritten.");
}
if (!initConfigurations(options)) {
return;
}
options.getLogger().log(SentryLevel.INFO, "GlobalHubMode: '%s'", String.valueOf(globalHubMode));
Sentry.globalHubMode = globalHubMode;
final IHub hub = getCurrentHub();
mainHub = new Hub(options);
currentHub.set(mainHub);
hub.close();
// when integrations are registered on Hub ctor and async integrations are fired,
// it might and actually happened that integrations called captureSomething
// and hub was still NoOp.
// Registering integrations here make sure that Hub is already created.
for (final Integration integration : options.getIntegrations()) {
integration.register(HubAdapter.getInstance(), options);
}
}
private static boolean initConfigurations(final @NotNull SentryOptions options) {
if (options.isEnableExternalConfiguration()) {
options.merge(SentryOptions.from(PropertiesProviderFactory.create()));
}
final String dsn = options.getDsn();
if (dsn == null) {
throw new IllegalArgumentException("DSN is required. Use empty string to disable SDK.");
} else if (dsn.isEmpty()) {
close();
return false;
}
@SuppressWarnings("unused")
final Dsn parsedDsn = new Dsn(dsn);
ILogger logger = options.getLogger();
if (options.isDebug() && logger instanceof NoOpLogger) {
options.setLogger(new SystemOutLogger());
logger = options.getLogger();
}
logger.log(SentryLevel.INFO, "Initializing SDK with DSN: '%s'", options.getDsn());
// TODO: read values from conf file, Build conf or system envs
// eg release, distinctId, sentryClientName
if (options.getSerializer() instanceof NoOpSerializer) {
options.setSerializer(new GsonSerializer(logger, options.getEnvelopeReader()));
}
// this should be after setting serializers
if (options.getCacheDirPath() != null && !options.getCacheDirPath().isEmpty()) {
final File cacheDir = new File(options.getCacheDirPath());
cacheDir.mkdirs();
final File outboxDir = new File(options.getOutboxPath());
outboxDir.mkdirs();
options.setEnvelopeDiskCache(new EnvelopeCache(options));
} else {
logger.log(SentryLevel.INFO, "No outbox dir path is defined in options.");
}
return true;
}
/** Close the SDK */
public static synchronized void close() {
final IHub hub = getCurrentHub();
mainHub = NoOpHub.getInstance();
hub.close();
}
/**
* Captures the event.
*
* @param event the event
* @return The Id (SentryId object) of the event
*/
public static @NotNull SentryId captureEvent(final @NotNull SentryEvent event) {
return getCurrentHub().captureEvent(event);
}
/**
* Captures the event.
*
* @param event the event
* @param hint SDK specific but provides high level information about the origin of the event
* @return The Id (SentryId object) of the event
*/
public static @NotNull SentryId captureEvent(
final @NotNull SentryEvent event, final @Nullable Object hint) {
return getCurrentHub().captureEvent(event, hint);
}
/**
* Captures the message.
*
* @param message The message to send.
* @return The Id (SentryId object) of the event
*/
public static @NotNull SentryId captureMessage(final @NotNull String message) {
return getCurrentHub().captureMessage(message);
}
/**
* Captures the message.
*
* @param message The message to send.
* @param level The message level.
* @return The Id (SentryId object) of the event
*/
public static @NotNull SentryId captureMessage(
final @NotNull String message, final @NotNull SentryLevel level) {
return getCurrentHub().captureMessage(message, level);
}
/**
* Captures the exception.
*
* @param throwable The exception.
* @return The Id (SentryId object) of the event
*/
public static @NotNull SentryId captureException(final @NotNull Throwable throwable) {
return getCurrentHub().captureException(throwable);
}
/**
* Captures the exception.
*
* @param throwable The exception.
* @param hint SDK specific but provides high level information about the origin of the event
* @return The Id (SentryId object) of the event
*/
public static @NotNull SentryId captureException(
final @NotNull Throwable throwable, final @Nullable Object hint) {
return getCurrentHub().captureException(throwable, hint);
}
/**
* Captures a manually created user feedback and sends it to Sentry.
*
* @param userFeedback The user feedback to send to Sentry.
*/
public static void captureUserFeedback(UserFeedback userFeedback) {
getCurrentHub().captureUserFeedback(userFeedback);
}
/**
* Adds a breadcrumb to the current Scope
*
* @param breadcrumb the breadcrumb
* @param hint SDK specific but provides high level information about the origin of the event
*/
public static void addBreadcrumb(
final @NotNull Breadcrumb breadcrumb, final @Nullable Object hint) {
getCurrentHub().addBreadcrumb(breadcrumb, hint);
}
/**
* Adds a breadcrumb to the current Scope
*
* @param breadcrumb the breadcrumb
*/
public static void addBreadcrumb(final @NotNull Breadcrumb breadcrumb) {
getCurrentHub().addBreadcrumb(breadcrumb);
}
/**
* Adds a breadcrumb to the current Scope
*
* @param message rendered as text and the whitespace is preserved.
*/
public static void addBreadcrumb(final @NotNull String message) {
getCurrentHub().addBreadcrumb(message);
}
/**
* Adds a breadcrumb to the current Scope
*
* @param message rendered as text and the whitespace is preserved.
* @param category Categories are dotted strings that indicate what the crumb is or where it comes
* from.
*/
public static void addBreadcrumb(final @NotNull String message, final @NotNull String category) {
getCurrentHub().addBreadcrumb(message, category);
}
/**
* Sets the level of all events sent within current Scope
*
* @param level the Sentry level
*/
public static void setLevel(final @Nullable SentryLevel level) {
getCurrentHub().setLevel(level);
}
/**
* Sets the name of the current transaction to the current Scope.
*
* @param transaction the transaction
*/
public static void setTransaction(final @Nullable String transaction) {
getCurrentHub().setTransaction(transaction);
}
/**
* Shallow merges user configuration (email, username, etc) to the current Scope.
*
* @param user the user
*/
public static void setUser(final @Nullable User user) {
getCurrentHub().setUser(user);
}
/**
* Sets the fingerprint to group specific events together to the current Scope.
*
* @param fingerprint the fingerprints
*/
public static void setFingerprint(final @NotNull List<String> fingerprint) {
getCurrentHub().setFingerprint(fingerprint);
}
/** Deletes current breadcrumbs from the current scope. */
public static void clearBreadcrumbs() {
getCurrentHub().clearBreadcrumbs();
}
/**
* Sets the tag to a string value to the current Scope, overwriting a potential previous value
*
* @param key the key
* @param value the value
*/
public static void setTag(final @NotNull String key, final @NotNull String value) {
getCurrentHub().setTag(key, value);
}
/**
* Removes the tag to a string value to the current Scope
*
* @param key the key
*/
public static void removeTag(final @NotNull String key) {
getCurrentHub().removeTag(key);
}
/**
* Sets the extra key to an arbitrary value to the current Scope, overwriting a potential previous
* value
*
* @param key the key
* @param value the value
*/
public static void setExtra(final @NotNull String key, final @NotNull String value) {
getCurrentHub().setExtra(key, value);
}
/**
* Removes the extra key to an arbitrary value to the current Scope
*
* @param key the key
*/
public static void removeExtra(final @NotNull String key) {
getCurrentHub().removeExtra(key);
}
/**
* Last event id recorded in the current scope
*
* @return last SentryId
*/
public static @NotNull SentryId getLastEventId() {
return getCurrentHub().getLastEventId();
}
/** Pushes a new scope while inheriting the current scope's data. */
public static void pushScope() {
// pushScope is no-op in global hub mode
if (!globalHubMode) {
getCurrentHub().pushScope();
}
}
/** Removes the first scope */
public static void popScope() {
// popScope is no-op in global hub mode
if (!globalHubMode) {
getCurrentHub().popScope();
}
}
/**
* Runs the callback with a new scope which gets dropped at the end
*
* @param callback the callback
*/
public static void withScope(final @NotNull ScopeCallback callback) {
getCurrentHub().withScope(callback);
}
/**
* Configures the scope through the callback.
*
* @param callback The configure scope callback.
*/
public static void configureScope(final @NotNull ScopeCallback callback) {
getCurrentHub().configureScope(callback);
}
/**
* Binds a different client to the current hub
*
* @param client the client.
*/
public static void bindClient(final @NotNull ISentryClient client) {
getCurrentHub().bindClient(client);
}
/**
* Flushes events queued up to the current hub. Not implemented yet.
*
* @param timeoutMillis time in milliseconds
*/
public static void flush(final long timeoutMillis) {
getCurrentHub().flush(timeoutMillis);
}
/** Starts a new session. If there's a running session, it ends it before starting the new one. */
public static void startSession() {
getCurrentHub().startSession();
}
/** Ends the current session */
public static void endSession() {
getCurrentHub().endSession();
}
/**
* Configuration options callback
*
* @param <T> a class that extends SentryOptions or SentryOptions itself.
*/
public interface OptionsConfiguration<T extends SentryOptions> {
/**
* configure the options
*
* @param options the options
*/
void configure(@NotNull T options);
}
}