Skip to content

Sdk profiler #423

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Sdk profiler #423

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6daf515
add sdk profiler
ShiCheng-Lu Nov 19, 2024
ae2eb42
rename to telemetry, add telemetry to trackOnce
ShiCheng-Lu Nov 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 29 additions & 3 deletions sdk/src/main/java/io/radar/sdk/Radar.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,28 @@ import android.location.Location
import android.os.Build
import android.os.Handler
import androidx.annotation.RequiresApi
import io.radar.sdk.model.*
import io.radar.sdk.model.RadarAddress
import io.radar.sdk.model.RadarBeacon
import io.radar.sdk.model.RadarConfig
import io.radar.sdk.model.RadarContext
import io.radar.sdk.model.RadarEvent
import io.radar.sdk.model.RadarEvent.RadarEventVerification
import io.radar.sdk.model.RadarGeofence
import io.radar.sdk.model.RadarPlace
import io.radar.sdk.model.RadarReplay
import io.radar.sdk.model.RadarRouteMatrix
import io.radar.sdk.model.RadarRoutes
import io.radar.sdk.model.RadarSdkConfiguration
import io.radar.sdk.model.RadarTrip
import io.radar.sdk.model.RadarUser
import io.radar.sdk.model.RadarVerifiedLocationToken
import io.radar.sdk.util.RadarLogBuffer
import io.radar.sdk.util.RadarReplayBuffer
import io.radar.sdk.util.RadarSimpleLogBuffer
import io.radar.sdk.util.RadarSimpleReplayBuffer
import org.json.JSONObject
import java.util.*
import java.util.Date
import java.util.EnumSet

/**
* The main class used to interact with the Radar SDK.
Expand Down Expand Up @@ -366,7 +380,8 @@ object Radar {
SDK_ERROR(2),
SDK_EXCEPTION(3),
APP_LIFECYCLE_EVENT(4),
PERMISSION_EVENT(5);
PERMISSION_EVENT(5),
TELEMETRY(6);

companion object {
@JvmStatic
Expand Down Expand Up @@ -884,8 +899,14 @@ object Radar {
}
this.logger.i("trackOnce()", RadarLogType.SDK_CALL)

val telemetry = RadarTelemetry()
telemetry.start("total")
telemetry.start("getLocation")

locationManager.getLocation(desiredAccuracy, RadarLocationSource.FOREGROUND_LOCATION, object : RadarLocationCallback {
override fun onComplete(status: RadarStatus, location: Location?, stopped: Boolean) {
telemetry.end("getLocation")

if (status != RadarStatus.SUCCESS || location == null) {
handler.post {
callback?.onComplete(status)
Expand All @@ -895,6 +916,7 @@ object Radar {
}

val callTrackApi = { beacons: Array<RadarBeacon>? ->
telemetry.start("trackAPI")
apiClient.track(location, stopped, true, RadarLocationSource.FOREGROUND_LOCATION, false, beacons, callback = object : RadarApiClient.RadarTrackApiCallback {
override fun onComplete(
status: RadarStatus,
Expand All @@ -905,10 +927,14 @@ object Radar {
config: RadarConfig?,
token: RadarVerifiedLocationToken?
) {
telemetry.end("trackAPI")

if (status == RadarStatus.SUCCESS ){
locationManager.updateTrackingFromMeta(config?.meta)
}
handler.post {
telemetry.end("total")
logger.i("trackOnce | ${telemetry.formatted()}", Radar.RadarLogType.TELEMETRY)
callback?.onComplete(status, location, events, user)
}
}
Expand Down
28 changes: 28 additions & 0 deletions sdk/src/main/java/io/radar/sdk/RadarTelemetry.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
package io.radar.sdk

import java.util.Date

Copy link

Copilot AI Aug 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Public class lacks documentation. Consider adding KDoc to explain the purpose and usage of this telemetry class.

Suggested change
/**
* RadarTelemetry provides simple timing utilities for measuring the duration of code execution.
*
* Usage:
* - Call [start] with an optional tag to begin timing.
* - Call [end] with the same tag to end timing.
* - Use [get] to retrieve the elapsed time in milliseconds for a tag.
* - Use [formatted] to get a human-readable summary of all timings.
*
* This class is useful for performance monitoring and debugging.
*/

Copilot uses AI. Check for mistakes.
class RadarTelemetry {
private val startTimes: MutableMap<String, Long> = mutableMapOf()
private val endTimes: MutableMap<String, Long> = mutableMapOf()
fun start(tag: String = "") {
startTimes[tag] = Date().time
}

fun end(tag: String = "") {
if (startTimes.containsKey(tag)) {
endTimes[tag] = Date().time
Copy link

Copilot AI Aug 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Using Date().time creates unnecessary Date objects. Consider using System.currentTimeMillis() which is more efficient for timing measurements.

Suggested change
endTimes[tag] = Date().time
class RadarTelemetry {
private val startTimes: MutableMap<String, Long> = mutableMapOf()
private val endTimes: MutableMap<String, Long> = mutableMapOf()
fun start(tag: String = "") {
startTimes[tag] = System.currentTimeMillis()
}
fun end(tag: String = "") {
if (startTimes.containsKey(tag)) {
endTimes[tag] = System.currentTimeMillis()

Copilot uses AI. Check for mistakes.
Copy link

Copilot AI Aug 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Using Date().time creates unnecessary Date objects. Consider using System.currentTimeMillis() which is more efficient for timing measurements.

Suggested change
endTimes[tag] = Date().time
startTimes[tag] = System.currentTimeMillis()
}
fun end(tag: String = "") {
if (startTimes.containsKey(tag)) {
endTimes[tag] = System.currentTimeMillis()

Copilot uses AI. Check for mistakes.
}
}

fun get(tag: String = ""): Long {
return endTimes.getOrDefault(tag, 0) - startTimes.getOrDefault(tag, 0)
}

fun formatted(): String {
return endTimes.map { (tag, endTime) ->
val diff = endTime - startTimes[tag]!!
"${tag}: ${"%.2f".format(diff.toFloat() / 1000)}s"
Copy link

Copilot AI Aug 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Force unwrapping with !! could cause a crash if endTimes contains a tag that's not in startTimes. This could happen if end() is called without a corresponding start() call. Consider using safe access or validation.

Suggested change
"${tag}: ${"%.2f".format(diff.toFloat() / 1000)}s"
return endTimes.mapNotNull { (tag, endTime) ->
val startTime = startTimes[tag]
if (startTime != null) {
val diff = endTime - startTime
"${tag}: ${"%.2f".format(diff.toFloat() / 1000)}s"
} else {
null
}

Copilot uses AI. Check for mistakes.
}.joinToString(", ")
}
}
32 changes: 29 additions & 3 deletions sdk/src/main/java/io/radar/sdk/RadarVerificationManager.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ import android.os.Build
import android.os.Handler
import android.os.SystemClock
import androidx.annotation.RequiresApi
import com.google.android.gms.tasks.Task
import com.google.android.play.core.integrity.IntegrityManagerFactory
import com.google.android.play.core.integrity.StandardIntegrityManager
import com.google.android.play.core.integrity.StandardIntegrityManager.StandardIntegrityToken
import com.google.android.play.core.integrity.StandardIntegrityManager.StandardIntegrityTokenRequest
import com.google.android.gms.tasks.Task
import com.google.android.play.core.integrity.IntegrityManagerFactory
import io.radar.sdk.RadarUtils.hashSHA256
import io.radar.sdk.model.RadarBeacon
import io.radar.sdk.model.RadarConfig
Expand Down Expand Up @@ -73,9 +73,14 @@ internal class RadarVerificationManager(
val verificationManager = this
val lastTokenBeacons = beacons

val telemetry = RadarTelemetry()
telemetry.start("total")
telemetry.start("getConfig")

val usage = "trackVerified"
Radar.apiClient.getConfig(usage, true, object : RadarApiClient.RadarGetConfigApiCallback {
override fun onComplete(status: Radar.RadarStatus, config: RadarConfig?) {
telemetry.end("getConfig")
if (status != Radar.RadarStatus.SUCCESS || config == null) {
Radar.handler.post {
if (status != Radar.RadarStatus.SUCCESS) {
Expand All @@ -90,6 +95,8 @@ internal class RadarVerificationManager(

val googlePlayProjectNumber = config.googlePlayProjectNumber

telemetry.start("getLocation")

Radar.locationManager.getLocation(
desiredAccuracy,
Radar.RadarLocationSource.FOREGROUND_LOCATION,
Expand All @@ -100,6 +107,8 @@ internal class RadarVerificationManager(
location: Location?,
stopped: Boolean
) {
telemetry.end("getLocation")

if (status != Radar.RadarStatus.SUCCESS || location == null) {
Radar.handler.post {
if (status != Radar.RadarStatus.SUCCESS) {
Expand All @@ -112,13 +121,19 @@ internal class RadarVerificationManager(
return
}

telemetry.start("getIntegrityToken")

val requestHash = verificationManager.getRequestHash(location)

verificationManager.getIntegrityToken(
googlePlayProjectNumber,
requestHash
) { integrityToken, integrityException ->

telemetry.end("getIntegrityToken")

val callTrackApi = { beacons: Array<RadarBeacon>? ->
telemetry.start("trackAPI")
Radar.apiClient.track(
location,
RadarState.getStopped(verificationManager.context),
Expand All @@ -144,6 +159,7 @@ internal class RadarVerificationManager(
config: RadarConfig?,
token: RadarVerifiedLocationToken?
) {
telemetry.end("trackAPI")
if (status == Radar.RadarStatus.SUCCESS) {
Radar.locationManager.updateTrackingFromMeta(
config?.meta
Expand All @@ -154,6 +170,10 @@ internal class RadarVerificationManager(
verificationManager.lastTokenElapsedRealtime = SystemClock.elapsedRealtime()
verificationManager.lastTokenBeacons = lastTokenBeacons
}

telemetry.end("total")
logger.i("trackVerified | ${telemetry.formatted()}", Radar.RadarLogType.TELEMETRY)

Radar.handler.post {
if (status != Radar.RadarStatus.SUCCESS) {
Radar.sendError(status)
Expand All @@ -166,6 +186,8 @@ internal class RadarVerificationManager(
}

if (beacons && Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {

telemetry.start("searchBeacons")
Radar.apiClient.searchBeacons(
location,
1000,
Expand All @@ -178,6 +200,7 @@ internal class RadarVerificationManager(
uuids: Array<String>?,
uids: Array<String>?
) {
telemetry.end("searchBeacons")
if (!uuids.isNullOrEmpty() || !uids.isNullOrEmpty()) {
Radar.beaconManager.startMonitoringBeaconUUIDs(
uuids,
Expand All @@ -199,14 +222,15 @@ internal class RadarVerificationManager(
return
}

telemetry.start("trackAPI")
callTrackApi(beacons)
}
})
} else if (beacons != null) {
Radar.beaconManager.startMonitoringBeacons(
beacons
)

telemetry.start("rangeBeacons")
Radar.beaconManager.rangeBeacons(
beacons,
false,
Expand All @@ -215,6 +239,8 @@ internal class RadarVerificationManager(
status: Radar.RadarStatus,
beacons: Array<RadarBeacon>?
) {
telemetry.end("rangeBeacons")

if (status != Radar.RadarStatus.SUCCESS || beacons == null) {
callTrackApi(null)

Expand Down