Ametista-Engine/com.tecknobit.ametistaengine/AmetistaEngine

Ametista Engine

class AmetistaEngine(val platform: EngineConfiguration.Platform)

The AmetistaEngine class is the core component of the Ametista system. It collects performance data and tracks issues to send to your backend instance for analysis

Author

N7ghtm4r3 - Tecknobit

Constructors

AmetistaEngine

private constructor(platform: EngineConfiguration.Platform)

Types

Companion

object Companion

Properties

applicationId

private lateinit var applicationId: String

applicationId -> the identifier of the current application managed by the Engine

appVersion

private var appVersion: String?

appVersion -> the current application version managed by the Engine

configurationLoaded

private var configurationLoaded: Boolean

configurationLoaded -> whether the configuration has been loaded correctly

configurationMutex

private val configurationMutex: Mutex

configurationMutex -> the mutex used to wait the configuration loaded before execute any operation

debugMode

private var debugMode: Boolean

debugMode -> whether the Engine must send the requests but the server must not collect as real, this is the use-case of a not-production environment

deviceInfo

private val deviceInfo: DeviceInfo

deviceInfo -> the current device information

host

private lateinit var host: String

host -> the host address where send the stats and performance data collected

ktorClient

private val ktorClient: HttpClient

ktorClient -> the HTTP client used to send the stats and the performance data

loggingEnabled

private var loggingEnabled: Boolean

loggingEnabled -> whether the logging is enabled

platform

private val platform: EngineConfiguration.Platform

requestsMutex

private val requestsMutex: Mutex

requestsMutex -> the mutex used to synchronize the requests to avoid the interleaving between each request

serverSecret

private lateinit var serverSecret: String

serverSecret -> the server secret value used as authentication method to validate the requests of the Engine

Functions

checkConfigurationValidity

private fun checkConfigurationValidity()

Method to check the validity of the configuration loaded

connectPlatform

fun connectPlatform()

Method to connect the platform where the application is currently running.

execAfterConfigurationLoaded

fun execAfterConfigurationLoaded(action: () -> Unit)

Method to execute an action after the configuration has been loaded. The configurationMutex synchronize the access locking it waiting the configuration loading

execRequest

private suspend fun execRequest(response: HttpResponse)

Method to execute the request

fireUp

fun fireUp(configData: ByteArray, loggingEnabled: Boolean = false, debugMode: Boolean)

fun fireUp(configPath: String, loggingEnabled: Boolean = false, debugMode: Boolean)

Method to initialize the Engine with the configuration data and the flags available

formatHostForAndroid

private fun formatHostForAndroid()

Method to format the host value in the correct localhost value address for the Android emulators with the ANDROID_LOCALHOST_VALUE

getAppVersion

private fun getAppVersion(configuration: EngineConfiguration): String?

Method to get from the engine configuration the application version, this method check first if the version is specific for the current platform where the application is running, if not found will be used the generic one

isValidConfiguration

private fun isValidConfiguration(): Boolean

Method to check whether the configuration is correctly loaded

isValidHost

private fun isValidHost(): Boolean

Method to check whether the host value is correctly formatted

loadConfiguration

private fun loadConfiguration(configData: ByteArray)

Method to load the configuration serializing the data in the EngineConfiguration data class and initializing the host, serverSecret, applicationId and appVersion instances

notifyAppLaunch

private fun notifyAppLaunch()

Method to notify the application launch and send the related value to the server.

notifyIssue

fun notifyIssue(issue: String)

fun notifyIssue(issue: Throwable)

Method to send the crash report of an issue occurred during the runtime of the application

notifyNetworkRequest

fun notifyNetworkRequest()

Method to request the count of a network request sent by the application

sendRequest

private fun sendRequest(method: HttpMethod, endpoint: String = "", parameters: Map<String, Any> = emptyMap(), payload: JsonObject? = null)

Method to send a request

setLogging

private fun setLogging(enabled: Boolean)

Method to set the logging

throwInvalidConfiguration

private fun throwInvalidConfiguration()

Method to throw an error if the configuration is not valid, if the error is related to the appVersion will be instead used a specific message