-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathLogger.kt
More file actions
383 lines (335 loc) · 11.4 KB
/
Logger.kt
File metadata and controls
383 lines (335 loc) · 11.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
package to.bitkit.utils
import android.util.Log
import kotlinx.coroutines.CoroutineScope
import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.SupervisorJob
import kotlinx.coroutines.launch
import kotlinx.serialization.json.Json
import kotlinx.serialization.json.JsonObject
import kotlinx.serialization.json.buildJsonObject
import kotlinx.serialization.json.put
import kotlinx.serialization.serializer
import org.lightningdevkit.ldknode.LogRecord
import org.lightningdevkit.ldknode.LogWriter
import to.bitkit.async.ServiceQueue
import to.bitkit.async.newSingleThreadDispatcher
import to.bitkit.di.json
import to.bitkit.env.Env
import to.bitkit.ext.DatePattern
import to.bitkit.ext.utcDateFormatterOf
import java.io.File
import java.io.FileOutputStream
import java.util.Date
import java.util.Locale
import java.util.concurrent.atomic.AtomicReference
import kotlin.time.measureTime
import org.lightningdevkit.ldknode.LogLevel as LdkLogLevel
private const val APP = "APP"
private const val LDK = "LDK"
private const val COMPACT = false
enum class LogSource { Ldk, Bitkit, Unknown }
enum class LogLevel { PERF, VERBOSE, GOSSIP, TRACE, DEBUG, INFO, WARN, ERROR }
val Logger = AppLogger()
class AppLogger {
companion object {
private const val TAG = "Logger"
private val saverRef = AtomicReference<LogSaver?>(null)
fun getOrCreateSaver(): LogSaver = saverRef.get() ?: synchronized(this) {
saverRef.get() ?: run {
val sessionPath = runCatching { buildSessionLogFilePath() }.getOrElse { "" }
LogSaverImpl(sessionPath).also { saverRef.set(it) }
}
}
}
private var delegate: LoggerImpl? = null
init {
delegate = runCatching { createDelegate() }.getOrNull()
}
private fun createDelegate() = LoggerImpl(APP, getOrCreateSaver())
fun reset() {
warn("Wiping entire logs directory…", context = TAG)
synchronized(AppLogger) {
runCatching { Env.logDir.deleteRecursively() }
saverRef.set(null)
delegate = runCatching { createDelegate() }.getOrNull()
}
}
fun info(
msg: String?,
context: String = "",
file: String = getCallerPath(),
line: Int = getCallerLine(),
) {
delegate?.info(msg, context, file, line)
}
fun debug(
msg: String?,
context: String = "",
file: String = getCallerPath(),
line: Int = getCallerLine(),
) {
delegate?.debug(msg, context, file, line)
}
fun warn(
msg: String?,
e: Throwable? = null,
context: String = "",
file: String = getCallerPath(),
line: Int = getCallerLine(),
) {
delegate?.warn(msg, e, context, file, line)
}
fun error(
msg: String?,
e: Throwable? = null,
context: String = "",
file: String = getCallerPath(),
line: Int = getCallerLine(),
) {
delegate?.error(msg, e, context, file, line)
}
fun verbose(
msg: String?,
e: Throwable? = null,
context: String = "",
file: String = getCallerPath(),
line: Int = getCallerLine(),
) {
delegate?.verbose(msg, e, context, file, line)
}
fun perf(
msg: String?,
context: String = "",
file: String = getCallerPath(),
line: Int = getCallerLine(),
) {
delegate?.perf(msg, context, file, line)
}
}
private class LoggerImpl(
private val tag: String = APP,
private val saver: LogSaver,
private val compact: Boolean = COMPACT,
) {
fun info(
msg: String?,
context: String = "",
path: String = getCallerPath(),
line: Int = getCallerLine(),
) {
val message = formatLog(LogLevel.INFO, msg, context, path, line)
Log.i(tag, message)
saver.save(message)
}
fun debug(
msg: String?,
context: String = "",
path: String = getCallerPath(),
line: Int = getCallerLine(),
) {
val message = formatLog(LogLevel.DEBUG, msg, context, path, line)
Log.d(tag, message)
saver.save(message)
}
fun warn(
msg: String?,
e: Throwable? = null,
context: String = "",
path: String = getCallerPath(),
line: Int = getCallerLine(),
) {
val errMsg = e?.let { errorLogOf(it) }.orEmpty()
val message = formatLog(LogLevel.WARN, "$msg $errMsg", context, path, line)
if (compact) Log.w(tag, message) else Log.w(tag, message, e)
saver.save(message)
}
fun error(
msg: String?,
e: Throwable? = null,
context: String = "",
path: String = getCallerPath(),
line: Int = getCallerLine(),
) {
val errMsg = e?.let { errorLogOf(it) }.orEmpty()
val message = formatLog(LogLevel.ERROR, "$msg $errMsg", context, path, line)
if (compact) Log.e(tag, message) else Log.e(tag, message, e)
saver.save(message)
}
@Suppress("LongParameterList")
fun verbose(
msg: String?,
e: Throwable? = null,
context: String = "",
path: String = getCallerPath(),
line: Int = getCallerLine(),
level: LogLevel = LogLevel.VERBOSE,
) {
val message = formatLog(level, msg, context, path, line)
if (compact) Log.v(tag, message) else Log.v(tag, message, e)
saver.save(message)
}
fun perf(
msg: String?,
context: String = "",
path: String = getCallerPath(),
line: Int = getCallerLine(),
) {
val message = formatLog(LogLevel.PERF, msg, context, path, line)
Log.v(tag, message)
saver.save(message)
}
}
interface LogSaver {
fun save(message: String)
}
class LogSaverImpl(
private val sessionFilePath: String,
) : LogSaver {
private val queue: CoroutineScope by lazy {
CoroutineScope(newSingleThreadDispatcher(ServiceQueue.LOG.name) + SupervisorJob())
}
init {
if (sessionFilePath.isNotEmpty()) {
log("Log session initialized with file path: '$sessionFilePath'")
// Clean all old log files in background
CoroutineScope(Dispatchers.IO).launch {
cleanupOldLogFiles()
}
}
}
override fun save(message: String) {
if (sessionFilePath.isEmpty()) return
queue.launch {
runCatching {
val sanitized = message.replace("\n", " ")
FileOutputStream(File(sessionFilePath), true).use { stream ->
stream.write("$sanitized\n".toByteArray())
}
}.onFailure {
Log.e(APP, "Error writing to log file: '$sessionFilePath'", it)
}
}
}
private fun log(
message: String,
level: LogLevel = LogLevel.INFO,
androidLog: (String, String) -> Unit = { tag, msg -> Log.i(tag, msg) },
) {
val formatted = formatLog(level, message, TAG, getCallerPath(), getCallerLine())
androidLog(APP, formatted)
save(formatted)
}
private fun cleanupOldLogFiles(maxTotalSizeMB: Int = 20) {
log("Deleting old log files…", LogLevel.VERBOSE, Log::v)
val logDir = runCatching { Env.logDir }.getOrNull() ?: return
val logFiles = logDir
.listFiles { file -> file.extension == "log" }
?: return
var totalSize = logFiles.sumOf { it.length() }
val maxSizeBytes = maxTotalSizeMB * 1024L * 1024L
// Sort by creation date (oldest first)
logFiles
.sortedBy { it.lastModified() }
.forEach { file ->
if (totalSize <= maxSizeBytes) return
runCatching {
log("Deleting old log file: '${file.name}'", LogLevel.DEBUG, Log::d)
if (file.delete()) {
totalSize -= file.length()
}
}.onFailure {
log("Failed to delete old log file: '${file.name}'", LogLevel.WARN, Log::w)
}
}
log("Deleted all old log files.", LogLevel.VERBOSE, Log::v)
}
companion object {
private const val TAG = "LogSaver"
}
}
class LdkLogWriter(
private val maxLogLevel: LdkLogLevel = Env.ldkLogLevel,
saver: LogSaver = AppLogger.getOrCreateSaver(),
) : LogWriter {
private val delegate: LoggerImpl = LoggerImpl(LDK, saver)
override fun log(record: LogRecord) {
if (record.level < maxLogLevel) return
val msg = record.args
val path = record.modulePath
val line = record.line.toInt()
when (record.level) {
LdkLogLevel.GOSSIP -> delegate.verbose(msg, path = path, line = line, level = LogLevel.GOSSIP)
LdkLogLevel.TRACE -> delegate.verbose(msg, path = path, line = line, level = LogLevel.TRACE)
LdkLogLevel.DEBUG -> delegate.debug(msg, path = path, line = line)
LdkLogLevel.INFO -> delegate.info(msg, path = path, line = line)
LdkLogLevel.WARN -> delegate.warn(msg, path = path, line = line)
LdkLogLevel.ERROR -> delegate.error(msg, path = path, line = line)
}
}
}
private fun buildSessionLogFilePath(): String {
val logDir = Env.logDir
val timestamp = utcDateFormatterOf(DatePattern.LOG_FILE).format(Date())
val path = logDir.resolve("bitkit_$timestamp.log").path
return path
}
private fun formatLog(level: LogLevel, msg: String?, context: String, path: String, line: Int): String {
val timestamp = utcDateFormatterOf(DatePattern.LOG_LINE).format(Date())
val message = msg?.trim().orEmpty()
val contextString = if (context.isNotEmpty()) " - $context" else ""
val location = "[$path:$line]"
return String.format(
Locale.US,
"%s %-7s %-36s %s%s",
timestamp,
level.name,
location,
message,
contextString,
)
}
/**
* Determines which stack frame to use for caller info.
*
* The value 5 is chosen based on the current call chain:
* - [0] `Thread.getStackTrace`
* - [1] `getCallerPath`/`getCallerLine`
* - [2] `LoggerImpl.log_method` (e.g., debug, info, etc.)
* - [3] `LdkLogWriter.log_method`
* - [4] external caller
* - [5] actual caller of logging function
*
* If the call chain changes, this index may need to be updated.
*/
private const val STACK_INDEX = 5
private fun getCallerPath(): String = Thread.currentThread().stackTrace.getOrNull(STACK_INDEX)?.fileName ?: "Unknown"
private fun getCallerLine(): Int = Thread.currentThread().stackTrace.getOrNull(STACK_INDEX)?.lineNumber ?: -1
val jsonLogger = Json(json) {
prettyPrint = false
}
inline fun <reified T : Any> jsonLogOf(value: T): String {
val jsonElement = jsonLogger.encodeToJsonElement(jsonLogger.serializersModule.serializer<T>(), value)
if (jsonElement !is JsonObject || "type" !in jsonElement) return jsonElement.toString()
return buildJsonObject {
jsonElement.forEach { (key, elem) ->
if (key == "type") {
put("type", value::class.simpleName ?: "Unknown")
} else {
put(key, elem)
}
}
}.toString()
}
fun errorLogOf(e: Throwable): String = "[${e::class.simpleName}='${e.message}']"
internal inline fun <T> measured(
label: String,
context: String,
block: () -> T,
): T {
var result: T
val elapsed = measureTime {
result = block()
}
Logger.perf("$label took $elapsed", context = context)
return result
}