Improve logging configuration

Author: lilvadim

.github/workflows/release.yml

@@ -40,7 +40,7 @@ jobs:
       - name: Setup Gradle
         uses: gradle/actions/setup-gradle@v4
       - name: Package app with Gradle
-        run: ./gradlew jpackage -Pversion="${{ github.ref_name }}" -PappLoggingStdout=false
+        run: ./gradlew jpackage -Pversion="${{ github.ref_name }}"
       - name: Upload Asset
         shell: bash
         run: |

build.gradle

@@ -2,21 +2,18 @@ import org.gradle.nativeplatform.platform.internal.DefaultNativePlatform
 import org.jetbrains.kotlin.gradle.dsl.JvmTarget
 
 buildscript {
-    ext.kotlinVersion = '2.2.0'
-    repositories {
-        mavenCentral()
-    }
+    ext.kotlinVersion = "2.2.0"
 }
 
 plugins {
-    id 'java'
-    id 'application'
-    id 'org.jetbrains.kotlin.jvm' version "$kotlinVersion"
-    id 'org.openjfx.javafxplugin' version '0.1.0'
+    id "java"
+    id "application"
+    id "org.jetbrains.kotlin.jvm" version "$kotlinVersion"
+    id "org.openjfx.javafxplugin" version "0.1.0"
     id "org.jetbrains.dokka" version "2.0.0"
 }
 
-group 'ru.nucodelabs'
+group "ru.nucodelabs"
 
 java {
     sourceCompatibility = JavaVersion.VERSION_21
@@ -34,18 +31,18 @@ ext {
     // For deps
     def osName = currentOS.isWindows() ? "windows" : currentOS.isMacOsX() ? "macosx" : "linux"
     def archName = currentArch.isArm64() && !currentOS.isWindows() ? "arm64" : "x86_64"
-    set 'platform', "$osName-$archName"
+    set "platform", "$osName-$archName"
 
     println "OS:           ${currentOS.name}"
     println "OS VERSION:   ${System.getProperty("os.version")}"
     println "ARCHITECTURE: ${currentArch.name}"
     println "CLASSIFIER:   ${platform}"
 
-    set 'runDir', "$projectDir/.run"
+    set "runDir", "$projectDir/.run"
 
     /* Dependency versions */
-    set 'logbackVersion', "1.5.18"
-    set 'guiceVersion', '7.0.0'
+    set "logbackVersion", "1.5.18"
+    set "guiceVersion", "7.0.0"
 }
 
 processResources {
@@ -72,25 +69,25 @@ compileTestKotlin {
 }
 
 tasks.withType(JavaCompile).configureEach {
-    options.encoding = 'UTF-8'
+    options.encoding = "UTF-8"
 }
 
 application {
-    mainClass = 'ru.nucodelabs.gem.app.StartGemApplication'
+    mainClass = "ru.nucodelabs.gem.app.StartGemApplication"
 }
 
 javafx {
-    version = '23'
-    modules = ['javafx.controls', 'javafx.fxml', 'javafx.graphics', 'javafx.swing']
+    version = "23"
+    modules = ["javafx.controls", "javafx.fxml", "javafx.graphics", "javafx.swing"]
 }
 
 dependencies {
     /* Versions */
-    final junitVersion = '5.9.2'
-    final jacksonVersion = '2.19.2'
+    final junitVersion = "5.9.2"
+    final jacksonVersion = "2.19.2"
     final kotlinTestVersion = kotlinVersion
-    final mapstructVersion = '1.6.3'
-    final slf4jVersion = '2.0.17'
+    final mapstructVersion = "1.6.3"
+    final slf4jVersion = "2.0.17"
 
     implementation project(":kfx-utils")
     implementation project(":common-utils")
@@ -103,32 +100,30 @@ dependencies {
             "$projectDir/lib/${System.mapLibraryName("MathVES")}"
     )
 
-    implementation "org.slf4j:slf4j-api:${slf4jVersion}"
+    implementation("org.slf4j:slf4j-api:${slf4jVersion}")
     implementation("ch.qos.logback:logback-classic:$logbackVersion")
     implementation project(":app-logback-appender")
-    implementation 'org.codehaus.janino:janino:3.1.12'
-//    implementation "org.slf4j:slf4j-jdk14:${slf4jVersion}"
 
     implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlinVersion"
-    implementation 'org.hibernate.validator:hibernate-validator:8.0.0.Final'
+    implementation "org.hibernate.validator:hibernate-validator:8.0.0.Final"
 
     implementation "org.mapstruct:mapstruct:$mapstructVersion"
     annotationProcessor "org.mapstruct:mapstruct-processor:$mapstructVersion"
 
     /* FXML script tag Groovy support */
-    implementation 'org.codehaus.groovy:groovy-jsr223:3.0.25'
+    implementation "org.codehaus.groovy:groovy-jsr223:3.0.25"
 
-    implementation group: 'com.fasterxml.jackson.core', name: 'jackson-databind', version: jacksonVersion
-    implementation group: 'org.apache.commons', name: 'commons-math3', version: '3.6.1'
+    implementation group: "com.fasterxml.jackson.core", name: "jackson-databind", version: jacksonVersion
+    implementation group: "org.apache.commons", name: "commons-math3", version: "3.6.1"
 
-    implementation group: 'com.google.inject', name: 'guice', version: guiceVersion
-    implementation group: 'org.tinfour', name: 'TinfourCore', version: '2.1.8'
+    implementation group: "com.google.inject", name: "guice", version: guiceVersion
+    implementation group: "org.tinfour", name: "TinfourCore", version: "2.1.8"
     implementation "com.fasterxml.jackson.module:jackson-module-kotlin:$jacksonVersion"
-    implementation 'org.apache.commons:commons-collections4:4.4'
+    implementation "org.apache.commons:commons-collections4:4.4"
 
     /* Math Libraries */
-    implementation 'org.glassfish.expressly:expressly:5.0.0'
-    implementation 'com.github.haifengl:smile-core:4.4.0'
+    implementation "org.glassfish.expressly:expressly:5.0.0"
+    implementation "com.github.haifengl:smile-core:4.4.0"
     implementation "org.bytedeco:openblas:0.3.30-1.5.12:$platform"
     implementation "org.bytedeco:javacpp:1.5.12:$platform"
     implementation "org.bytedeco:arpack-ng:3.9.1-1.5.12:$platform"
@@ -144,42 +139,44 @@ dependencies {
 
 /* Setup Runtime */
 
-tasks.register('prepareRunDir') {
+tasks.register("prepareRunDir") {
     file(runDir).mkdirs()
 }
 
-tasks.register('copyLibsToRunDir', Copy) {
+tasks.register("copyLibsToRunDir", Copy) {
     dependsOn prepareRunDir
     from "$projectDir/lib"
     into runDir
 }
 
-tasks.register('copyDataToRunDir', Copy) {
+tasks.register("copyDataToRunDir", Copy) {
     dependsOn prepareRunDir
     from "$projectDir/data"
     into "$runDir/data"
 }
 
-tasks.register('copyClrToRunDir', Copy) {
+tasks.register("copyClrToRunDir", Copy) {
     dependsOn prepareRunDir
     from "$projectDir/colormap/default.clr"
     into "$runDir/colormap"
 }
 
-tasks.register('cleanRunDir', Delete) {
+tasks.register("cleanRunDir", Delete) {
     delete fileTree(runDir) { exclude "err-trace*.txt" }
 }
 
 tasks.withType(JavaExec).configureEach {
     dependsOn copyClrToRunDir, copyDataToRunDir, copyLibsToRunDir
     jvmArgs = moduleExportsJvmArgs
+    systemProperty("app.gem.log.stdout", true)
     workingDir = file(runDir)
     finalizedBy cleanRunDir
 }
 
 test {
     dependsOn copyClrToRunDir, copyDataToRunDir, copyLibsToRunDir
     workingDir = file(runDir)
+    systemProperty("app.gem.log.stdout", true)
     useJUnitPlatform()
     finalizedBy cleanRunDir
 }
@@ -189,8 +186,10 @@ test {
 final jpackageInputDir = layout.buildDirectory.dir("jars").get().asFile.absolutePath
 
 tasks.register("copyNativeDependencies", Copy) {
-    from file("$projectDir/lib/${System.mapLibraryName("MathVES_JNI")}"),
+    from(
+            file("$projectDir/lib/${System.mapLibraryName("MathVES_JNI")}"),
             file("$projectDir/lib/${System.mapLibraryName("MathVES")}")
+    )
     into(jpackageInputDir)
 }
 

gradle.properties

@@ -1,3 +1 @@
-version=1.0.0-SNAPSHOT
-appLoggingLevel=INFO
-appLoggingStdout=true
+version=1.0.0-SNAPSHOT

settings.gradle

@@ -1,4 +1,5 @@
 rootProject.name = "gem"
-include 'kfx-utils', 'common-utils'
+include 'kfx-utils'
+include 'common-utils'
 include 'files'
 include 'app-logback-appender'

src/main/java/ru/nucodelabs/gem/app/GemApplication.kt

@@ -55,12 +55,7 @@ class GemApplication : GuiceApplication(AppModule()) {
 
     @Throws(Exception::class)
     override fun start(primaryStage: Stage) {
-        Thread.setDefaultUncaughtExceptionHandler(
-            UncaughtExceptionHandler(
-                alertsFactory,
-                parameters.raw.contains("--disable-uncaught-error-files")
-            )
-        )
+        Thread.setDefaultUncaughtExceptionHandler(UncaughtExceptionHandler(alertsFactory))
         val params: List<String> = parameters.raw + macOSHandledFiles
         if (
             params.any {

src/main/java/ru/nucodelabs/gem/app/UncaughtExceptionHandler.kt

@@ -1,37 +1,20 @@
 package ru.nucodelabs.gem.app
 
+import javafx.application.Platform
 import ru.nucodelabs.gem.config.slf4j
 import ru.nucodelabs.gem.view.AlertsFactory
-import ru.nucodelabs.util.OS
-import java.io.File
 import java.lang.Thread.UncaughtExceptionHandler
-import java.time.LocalDateTime
-import java.time.format.DateTimeFormatter
 
 class UncaughtExceptionHandler(
     private val alertsFactory: AlertsFactory,
-    private val writeToFileDisabled: Boolean
 ) : UncaughtExceptionHandler {
 
     val log = slf4j(this)
 
     override fun uncaughtException(t: Thread, e: Throwable) {
         log.error("Uncaught exception", e)
-        handleUnexpectedException(e)
-    }
-
-    private fun handleUnexpectedException(e: Throwable) {
-        alertsFactory.uncaughtExceptionAlert(e).show()
-        if (!writeToFileDisabled) {
-            val dateNow = LocalDateTime.now()
-            val formattedDate = dateNow
-                .format(DateTimeFormatter.ofPattern("dd.MM.yyyy"))
-            val timestamp = java.time.Instant.now().toEpochMilli()
-            val traceFile =
-                File("err-trace_${OS.osNameClassifier}_${formattedDate}_${timestamp}.txt").also {
-                    it.createNewFile()
-                }
-            traceFile.writeText(e.stackTraceToString())
+        if (Platform.isFxApplicationThread()) {
+            alertsFactory.uncaughtExceptionAlert(e).show()
         }
     }
 }

src/main/java/ru/nucodelabs/gem/config/GemLogbackConfigurator.kt

@@ -0,0 +1,41 @@
+package ru.nucodelabs.gem.config
+
+import ch.qos.logback.classic.BasicConfigurator
+import ch.qos.logback.classic.Level
+import ch.qos.logback.classic.Logger
+import ch.qos.logback.classic.LoggerContext
+import ch.qos.logback.classic.layout.TTLLLayout
+import ch.qos.logback.classic.spi.Configurator
+import ch.qos.logback.classic.spi.ILoggingEvent
+import ch.qos.logback.core.encoder.LayoutWrappingEncoder
+import ch.qos.logback.core.spi.ContextAwareBase
+import ru.nucodelabs.logback.appender.AppLogFileAppender
+
+class GemLogbackConfigurator : ContextAwareBase(), Configurator {
+
+    override fun configure(loggerContext: LoggerContext?): Configurator.ExecutionStatus? {
+        if (System.getProperty("app.gem.log.stdout", "false").toBoolean()) {
+            BasicConfigurator().also { it.context = loggerContext }.configure(loggerContext)
+        }
+
+        val appender = AppLogFileAppender<ILoggingEvent>().apply {
+            context = loggerContext
+            name = "APP_FILE"
+            appName = "ru.nucodelabs.gem"
+            logFileName = "last_session.log"
+            isAppend = false
+            encoder = LayoutWrappingEncoder<ILoggingEvent>().apply {
+                context = loggerContext
+                layout = TTLLLayout().apply { context = loggerContext }.also { it.start() }
+            }.also { it.start() }
+        }.also { it.start() }
+
+        loggerContext?.getLogger(Logger.ROOT_LOGGER_NAME)?.let { root ->
+            root.isAdditive = false
+            root.level = Level.valueOf(System.getProperty("app.gem.log.level", "INFO"))
+            root.addAppender(appender)
+        }
+
+        return Configurator.ExecutionStatus.DO_NOT_INVOKE_NEXT_IF_ANY
+    }
+}

src/main/java/ru/nucodelabs/gem/config/Logging.kt

@@ -2,4 +2,4 @@ package ru.nucodelabs.gem.config
 
 import org.slf4j.LoggerFactory
 
-fun slf4j(instance: Any) = LoggerFactory.getLogger(instance::class.java)!!
+fun slf4j(instance: Any) = LoggerFactory.getLogger(instance::class.java)!!

src/main/resources/META-INF/services/ch.qos.logback.classic.spi.Configurator

@@ -0,0 +1 @@
+ru.nucodelabs.gem.config.GemLogbackConfigurator