-
- All Implemented Interfaces:
-
io.embrace.android.embracesdk.internal.api.BreadcrumbApi,io.embrace.android.embracesdk.internal.api.EmbraceAndroidApi,io.embrace.android.embracesdk.internal.api.InstrumentationApi,io.embrace.android.embracesdk.internal.api.InternalWebViewApi,io.embrace.android.embracesdk.internal.api.LogsApi,io.embrace.android.embracesdk.internal.api.NetworkRequestApi,io.embrace.android.embracesdk.internal.api.OTelApi,io.embrace.android.embracesdk.internal.api.SdkApi,io.embrace.android.embracesdk.internal.api.SdkStateApi,io.embrace.android.embracesdk.internal.api.SessionApi,io.embrace.android.embracesdk.internal.api.UserApi,io.embrace.android.embracesdk.spans.TracingApi
public final class Embrace implements SdkApiEntry point for the SDK. This class is part of the Embrace Public API.
Contains a singleton instance of itself, and is used for initializing the SDK.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public classEmbrace.Companion
-
Field Summary
Fields Modifier and Type Field Description private final BooleanisStartedprivate final StringdeviceIdprivate final StringcurrentSessionIdprivate final LastRunEndStatelastRunEndState
-
Method Summary
Modifier and Type Method Description BooleangetIsStarted()StringgetDeviceId()StringgetCurrentSessionId()LastRunEndStategetLastRunEndState()Unitstart(Context context)Unitstart(Context context, AppFramework appFramework)UnitsetUserIdentifier(String userId)UnitclearUserIdentifier()UnitsetUserEmail(String email)UnitclearUserEmail()UnitaddUserPersona(String persona)UnitclearUserPersona(String persona)UnitclearAllUserPersonas()BooleanaddSessionProperty(String key, String value, Boolean permanent)BooleanremoveSessionProperty(String key)UnitsetUsername(String username)UnitclearUsername()StringgenerateW3cTraceparent()UnitrecordNetworkRequest(EmbraceNetworkRequest networkRequest)UnitlogInfo(String message)UnitlogWarning(String message)UnitlogError(String message)UnitaddBreadcrumb(String message)UnitlogMessage(String message, Severity severity)UnitlogMessage(String message, Severity severity, Map<String, Object> properties)UnitlogMessage(String message, Severity severity, Map<String, Object> properties, ByteArray attachment)UnitlogMessage(String message, Severity severity, Map<String, Object> properties, String attachmentId, String attachmentUrl)UnitlogException(Throwable throwable)UnitlogException(Throwable throwable, Severity severity)UnitlogException(Throwable throwable, Severity severity, Map<String, Object> properties)UnitlogException(Throwable throwable, Severity severity, Map<String, Object> properties, String message)UnitlogCustomStacktrace(Array<StackTraceElement> stacktraceElements)UnitlogCustomStacktrace(Array<StackTraceElement> stacktraceElements, Severity severity)UnitlogCustomStacktrace(Array<StackTraceElement> stacktraceElements, Severity severity, Map<String, Object> properties)UnitlogCustomStacktrace(Array<StackTraceElement> stacktraceElements, Severity severity, Map<String, Object> properties, String message)UnitendSession()UnitendSession(Boolean clearUserInfo)BooleanstartView(String name)BooleanendView(String name)EmbraceSpancreateSpan(String name, AutoTerminationMode autoTerminationMode)EmbraceSpancreateSpan(String name, EmbraceSpan parent, AutoTerminationMode autoTerminationMode)EmbraceSpanstartSpan(String name, AutoTerminationMode autoTerminationMode)EmbraceSpanstartSpan(String name, EmbraceSpan parent, AutoTerminationMode autoTerminationMode)EmbraceSpanstartSpan(String name, EmbraceSpan parent, Long startTimeMs, AutoTerminationMode autoTerminationMode)<T extends Any> TrecordSpan(String name, AutoTerminationMode autoTerminationMode, Function0<T> code)<T extends Any> TrecordSpan(String name, EmbraceSpan parent, AutoTerminationMode autoTerminationMode, Function0<T> code)<T extends Any> TrecordSpan(String name, Map<String, String> attributes, List<EmbraceSpanEvent> events, AutoTerminationMode autoTerminationMode, Function0<T> code)<T extends Any> TrecordSpan(String name, EmbraceSpan parent, Map<String, String> attributes, List<EmbraceSpanEvent> events, AutoTerminationMode autoTerminationMode, Function0<T> code)BooleanrecordCompletedSpan(String name, Long startTimeMs, Long endTimeMs, ErrorCode errorCode, EmbraceSpan parent, Map<String, String> attributes, List<EmbraceSpanEvent> events)BooleanrecordCompletedSpan(String name, Long startTimeMs, Long endTimeMs)BooleanrecordCompletedSpan(String name, Long startTimeMs, Long endTimeMs, ErrorCode errorCode)BooleanrecordCompletedSpan(String name, Long startTimeMs, Long endTimeMs, EmbraceSpan parent)BooleanrecordCompletedSpan(String name, Long startTimeMs, Long endTimeMs, ErrorCode errorCode, EmbraceSpan parent)BooleanrecordCompletedSpan(String name, Long startTimeMs, Long endTimeMs, Map<String, String> attributes, List<EmbraceSpanEvent> events)EmbraceSpangetSpan(String spanId)UnitaddSpanExporter(SpanExporter spanExporter)Adds a SpanExporter to the tracer. OpenTelemetrygetOpenTelemetry()UnitsetResourceAttribute(String key, String value)UnitaddLogRecordExporter(LogRecordExporter logRecordExporter)Adds a LogRecordExporter to the open telemetry logger. UnitlogPushNotification(String title, String body, String topic, String id, Integer notificationPriority, Integer messageDeliveredPriority, Boolean isNotification, Boolean hasData)UnittrackWebViewPerformance(String tag, ConsoleMessage consoleMessage)UnittrackWebViewPerformance(String tag, String message)UnitapplicationInitEnd()UnitappReady()UnitlogWebView(String url)Unitdisable()UnitactivityLoaded(Activity activity)LonggetSdkCurrentTimeMs()UnitaddLoadTraceAttribute(Activity activity, String key, String value)UnitaddLoadTraceChildSpan(Activity activity, String name, Long startTimeMs, Long endTimeMs, Map<String, String> attributes, List<EmbraceSpanEvent> events, ErrorCode errorCode)UnitaddStartupTraceAttribute(String key, String value)UnitaddStartupTraceChildSpan(String name, Long startTimeMs, Long endTimeMs, Map<String, String> attributes, List<EmbraceSpanEvent> events, ErrorCode errorCode)-
-
Method Detail
-
getIsStarted
Boolean getIsStarted()
-
getDeviceId
String getDeviceId()
-
getCurrentSessionId
String getCurrentSessionId()
-
getLastRunEndState
LastRunEndState getLastRunEndState()
-
setUserIdentifier
Unit setUserIdentifier(String userId)
-
clearUserIdentifier
Unit clearUserIdentifier()
-
setUserEmail
Unit setUserEmail(String email)
-
clearUserEmail
Unit clearUserEmail()
-
addUserPersona
Unit addUserPersona(String persona)
-
clearUserPersona
Unit clearUserPersona(String persona)
-
clearAllUserPersonas
Unit clearAllUserPersonas()
-
addSessionProperty
Boolean addSessionProperty(String key, String value, Boolean permanent)
-
removeSessionProperty
Boolean removeSessionProperty(String key)
-
setUsername
Unit setUsername(String username)
-
clearUsername
Unit clearUsername()
-
generateW3cTraceparent
String generateW3cTraceparent()
-
recordNetworkRequest
Unit recordNetworkRequest(EmbraceNetworkRequest networkRequest)
-
logWarning
Unit logWarning(String message)
-
addBreadcrumb
Unit addBreadcrumb(String message)
-
logMessage
Unit logMessage(String message, Severity severity)
-
logMessage
Unit logMessage(String message, Severity severity, Map<String, Object> properties, ByteArray attachment)
-
logMessage
Unit logMessage(String message, Severity severity, Map<String, Object> properties, String attachmentId, String attachmentUrl)
-
logException
Unit logException(Throwable throwable)
-
logException
Unit logException(Throwable throwable, Severity severity)
-
logException
Unit logException(Throwable throwable, Severity severity, Map<String, Object> properties)
-
logException
Unit logException(Throwable throwable, Severity severity, Map<String, Object> properties, String message)
-
logCustomStacktrace
Unit logCustomStacktrace(Array<StackTraceElement> stacktraceElements)
-
logCustomStacktrace
Unit logCustomStacktrace(Array<StackTraceElement> stacktraceElements, Severity severity)
-
logCustomStacktrace
Unit logCustomStacktrace(Array<StackTraceElement> stacktraceElements, Severity severity, Map<String, Object> properties)
-
logCustomStacktrace
Unit logCustomStacktrace(Array<StackTraceElement> stacktraceElements, Severity severity, Map<String, Object> properties, String message)
-
endSession
Unit endSession()
-
endSession
Unit endSession(Boolean clearUserInfo)
-
createSpan
EmbraceSpan createSpan(String name, AutoTerminationMode autoTerminationMode)
-
createSpan
EmbraceSpan createSpan(String name, EmbraceSpan parent, AutoTerminationMode autoTerminationMode)
-
startSpan
EmbraceSpan startSpan(String name, EmbraceSpan parent, AutoTerminationMode autoTerminationMode)
-
startSpan
EmbraceSpan startSpan(String name, EmbraceSpan parent, Long startTimeMs, AutoTerminationMode autoTerminationMode)
-
recordSpan
<T extends Any> T recordSpan(String name, AutoTerminationMode autoTerminationMode, Function0<T> code)
-
recordSpan
<T extends Any> T recordSpan(String name, EmbraceSpan parent, AutoTerminationMode autoTerminationMode, Function0<T> code)
-
recordSpan
<T extends Any> T recordSpan(String name, Map<String, String> attributes, List<EmbraceSpanEvent> events, AutoTerminationMode autoTerminationMode, Function0<T> code)
-
recordSpan
<T extends Any> T recordSpan(String name, EmbraceSpan parent, Map<String, String> attributes, List<EmbraceSpanEvent> events, AutoTerminationMode autoTerminationMode, Function0<T> code)
-
recordCompletedSpan
Boolean recordCompletedSpan(String name, Long startTimeMs, Long endTimeMs, ErrorCode errorCode, EmbraceSpan parent, Map<String, String> attributes, List<EmbraceSpanEvent> events)
-
recordCompletedSpan
Boolean recordCompletedSpan(String name, Long startTimeMs, Long endTimeMs)
-
recordCompletedSpan
Boolean recordCompletedSpan(String name, Long startTimeMs, Long endTimeMs, ErrorCode errorCode)
-
recordCompletedSpan
Boolean recordCompletedSpan(String name, Long startTimeMs, Long endTimeMs, EmbraceSpan parent)
-
recordCompletedSpan
Boolean recordCompletedSpan(String name, Long startTimeMs, Long endTimeMs, ErrorCode errorCode, EmbraceSpan parent)
-
recordCompletedSpan
Boolean recordCompletedSpan(String name, Long startTimeMs, Long endTimeMs, Map<String, String> attributes, List<EmbraceSpanEvent> events)
-
addSpanExporter
Unit addSpanExporter(SpanExporter spanExporter)
Adds a SpanExporter to the tracer.
- Parameters:
spanExporter- the span exporter to add
-
getOpenTelemetry
OpenTelemetry getOpenTelemetry()
-
setResourceAttribute
Unit setResourceAttribute(String key, String value)
-
addLogRecordExporter
Unit addLogRecordExporter(LogRecordExporter logRecordExporter)
Adds a LogRecordExporter to the open telemetry logger.
- Parameters:
logRecordExporter- the LogRecord exporter to add
-
logPushNotification
Unit logPushNotification(String title, String body, String topic, String id, Integer notificationPriority, Integer messageDeliveredPriority, Boolean isNotification, Boolean hasData)
-
trackWebViewPerformance
Unit trackWebViewPerformance(String tag, ConsoleMessage consoleMessage)
-
trackWebViewPerformance
Unit trackWebViewPerformance(String tag, String message)
-
applicationInitEnd
Unit applicationInitEnd()
-
logWebView
Unit logWebView(String url)
-
activityLoaded
Unit activityLoaded(Activity activity)
-
getSdkCurrentTimeMs
Long getSdkCurrentTimeMs()
-
addLoadTraceAttribute
Unit addLoadTraceAttribute(Activity activity, String key, String value)
-
addLoadTraceChildSpan
Unit addLoadTraceChildSpan(Activity activity, String name, Long startTimeMs, Long endTimeMs, Map<String, String> attributes, List<EmbraceSpanEvent> events, ErrorCode errorCode)
-
addStartupTraceAttribute
Unit addStartupTraceAttribute(String key, String value)
-
-
-
-