-
Notifications
You must be signed in to change notification settings - Fork 7
/
Embrace.java
714 lines (604 loc) · 22 KB
/
Embrace.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
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
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
package io.embrace.android.embracesdk;
import static io.embrace.android.embracesdk.logging.InternalStaticEmbraceLogger.logger;
import android.annotation.SuppressLint;
import android.content.Context;
import android.webkit.ConsoleMessage;
import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import java.util.List;
import java.util.Map;
import io.embrace.android.embracesdk.annotation.InternalApi;
import io.embrace.android.embracesdk.internal.EmbraceInternalInterface;
import io.embrace.android.embracesdk.internal.Systrace;
import io.embrace.android.embracesdk.logging.InternalEmbraceLogger;
import io.embrace.android.embracesdk.logging.InternalStaticEmbraceLogger;
import io.embrace.android.embracesdk.network.EmbraceNetworkRequest;
import io.embrace.android.embracesdk.payload.PushNotificationBreadcrumb;
import io.embrace.android.embracesdk.spans.EmbraceSpan;
import io.embrace.android.embracesdk.spans.EmbraceSpanEvent;
import io.embrace.android.embracesdk.spans.ErrorCode;
import io.opentelemetry.sdk.trace.export.SpanExporter;
import kotlin.jvm.functions.Function0;
/**
* Entry point for the SDK. This class is part of the Embrace Public API.
* <p>
* Contains a singleton instance of itself, and is used for initializing the SDK.
*/
@SuppressLint("EmbracePublicApiPackageRule")
@SuppressWarnings("unused")
public final class Embrace implements EmbraceAndroidApi {
/**
* Singleton instance of the Embrace SDK.
*/
@NonNull
private static final Embrace embrace = new Embrace();
private static EmbraceImpl impl = Systrace.traceSynchronous("embrace-impl-init", EmbraceImpl::new);
@NonNull
private final InternalEmbraceLogger internalEmbraceLogger = InternalStaticEmbraceLogger.logger;
static final String NULL_PARAMETER_ERROR_MESSAGE_TEMPLATE = " cannot be invoked because it contains null parameters";
/**
* Gets the singleton instance of the Embrace SDK.
*
* @return the instance of the Embrace SDK
*/
@NonNull
public static Embrace getInstance() {
return embrace;
}
/**
* Gets the EmbraceImpl instance. This provides access to internally visible functions
* intended for use in the Android SDK only
*/
@NonNull
static EmbraceImpl getImpl() {
return impl;
}
static void setImpl(@Nullable EmbraceImpl instance) {
impl = instance;
}
Embrace() {
}
@Override
public void start(@NonNull Context context) {
if (verifyNonNullParameters("start", context)) {
start(context, true, AppFramework.NATIVE);
}
}
@Override
public void start(@NonNull Context context, boolean enableIntegrationTesting) {
if (verifyNonNullParameters("start", context)) {
start(context, enableIntegrationTesting, AppFramework.NATIVE);
}
}
@Override
public void start(@NonNull Context context, boolean enableIntegrationTesting, @NonNull AppFramework appFramework) {
if (verifyNonNullParameters("start", context, appFramework)) {
impl.start(context, enableIntegrationTesting, appFramework);
}
}
@Override
public boolean isStarted() {
return impl.isStarted();
}
@Override
public boolean setAppId(@NonNull String appId) {
if (verifyNonNullParameters("setAppId", appId)) {
return impl.setAppId(appId);
} else {
return false;
}
}
@Override
public void setUserIdentifier(@Nullable String userId) {
impl.setUserIdentifier(userId);
}
@Override
public void clearUserIdentifier() {
impl.clearUserIdentifier();
}
@Override
public void setUserEmail(@Nullable String email) {
impl.setUserEmail(email);
}
@Override
public void clearUserEmail() {
impl.clearUserEmail();
}
@Override
public void setUserAsPayer() {
impl.setUserAsPayer();
}
@Override
public void clearUserAsPayer() {
impl.clearUserAsPayer();
}
@Override
public void addUserPersona(@NonNull String persona) {
if (verifyNonNullParameters("addUserPersona", persona)) {
impl.addUserPersona(persona);
}
}
@Override
public void clearUserPersona(@NonNull String persona) {
if (verifyNonNullParameters("clearUserPersona", persona)) {
impl.clearUserPersona(persona);
}
}
@Override
public void clearAllUserPersonas() {
impl.clearAllUserPersonas();
}
@Override
public boolean addSessionProperty(@NonNull String key, @NonNull String value, boolean permanent) {
if (verifyNonNullParameters("addSessionProperty", key, value)) {
return impl.addSessionProperty(key, value, permanent);
}
return false;
}
@Override
public boolean removeSessionProperty(@NonNull String key) {
if (verifyNonNullParameters("removeSessionProperty", key)) {
return impl.removeSessionProperty(key);
}
return false;
}
@Override
@Nullable
public Map<String, String> getSessionProperties() {
return impl.getSessionProperties();
}
@Override
public void setUsername(@Nullable String username) {
impl.setUsername(username);
}
@Override
public void clearUsername() {
impl.clearUsername();
}
@Override
public void startMoment(@NonNull String name) {
if (verifyNonNullParameters("startMoment", name)) {
startMoment(name, null);
}
}
@Override
public void startMoment(@NonNull String name, @Nullable String identifier) {
if (verifyNonNullParameters("startMoment", name)) {
startMoment(name, identifier, null);
}
}
@Override
public void startMoment(@NonNull String name,
@Nullable String identifier,
@Nullable Map<String, Object> properties) {
if (verifyNonNullParameters("startMoment", name)) {
impl.startMoment(name, identifier, properties);
}
}
@Override
public void endMoment(@NonNull String name) {
if (verifyNonNullParameters("endMoment", name)) {
endMoment(name, null, null);
}
}
@Override
public void endMoment(@NonNull String name, @Nullable String identifier) {
if (verifyNonNullParameters("endMoment", name)) {
endMoment(name, identifier, null);
}
}
@Override
public void endMoment(@NonNull String name, @Nullable Map<String, Object> properties) {
if (verifyNonNullParameters("endMoment", name)) {
endMoment(name, null, properties);
}
}
@Override
public void endMoment(@NonNull String name, @Nullable String identifier, @Nullable Map<String, Object> properties) {
if (verifyNonNullParameters("endMoment", name)) {
impl.endMoment(name, identifier, properties);
}
}
@Override
public void endAppStartup() {
impl.endAppStartup(null);
}
@Override
public void endAppStartup(@NonNull Map<String, Object> properties) {
if (verifyNonNullParameters("endAppStartup", properties)) {
impl.endAppStartup(properties);
}
}
@Override
@NonNull
public String getTraceIdHeader() {
return impl.getTraceIdHeader();
}
@NonNull
@Override
public String generateW3cTraceparent() {
return impl.generateW3cTraceparent();
}
@Override
public void recordNetworkRequest(@NonNull EmbraceNetworkRequest networkRequest) {
if (verifyNonNullParameters("recordNetworkRequest", networkRequest)) {
impl.recordNetworkRequest(networkRequest);
}
}
@Override
public void logInfo(@NonNull String message) {
if (verifyNonNullParameters("logInfo", message)) {
logMessage(message, Severity.INFO);
}
}
@Override
public void logWarning(@NonNull String message) {
if (verifyNonNullParameters("logWarning", message)) {
logMessage(message, Severity.WARNING);
}
}
@Override
public void logError(@NonNull String message) {
if (verifyNonNullParameters("logError", message)) {
logMessage(message, Severity.ERROR);
}
}
@Override
public void addBreadcrumb(@NonNull String message) {
if (verifyNonNullParameters("addBreadcrumb", message)) {
impl.addBreadcrumb(message);
}
}
@Override
public void logMessage(@NonNull String message, @NonNull Severity severity) {
if (verifyNonNullParameters("logMessage", message, severity)) {
logMessage(message, severity, null);
}
}
@Override
public void logMessage(@NonNull String message,
@NonNull Severity severity,
@Nullable Map<String, ?> properties) {
if (verifyNonNullParameters("logMessage", message, severity)) {
impl.logMessage(message, severity, properties);
}
}
@Override
public void logException(@NonNull Throwable throwable) {
if (verifyNonNullParameters("logException", throwable)) {
logException(throwable, Severity.ERROR);
}
}
@Override
public void logException(@NonNull Throwable throwable, @NonNull Severity severity) {
if (verifyNonNullParameters("logException", throwable, severity)) {
logException(throwable, severity, null);
}
}
@Override
public void logException(@NonNull Throwable throwable,
@NonNull Severity severity,
@Nullable Map<String, ?> properties) {
if (verifyNonNullParameters("logException", throwable, severity)) {
logException(throwable, severity, properties, null);
}
}
@Override
public void logException(@NonNull Throwable throwable,
@NonNull Severity severity,
@Nullable Map<String, ?> properties,
@Nullable String message) {
if (verifyNonNullParameters("logException", throwable, severity)) {
impl.logException(throwable, severity, properties, message);
}
}
@Override
public void logCustomStacktrace(@NonNull StackTraceElement[] stacktraceElements) {
if (verifyNonNullParameters("logCustomStacktrace", (Object) stacktraceElements)) {
logCustomStacktrace(stacktraceElements, Severity.ERROR);
}
}
@Override
public void logCustomStacktrace(@NonNull StackTraceElement[] stacktraceElements, @NonNull Severity severity) {
if (verifyNonNullParameters("logCustomStacktrace", (Object) stacktraceElements, severity)) {
logCustomStacktrace(stacktraceElements, severity, null);
}
}
@Override
public void logCustomStacktrace(@NonNull StackTraceElement[] stacktraceElements,
@NonNull Severity severity,
@Nullable Map<String, ?> properties) {
if (verifyNonNullParameters("logCustomStacktrace", (Object) stacktraceElements, severity)) {
logCustomStacktrace(stacktraceElements, severity, properties, null);
}
}
@Override
public void logCustomStacktrace(@NonNull StackTraceElement[] stacktraceElements,
@NonNull Severity severity,
@Nullable Map<String, ?> properties,
@Nullable String message) {
if (verifyNonNullParameters("logCustomStacktrace", (Object) stacktraceElements, severity)) {
impl.logCustomStacktrace(stacktraceElements, severity, properties, message);
}
}
@Override
public synchronized void endSession() {
endSession(false);
}
@Override
public synchronized void endSession(boolean clearUserInfo) {
impl.endSession(clearUserInfo);
}
@Override
@NonNull
public String getDeviceId() {
return impl.getDeviceId();
}
@Override
public boolean startView(@NonNull String name) {
if (verifyNonNullParameters("startView", name)) {
return impl.startView(name);
}
return false;
}
@Override
public boolean endView(@NonNull String name) {
if (verifyNonNullParameters("endView", name)) {
return impl.endView(name);
}
return false;
}
@SuppressWarnings("deprecation")
@Override
public boolean isTracingAvailable() {
return impl.tracer.isTracingAvailable();
}
@Nullable
@Override
public EmbraceSpan createSpan(@NonNull String name) {
if (verifyNonNullParameters("createSpan", name)) {
return impl.tracer.createSpan(name);
}
return null;
}
@Nullable
@Override
public EmbraceSpan createSpan(@NonNull String name, @Nullable EmbraceSpan parent) {
if (verifyNonNullParameters("createSpan", name)) {
return impl.tracer.createSpan(name, parent);
}
return null;
}
@Nullable
@Override
public EmbraceSpan startSpan(@NonNull String name) {
return startSpan(name, null, null);
}
@Nullable
@Override
public EmbraceSpan startSpan(@NonNull String name, @Nullable EmbraceSpan parent) {
return startSpan(name, parent, null);
}
@Nullable
@Override
public EmbraceSpan startSpan(@NonNull String name, @Nullable EmbraceSpan parent, @Nullable Long startTimeMs) {
if (verifyNonNullParameters("startSpan", name)) {
return impl.tracer.startSpan(name, parent, startTimeMs);
}
return null;
}
@Override
public <T> T recordSpan(@NonNull String name, @NonNull Function0<? extends T> code) {
return recordSpan(name, null, null, null, code);
}
@Override
public <T> T recordSpan(@NonNull String name, @Nullable EmbraceSpan parent, @NonNull Function0<? extends T> code) {
return recordSpan(name, parent, null, null, code);
}
@Override
public <T> T recordSpan(@NonNull String name, @Nullable Map<String, String> attributes,
@Nullable List<EmbraceSpanEvent> events, @NonNull Function0<? extends T> code) {
return recordSpan(name, null, attributes, events, code);
}
@Override
public <T> T recordSpan(@NonNull String name, @Nullable EmbraceSpan parent, @Nullable Map<String, String> attributes,
@Nullable List<EmbraceSpanEvent> events, @NonNull Function0<? extends T> code) {
if (verifyNonNullParameters("recordSpan", name, code)) {
return impl.tracer.recordSpan(name, parent, attributes, events, code);
}
return code != null ? code.invoke() : null;
}
@Override
public boolean recordCompletedSpan(@NonNull String name, long startTimeMs, long endTimeMs, @Nullable ErrorCode errorCode,
@Nullable EmbraceSpan parent, @Nullable Map<String, String> attributes,
@Nullable List<EmbraceSpanEvent> events) {
if (verifyNonNullParameters("recordCompletedSpan", name)) {
return impl.tracer.recordCompletedSpan(name, startTimeMs, endTimeMs, errorCode, parent, attributes, events);
}
return false;
}
@Override
public boolean recordCompletedSpan(@NonNull String name, long startTimeMs, long endTimeMs) {
return recordCompletedSpan(name, startTimeMs, endTimeMs, null, null, null, null);
}
@Override
public boolean recordCompletedSpan(@NonNull String name, long startTimeMs, long endTimeMs, @Nullable ErrorCode errorCode) {
return recordCompletedSpan(name, startTimeMs, endTimeMs, errorCode, null, null, null);
}
@Override
public boolean recordCompletedSpan(@NonNull String name, long startTimeMs, long endTimeMs, @Nullable EmbraceSpan parent) {
return recordCompletedSpan(name, startTimeMs, endTimeMs, null, parent, null, null);
}
@Override
public boolean recordCompletedSpan(@NonNull String name, long startTimeMs, long endTimeMs, @Nullable ErrorCode errorCode,
@Nullable EmbraceSpan parent) {
return recordCompletedSpan(name, startTimeMs, endTimeMs, errorCode, parent, null, null);
}
@Override
public boolean recordCompletedSpan(@NonNull String name, long startTimeMs, long endTimeMs,
@Nullable Map<String, String> attributes, @Nullable List<EmbraceSpanEvent> events) {
return recordCompletedSpan(name, startTimeMs, endTimeMs, null, null, attributes, events);
}
@Nullable
@Override
public EmbraceSpan getSpan(@NonNull String spanId) {
if (verifyNonNullParameters("getSpan", spanId)) {
return impl.tracer.getSpan(spanId);
}
return null;
}
/**
* Adds a [SpanExporter] to the tracer.
*
* @param spanExporter the span exporter to add
*/
@Override
public void addSpanExporter(@NonNull SpanExporter spanExporter) {
if (verifyNonNullParameters("addSpanExporter", spanExporter)) {
impl.addSpanExporter(spanExporter);
}
}
@Override
public void logPushNotification(@Nullable String title,
@Nullable String body,
@Nullable String topic,
@Nullable String id,
@Nullable Integer notificationPriority,
@NonNull Integer messageDeliveredPriority,
@NonNull Boolean isNotification,
@NonNull Boolean hasData) {
if (verifyNonNullParameters("logPushNotification", messageDeliveredPriority, isNotification, hasData)) {
impl.logPushNotification(
title,
body,
topic,
id,
notificationPriority,
messageDeliveredPriority,
PushNotificationBreadcrumb.NotificationType.Builder.notificationTypeFor(hasData, isNotification)
);
}
}
@Override
public void trackWebViewPerformance(@NonNull String tag, @NonNull ConsoleMessage consoleMessage) {
if (verifyNonNullParameters("trackWebViewPerformance", tag, consoleMessage)) {
if (consoleMessage.message() != null) {
trackWebViewPerformance(tag, consoleMessage.message());
} else {
logger.logDebug("Empty WebView console message.");
}
}
}
@Override
public void trackWebViewPerformance(@NonNull String tag, @NonNull String message) {
if (verifyNonNullParameters("trackWebViewPerformance", tag, message)) {
impl.trackWebViewPerformance(tag, message);
}
}
@Nullable
@Override
public String getCurrentSessionId() {
return impl.getCurrentSessionId();
}
@NonNull
@Override
public LastRunEndState getLastRunEndState() {
return impl.getLastRunEndState();
}
/**
* Get internal interface for the intra-Embrace, not-publicly-supported API
*
* @hide
*/
@NonNull
@InternalApi
public EmbraceInternalInterface getInternalInterface() {
return impl.getEmbraceInternalInterface();
}
/**
* Gets the {@link ReactNativeInternalInterface} that should be used as the sole source of
* communication with the Android SDK for React Native. Not part of the supported public API.
*
* @hide
*/
@Nullable
@InternalApi
public ReactNativeInternalInterface getReactNativeInternalInterface() {
return impl.getReactNativeInternalInterface();
}
/**
* @hide Gets the {@link UnityInternalInterface} that should be used as the sole source of
* communication with the Android SDK for Unity. Not part of the supported public API.
* @hide
*/
@Nullable
@InternalApi
public UnityInternalInterface getUnityInternalInterface() {
return impl.getUnityInternalInterface();
}
/**
* Gets the {@link FlutterInternalInterface} that should be used as the sole source of
* communication with the Android SDK for Flutter. Not part of the supported public API.
*
* @hide
*/
@Nullable
@InternalApi
public FlutterInternalInterface getFlutterInternalInterface() {
return impl.getFlutterInternalInterface();
}
private boolean verifyNonNullParameters(@NonNull String functionName, @NonNull Object... params) {
for (Object param : params) {
if (param == null) {
final String errorMessage = functionName + NULL_PARAMETER_ERROR_MESSAGE_TEMPLATE;
if (isStarted()) {
internalEmbraceLogger.logError(errorMessage, new IllegalArgumentException(errorMessage), true);
} else {
internalEmbraceLogger.logSDKNotInitialized(errorMessage);
}
return false;
}
}
return true;
}
/**
* The AppFramework that is in use.
*/
public enum AppFramework {
NATIVE(1),
REACT_NATIVE(2),
UNITY(3),
FLUTTER(4);
private final int value;
AppFramework(int value) {
this.value = value;
}
public int getValue() {
return value;
}
}
/**
* Enum representing the end state of the last run of the application.
*/
public enum LastRunEndState {
/**
* The SDK has not been started yet.
*/
INVALID(0),
/**
* The last run resulted in a crash.
*/
CRASH(1),
/**
* The last run did not result in a crash.
*/
CLEAN_EXIT(2);
private final int value;
LastRunEndState(int value) {
this.value = value;
}
public int getValue() {
return value;
}
}
}