reversi-utils/pt.isel.reversi.utils/DevTracker

DevTracker

class DevTracker(var config: TrackerConfig = TrackerConfig())

Development tracker for monitoring application behavior.

Provides comprehensive tracking of page entries, view model creations, recompositions, function calls, and custom events with thread-safe operations.

References:

Constructors

DevTracker

constructor(config: TrackerConfig = TrackerConfig())

Properties

autoSaveEnabled

@Volatile

private var autoSaveEnabled: Boolean

categorizedStats

private val categorizedStats: ConcurrentHashMap<Any, MutableList<TrackingStats>>

config

private var config: TrackerConfig

Configuration for the tracker.

dateFormatter

private val dateFormatter: DateTimeFormatter?

events

private val events: ConcurrentHashMap<String, MutableList<TrackingEvent>>

fullDateFormatter

private val fullDateFormatter: DateTimeFormatter?

stats

private val stats: ConcurrentHashMap<String, TrackingStats>

totalEventsTracked

private val totalEventsTracked: AtomicLong

trackingFilePath

@Volatile

private var trackingFilePath: String?

Functions

appendEventToFile

fun appendEventToFile(event: TrackingEvent): Boolean

Appends a single event to the tracking file (useful for large datasets).

asyncSave

private fun asyncSave()

Saves tracking data asynchronously in a separate thread.

clear

fun clear()

Clears all tracked data and resets counters.

detectCallingFunction

private fun detectCallingFunction(): String

Automatically detects the calling function name from the call stack.

exportAsCSV

private fun exportAsCSV(): String

exportAsJSON

private fun exportAsJSON(): String

exportAsText

private fun exportAsText(): String

exportStatistics

fun exportStatistics(format: ExportFormat = ExportFormat.TEXT): String

Exports statistics in various formats.

getAllEvents

fun getAllEvents(): Map<String, List<TrackingEvent>>

Gets all recorded events as an immutable map.

getAllStats

fun getAllStats(): Map<String, TrackingStats>

Gets all recorded statistics as an immutable map.

getCategorizedStats

fun getCategorizedStats(): Map<Any, List<TrackingStats>>

Gets statistics grouped by category.

getEvents

fun getEvents(context: String): List<TrackingEvent>

Gets all recorded events for a specific context.

getStats

fun getStats(context: String): TrackingStats?

Gets statistics for a specific context.

getTotalEventsTracked

fun getTotalEventsTracked(): Long

Gets the total number of events tracked across all contexts.

getTrackerFilePath

fun getTrackerFilePath(): String?

isAutoSaveEnabled

fun isAutoSaveEnabled(): Boolean

isEnabled

fun isEnabled(): Boolean

Gets the current enabled state.

logTrackingEvent

private fun logTrackingEvent(event: TrackingEvent)

Logs a tracking event in a structured format.

printSummary

fun printSummary()

Prints a comprehensive summary of all tracked data.

recordEvent

private fun recordEvent(event: TrackingEvent)

Records a tracking event with improved performance and memory management.

saveToFile

fun saveToFile(format: ExportFormat = ExportFormat.TEXT): Boolean

Saves tracking data to file synchronously. Keeps signature intact. Ensures single, correct extension.

setAutoSaveEnabled

fun setAutoSaveEnabled(enabled: Boolean)

setEnabled

fun setEnabled(value: Boolean)

Enables or disables tracking globally.

setTrackerFilePath

fun setTrackerFilePath(autoSave: Boolean = false): String

Sets up file tracking with optional auto-save. Keeps signature intact. Generates a default .log file initially.

trackClassCreated

fun <T : Any> trackClassCreated(classInstance: T? = null, className: String? = null, category: Any? = null)

Tracks a class creation.

trackCustom

fun trackCustom(context: String, details: String = "", category: Any? = null)

Tracks a custom event.

trackEffectStart

fun <T : Any> trackEffectStart(effectInstance: T? = null, effectName: String? = null, category: Any? = null)

trackEffectStop

fun <T : Any> trackEffectStop(effectInstance: T? = null, effectName: String? = null, category: Any? = null)

trackFunctionCall

fun trackFunctionCall(customName: String? = null, details: String = "", category: Any? = null)

Tracks a function call with optional details.

trackPageEnter

fun trackPageEnter(customName: String? = null, category: Any? = null)

Tracks a page entry with automatic caller detection.

trackRecomposition

fun trackRecomposition(customName: String? = null, category: Any? = null)

Tracks a recomposition with automatic caller detection.

trackViewModelCreated

fun <T : Any> trackViewModelCreated(viewModel: T? = null, className: String? = null, category: Any? = null)

Tracks a view model creation.

updateConfig

fun updateConfig(newConfig: TrackerConfig)

Updates the tracker configuration.

withExt

private fun withExt(path: String, ext: String): String

Returns a path with the given extension, replacing any existing one.