DittoLogger

Singleton object with static methods to customize the logging behavior from Ditto.

Currently, Ditto uses the persistence directory of the Ditto instance that was most recently created to store a limited amount of logs. Ditto may continue writing logs to a persistence directory even after the associated Ditto instance is deallocated. If this is a concern, consider either disabling logging by setting DittoLogger.enabled to false, or instantiating a new Ditto instance. After either of these actions, it is safe to remove the persistence directory. Please refer to DittoLogger.exportToFile for further details on locally collected logs.

Types

InternalDittoLogger

object InternalDittoLogger : LoggerCb

Functions

exportToFile

suspend fun exportToFile(path: String): ULong

Exports collected logs to a compressed and JSON-encoded file on the local file system.

exportToFileBlocking

@JvmName(name = "exportToFile")

@JvmStatic

fun exportToFileBlocking(path: String): BigInteger

Exports collected logs to a compressed and JSON-encoded file on the local file system.

ffiCustomLog

fun ffiCustomLog(cLogLevel: CLogLevel_t, msg: String)

Sends a single message to the log at the given log level.

setCustomLogCallback

fun setCustomLogCallback(logCallback: (DittoLogLevel, String) -> Unit?)

@JvmStatic

fun setCustomLogCallback(logCb: DittoLogCallback)

Registers a callback for a fully customizable way of handling log "events" from the logger (on top of logging to the console, and to a file, if any).

setLogFile

@JvmStatic

fun setLogFile(logFile: String?)

Registers a file path where logs will be written to, whenever Ditto wants to issue a log (on top of emitting the log to the console).

unsetCustomLogCallback

@JvmStatic

fun unsetCustomLogCallback()

Unregisters the currently registered callback (if any), to be used when interacting with the SDK from Java.