Skip to content

Commit

Permalink
Rename instrumentation API (#1826)
Browse files Browse the repository at this point in the history 
## Goal

Give better names to the public instrumentation customization APIs
  • Loading branch information
@bidetofevil
bidetofevil authored Jan 17, 2025
2 parents 4eeb616 + 15460dc commit 11681a0
Show file tree
Hide file tree
Showing 7 changed files with 37 additions and 37 deletions.
18 changes: 9 additions & 9 deletions embrace-android-api/api/embrace-android-api.api
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,18 +53,18 @@ public abstract interface class io/embrace/android/embracesdk/internal/api/Embra

public abstract interface class io/embrace/android/embracesdk/internal/api/InstrumentationApi {
public abstract fun activityLoaded (Landroid/app/Activity;)V
public abstract fun addAttributeToLoadTrace (Landroid/app/Activity;Ljava/lang/String;Ljava/lang/String;)V
public abstract fun addChildSpanToLoadTrace (Landroid/app/Activity;Ljava/lang/String;JJ)V
public abstract fun addChildSpanToLoadTrace (Landroid/app/Activity;Ljava/lang/String;JJLjava/util/Map;Ljava/util/List;Lio/embrace/android/embracesdk/spans/ErrorCode;)V
public abstract fun addStartupChildSpan (Ljava/lang/String;JJ)V
public abstract fun addStartupChildSpan (Ljava/lang/String;JJLjava/util/Map;Ljava/util/List;Lio/embrace/android/embracesdk/spans/ErrorCode;)V
public abstract fun addLoadTraceAttribute (Landroid/app/Activity;Ljava/lang/String;Ljava/lang/String;)V
public abstract fun addLoadTraceChildSpan (Landroid/app/Activity;Ljava/lang/String;JJ)V
public abstract fun addLoadTraceChildSpan (Landroid/app/Activity;Ljava/lang/String;JJLjava/util/Map;Ljava/util/List;Lio/embrace/android/embracesdk/spans/ErrorCode;)V
public abstract fun addStartupTraceAttribute (Ljava/lang/String;Ljava/lang/String;)V
public abstract fun addStartupTraceChildSpan (Ljava/lang/String;JJ)V
public abstract fun addStartupTraceChildSpan (Ljava/lang/String;JJLjava/util/Map;Ljava/util/List;Lio/embrace/android/embracesdk/spans/ErrorCode;)V
public abstract fun getSdkCurrentTimeMs ()J
}

public final class io/embrace/android/embracesdk/internal/api/InstrumentationApi$DefaultImpls {
public static fun addChildSpanToLoadTrace (Lio/embrace/android/embracesdk/internal/api/InstrumentationApi;Landroid/app/Activity;Ljava/lang/String;JJ)V
public static fun addStartupChildSpan (Lio/embrace/android/embracesdk/internal/api/InstrumentationApi;Ljava/lang/String;JJ)V
public static fun addLoadTraceChildSpan (Lio/embrace/android/embracesdk/internal/api/InstrumentationApi;Landroid/app/Activity;Ljava/lang/String;JJ)V
public static fun addStartupTraceChildSpan (Lio/embrace/android/embracesdk/internal/api/InstrumentationApi;Ljava/lang/String;JJ)V
}

public abstract interface class io/embrace/android/embracesdk/internal/api/InternalWebViewApi {
Expand Down Expand Up @@ -105,8 +105,8 @@ public abstract interface class io/embrace/android/embracesdk/internal/api/SdkAp
}

public final class io/embrace/android/embracesdk/internal/api/SdkApi$DefaultImpls {
public static fun addChildSpanToLoadTrace (Lio/embrace/android/embracesdk/internal/api/SdkApi;Landroid/app/Activity;Ljava/lang/String;JJ)V
public static fun addStartupChildSpan (Lio/embrace/android/embracesdk/internal/api/SdkApi;Ljava/lang/String;JJ)V
public static fun addLoadTraceChildSpan (Lio/embrace/android/embracesdk/internal/api/SdkApi;Landroid/app/Activity;Ljava/lang/String;JJ)V
public static fun addStartupTraceChildSpan (Lio/embrace/android/embracesdk/internal/api/SdkApi;Ljava/lang/String;JJ)V
public static fun createSpan (Lio/embrace/android/embracesdk/internal/api/SdkApi;Ljava/lang/String;Lio/embrace/android/embracesdk/spans/AutoTerminationMode;)Lio/embrace/android/embracesdk/spans/EmbraceSpan;
public static fun recordCompletedSpan (Lio/embrace/android/embracesdk/internal/api/SdkApi;Ljava/lang/String;JJ)Z
public static fun recordCompletedSpan (Lio/embrace/android/embracesdk/internal/api/SdkApi;Ljava/lang/String;JJLio/embrace/android/embracesdk/spans/EmbraceSpan;)Z
Expand Down
14 changes: 7 additions & 7 deletions ...roid-api/src/main/kotlin/io/embrace/android/embracesdk/internal/api/InstrumentationApi.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,17 +26,17 @@ public interface InstrumentationApi {
/**
* Add an attribute to the trace generated by the loading of the given [Activity]
*/
public fun addAttributeToLoadTrace(activity: Activity, key: String, value: String)
public fun addLoadTraceAttribute(activity: Activity, key: String, value: String)

/**
* Add a successfully completed child span to the trace generated by the loading of the given [Activity]
*/
public fun addChildSpanToLoadTrace(
public fun addLoadTraceChildSpan(
activity: Activity,
name: String,
startTimeMs: Long,
endTimeMs: Long,
): Unit = addChildSpanToLoadTrace(
): Unit = addLoadTraceChildSpan(
activity = activity,
name = name,
startTimeMs = startTimeMs,
Expand All @@ -50,7 +50,7 @@ public interface InstrumentationApi {
* Add a completed child span to the trace generated by the loading of the given [Activity] with the given
* attributes and span events. Specify an [ErrorCode] if the span didn't complete successfully.
*/
public fun addChildSpanToLoadTrace(
public fun addLoadTraceChildSpan(
activity: Activity,
name: String,
startTimeMs: Long,
Expand All @@ -68,11 +68,11 @@ public interface InstrumentationApi {
/**
* Add a successfully completed child span to the app startup trace
*/
public fun addStartupChildSpan(
public fun addStartupTraceChildSpan(
name: String,
startTimeMs: Long,
endTimeMs: Long,
): Unit = addStartupChildSpan(
): Unit = addStartupTraceChildSpan(
name = name,
startTimeMs = startTimeMs,
endTimeMs = endTimeMs,
Expand All @@ -85,7 +85,7 @@ public interface InstrumentationApi {
* Add a completed child span to the app startup trace with the given attributes and span events.
* Specify an [ErrorCode] if the span didn't complete successfully.
*/
public fun addStartupChildSpan(
public fun addStartupTraceChildSpan(
name: String,
startTimeMs: Long,
endTimeMs: Long,
Expand Down
10 changes: 5 additions & 5 deletions embrace-android-sdk/api/embrace-android-sdk.api
View file
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
public final class io/embrace/android/embracesdk/Embrace : io/embrace/android/embracesdk/internal/api/SdkApi {
public static final field Companion Lio/embrace/android/embracesdk/Embrace$Companion;
public fun activityLoaded (Landroid/app/Activity;)V
public fun addAttributeToLoadTrace (Landroid/app/Activity;Ljava/lang/String;Ljava/lang/String;)V
public fun addBreadcrumb (Ljava/lang/String;)V
public fun addChildSpanToLoadTrace (Landroid/app/Activity;Ljava/lang/String;JJ)V
public fun addChildSpanToLoadTrace (Landroid/app/Activity;Ljava/lang/String;JJLjava/util/Map;Ljava/util/List;Lio/embrace/android/embracesdk/spans/ErrorCode;)V
public fun addLoadTraceAttribute (Landroid/app/Activity;Ljava/lang/String;Ljava/lang/String;)V
public fun addLoadTraceChildSpan (Landroid/app/Activity;Ljava/lang/String;JJ)V
public fun addLoadTraceChildSpan (Landroid/app/Activity;Ljava/lang/String;JJLjava/util/Map;Ljava/util/List;Lio/embrace/android/embracesdk/spans/ErrorCode;)V
public fun addLogRecordExporter (Lio/opentelemetry/sdk/logs/export/LogRecordExporter;)V
public fun addSessionProperty (Ljava/lang/String;Ljava/lang/String;Z)Z
public fun addSpanExporter (Lio/opentelemetry/sdk/trace/export/SpanExporter;)V
public fun addStartupChildSpan (Ljava/lang/String;JJ)V
public fun addStartupChildSpan (Ljava/lang/String;JJLjava/util/Map;Ljava/util/List;Lio/embrace/android/embracesdk/spans/ErrorCode;)V
public fun addStartupTraceAttribute (Ljava/lang/String;Ljava/lang/String;)V
public fun addStartupTraceChildSpan (Ljava/lang/String;JJ)V
public fun addStartupTraceChildSpan (Ljava/lang/String;JJLjava/util/Map;Ljava/util/List;Lio/embrace/android/embracesdk/spans/ErrorCode;)V
public fun addUserPersona (Ljava/lang/String;)V
public fun clearAllUserPersonas ()V
public fun clearUserEmail ()V
Expand Down
2 changes: 1 addition & 1 deletion ...src/integrationTest/kotlin/io/embrace/android/embracesdk/testcases/AppStartupTraceTest.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ internal class AppStartupTraceTest {
testCaseAction = {
val customStartTimeMs = clock.now()
val customEndTimeMs = clock.tick(100L)
embrace.addStartupChildSpan("custom-span", customStartTimeMs, customEndTimeMs)
embrace.addStartupTraceChildSpan("custom-span", customStartTimeMs, customEndTimeMs)
embrace.addStartupTraceAttribute("custom-attribute", "yes")
simulateOpeningActivities(
addStartupActivity = false,
Expand Down
4 changes: 2 additions & 2 deletions ...Test/kotlin/io/embrace/android/embracesdk/testframework/actions/EmbraceActionInterface.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -102,11 +102,11 @@ internal class EmbraceActionInterface(
setup.overriddenClock.tick(LIFECYCLE_EVENT_GAP)

if (invokeManualEnd) {
embrace.addAttributeToLoadTrace(activityController.get(), "manual-end", "true")
embrace.addLoadTraceAttribute(activityController.get(), "manual-end", "true")
val startTime = clock.now()
setup.overriddenClock.tick(LIFECYCLE_EVENT_GAP)
val endTime = clock.now()
embrace.addChildSpanToLoadTrace(
embrace.addLoadTraceChildSpan(
activity = activityController.get(),
name = "loading-time",
startTimeMs = startTime,
Expand Down
12 changes: 6 additions & 6 deletions embrace-android-sdk/src/main/java/io/embrace/android/embracesdk/Embrace.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -430,11 +430,11 @@ public class Embrace private constructor(

override fun getSdkCurrentTimeMs(): Long = impl.getSdkCurrentTimeMs()

override fun addAttributeToLoadTrace(activity: Activity, key: String, value: String) {
impl.addAttributeToLoadTrace(activity, key, value)
override fun addLoadTraceAttribute(activity: Activity, key: String, value: String) {
impl.addLoadTraceAttribute(activity, key, value)
}

override fun addChildSpanToLoadTrace(
override fun addLoadTraceChildSpan(
activity: Activity,
name: String,
startTimeMs: Long,
Expand All @@ -443,7 +443,7 @@ public class Embrace private constructor(
events: List<EmbraceSpanEvent>,
errorCode: ErrorCode?,
) {
impl.addChildSpanToLoadTrace(
impl.addLoadTraceChildSpan(
activity = activity,
name = name,
startTimeMs = startTimeMs,
Expand All @@ -458,15 +458,15 @@ public class Embrace private constructor(
impl.addStartupTraceAttribute(key, value)
}

override fun addStartupChildSpan(
override fun addStartupTraceChildSpan(
name: String,
startTimeMs: Long,
endTimeMs: Long,
attributes: Map<String, String>,
events: List<EmbraceSpanEvent>,
errorCode: ErrorCode?,
) {
impl.addStartupChildSpan(
impl.addStartupTraceChildSpan(
name = name,
startTimeMs = startTimeMs,
endTimeMs = endTimeMs,
Expand Down
14 changes: 7 additions & 7 deletions ...in/java/io/embrace/android/embracesdk/internal/api/delegate/InstrumentationApiDelegate.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,13 @@ internal class InstrumentationApiDelegate(

override fun getSdkCurrentTimeMs(): Long = clock.now()

override fun addAttributeToLoadTrace(activity: Activity, key: String, value: String) {
if (sdkCallChecker.check("add_attribute_to_load_trace")) {
override fun addLoadTraceAttribute(activity: Activity, key: String, value: String) {
if (sdkCallChecker.check("add_load_trace_attribute")) {
uiLoadTraceEmitter?.addAttribute(traceInstanceId(activity), key, value)
}
}

override fun addChildSpanToLoadTrace(
override fun addLoadTraceChildSpan(
activity: Activity,
name: String,
startTimeMs: Long,
Expand All @@ -45,7 +45,7 @@ internal class InstrumentationApiDelegate(
events: List<EmbraceSpanEvent>,
errorCode: ErrorCode?,
) {
if (sdkCallChecker.check("add_child_span_to_load_trace")) {
if (sdkCallChecker.check("add_load_trace_child_span")) {
uiLoadTraceEmitter?.addChildSpan(
instanceId = traceInstanceId(activity),
name = name,
Expand All @@ -59,20 +59,20 @@ internal class InstrumentationApiDelegate(
}

override fun addStartupTraceAttribute(key: String, value: String) {
if (sdkCallChecker.check("add_attribute_to_app_startup_trace")) {
if (sdkCallChecker.check("add_startup_trace_attribute")) {
appStartupDataCollector?.addAttribute(key, value)
}
}

override fun addStartupChildSpan(
override fun addStartupTraceChildSpan(
name: String,
startTimeMs: Long,
endTimeMs: Long,
attributes: Map<String, String>,
events: List<EmbraceSpanEvent>,
errorCode: ErrorCode?,
) {
if (sdkCallChecker.check("add_child_span_to_app_startup_trace")) {
if (sdkCallChecker.check("add_startup_trace_child_span")) {
appStartupDataCollector?.addTrackedInterval(
name = name,
startTimeMs = startTimeMs,
Expand Down

0 comments on commit 11681a0

Please sign in to comment.