feat(server): improve logging setup (#1641)

Fixes #1194

Author: Vampire

action-binding-generator/build.gradle.kts

@@ -15,6 +15,7 @@ dependencies {
     implementation("com.squareup:kotlinpoet:2.0.0")
     implementation("it.krzeminski:snakeyaml-engine-kmp:3.0.3")
     implementation("com.charleskorn.kaml:kaml:0.62.0")
+    implementation("io.github.oshai:kotlin-logging:7.0.0")
     implementation(projects.sharedInternal)
 
     testImplementation(projects.githubWorkflowsKt)

action-binding-generator/src/main/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/metadata/MetadataReading.kt

@@ -1,6 +1,7 @@
 package io.github.typesafegithub.workflows.actionbindinggenerator.metadata
 
 import com.charleskorn.kaml.Yaml
+import io.github.oshai.kotlinlogging.KotlinLogging.logger
 import io.github.typesafegithub.workflows.actionbindinggenerator.domain.ActionCoords
 import io.github.typesafegithub.workflows.actionbindinggenerator.domain.CommitHash
 import io.github.typesafegithub.workflows.actionbindinggenerator.domain.MetadataRevision
@@ -11,6 +12,8 @@ import kotlinx.serialization.decodeFromString
 import java.io.IOException
 import java.net.URI
 
+private val logger = logger { }
+
 /**
  * [Metadata syntax for GitHub Actions](https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions).
  */
@@ -56,7 +59,7 @@ public fun ActionCoords.fetchMetadata(
     return list
         .firstNotNullOfOrNull { url ->
             try {
-                println("  ... from $url")
+                logger.info { "  ... from $url" }
                 fetchUri(URI(url))
             } catch (e: IOException) {
                 null

action-binding-generator/src/main/kotlin/io/github/typesafegithub/workflows/actionbindinggenerator/typing/TypesProviding.kt

@@ -1,6 +1,7 @@
 package io.github.typesafegithub.workflows.actionbindinggenerator.typing
 
 import com.charleskorn.kaml.Yaml
+import io.github.oshai.kotlinlogging.KotlinLogging.logger
 import io.github.typesafegithub.workflows.actionbindinggenerator.domain.ActionCoords
 import io.github.typesafegithub.workflows.actionbindinggenerator.domain.CommitHash
 import io.github.typesafegithub.workflows.actionbindinggenerator.domain.MetadataRevision
@@ -17,6 +18,8 @@ import kotlinx.serialization.decodeFromString
 import java.io.IOException
 import java.net.URI
 
+private val logger = logger { }
+
 internal fun ActionCoords.provideTypes(
     metadataRevision: MetadataRevision,
     fetchUri: (URI) -> String = ::fetchUri,
@@ -54,7 +57,7 @@ private fun ActionCoords.fetchTypingMetadata(
     val typesMetadataYaml =
         list.firstNotNullOfOrNull { url ->
             try {
-                println("  ... types from $url")
+                logger.info { "  ... types from action $url" }
                 fetchUri(URI(url))
             } catch (e: IOException) {
                 null
@@ -74,7 +77,7 @@ private fun ActionCoords.fetchTypingsForOlderVersionFromCatalog(fetchUri: (URI)
     val metadataUrl = this.catalogMetadata()
     val metadataYml =
         try {
-            println("  ... metadata from $metadataUrl")
+            logger.info { "  ... metadata from $metadataUrl" }
             fetchUri(URI(metadataUrl))
         } catch (e: IOException) {
             return null
@@ -86,10 +89,10 @@ private fun ActionCoords.fetchTypingsForOlderVersionFromCatalog(fetchUri: (URI)
             .filter { it.versionToInt() < requestedVersionAsInt }
             .maxByOrNull { it.versionToInt() }
             ?: run {
-                println("  ... no fallback version found!")
+                logger.info { "  ... no fallback version found!" }
                 return null
             }
-    println("  ... using fallback version: $fallbackVersion")
+    logger.info { "  ... using fallback version: $fallbackVersion" }
     val adjustedCoords = this.copy(version = fallbackVersion)
     return fetchTypingsFromUrl(url = adjustedCoords.actionTypesFromCatalog(), fetchUri = fetchUri)
 }
@@ -100,7 +103,7 @@ private fun fetchTypingsFromUrl(
 ): ActionTypes? {
     val typesMetadataYml =
         try {
-            println("  ... types from $url")
+            logger.info { "  ... types from catalog $url" }
             fetchUri(URI(url))
         } catch (e: IOException) {
             null

jit-binding-server/build.gradle.kts

@@ -14,12 +14,19 @@ dependencies {
     implementation("io.ktor:ktor-client-cio")
     implementation("io.ktor:ktor-client-content-negotiation")
     implementation("io.ktor:ktor-serialization-kotlinx-json")
+    implementation("io.ktor:ktor-server-call-logging")
+    implementation("io.ktor:ktor-server-call-id")
     implementation("io.opentelemetry.instrumentation:opentelemetry-ktor-2.0:2.3.0-alpha")
     implementation("io.opentelemetry:opentelemetry-sdk:1.43.0")
     implementation("io.opentelemetry:opentelemetry-exporter-otlp:1.43.0")
     implementation("io.opentelemetry:opentelemetry-exporter-logging:1.43.0")
     implementation("io.github.reactivecircus.cache4k:cache4k:0.13.0")
-    implementation("ch.qos.logback:logback-classic:1.5.12")
+    implementation("io.github.oshai:kotlin-logging:7.0.0")
+    implementation(platform("org.apache.logging.log4j:log4j-bom:2.24.0"))
+    implementation("org.apache.logging.log4j:log4j-jul")
+    runtimeOnly("org.apache.logging.log4j:log4j-core")
+    runtimeOnly("org.apache.logging.log4j:log4j-slf4j2-impl")
+    runtimeOnly("org.apache.logging.log4j:log4j-jpl")
 
     implementation(projects.mavenBindingBuilder)
     implementation(projects.sharedInternal)

jit-binding-server/src/main/kotlin/io/github/typesafegithub/workflows/jitbindingserver/Main.kt

@@ -1,5 +1,6 @@
 package io.github.typesafegithub.workflows.jitbindingserver
 
+import io.github.oshai.kotlinlogging.KotlinLogging.logger
 import io.github.reactivecircus.cache4k.Cache
 import io.github.typesafegithub.workflows.actionbindinggenerator.domain.ActionCoords
 import io.github.typesafegithub.workflows.actionbindinggenerator.domain.prettyPrint
@@ -10,12 +11,17 @@ import io.github.typesafegithub.workflows.mavenbinding.buildPackageArtifacts
 import io.github.typesafegithub.workflows.mavenbinding.buildVersionArtifacts
 import io.github.typesafegithub.workflows.shared.internal.getGithubToken
 import io.ktor.http.ContentType
+import io.ktor.http.HttpHeaders.XRequestId
 import io.ktor.http.HttpStatusCode
 import io.ktor.server.application.ApplicationCall
 import io.ktor.server.application.call
 import io.ktor.server.application.install
 import io.ktor.server.engine.embeddedServer
 import io.ktor.server.netty.Netty
+import io.ktor.server.plugins.callid.CallId
+import io.ktor.server.plugins.callid.callIdMdc
+import io.ktor.server.plugins.callid.generate
+import io.ktor.server.plugins.callloging.CallLogging
 import io.ktor.server.response.respondBytes
 import io.ktor.server.response.respondText
 import io.ktor.server.routing.Route
@@ -26,7 +32,23 @@ import io.ktor.server.routing.routing
 import io.opentelemetry.instrumentation.ktor.v2_0.server.KtorServerTracing
 import kotlin.time.Duration.Companion.hours
 
+private val logger =
+    System
+        /*
+         * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+         * !! IMPORTANT:                                                                       !!
+         * !!     This statement has to always be executed first before **any** other code,    !!
+         * !!     or else the property "java.util.logging.manager" may have no effect anymore! !!
+         * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+         */
+        .setProperty("java.util.logging.manager", org.apache.logging.log4j.jul.LogManager::class.java.name)
+        .let { logger { } }
+
 fun main() {
+    Thread.setDefaultUncaughtExceptionHandler { thread, throwable ->
+        logger.error(throwable) { "Uncaught exception in thread $thread" }
+    }
+
     val bindingsCache =
         Cache
             .Builder<ActionCoords, Result<Map<String, Artifact>>>()
@@ -35,6 +57,16 @@ fun main() {
     val openTelemetry = buildOpenTelemetryConfig(serviceName = "github-actions-bindings")
 
     embeddedServer(Netty, port = 8080) {
+        install(CallId) {
+            generate(
+                length = 15,
+                dictionary = "abcdefghijklmnopqrstuvwxyz0123456789",
+            )
+            replyToHeader(XRequestId)
+        }
+        install(CallLogging) {
+            callIdMdc("request-id")
+        }
         install(KtorServerTracing) {
             setOpenTelemetry(openTelemetry)
         }
@@ -155,7 +187,7 @@ private suspend fun ApplicationCall.toBindingArtifacts(
             version = version,
             path = nameAndPath.drop(1).joinToString("/").takeUnless { it.isBlank() },
         )
-    println("➡️ Requesting ${actionCoords.prettyPrint}")
+    logger.info { "➡️ Requesting ${actionCoords.prettyPrint}" }
     val bindingArtifacts =
         if (refresh) {
             actionCoords.buildVersionArtifacts().also {

jit-binding-server/src/main/resources/log4j2.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<Configuration name="github-workflows-kt-jit-binding-server" status="INFO" monitorInterval="5" strict="true">
+    <Appenders>
+        <Console name="Console Appender">
+            <PatternLayout>
+                <Pattern><![CDATA[%highlight{%d <%-5p> <%-35.35t> <%x> <%X> <%50.50c> %m}%n]]></Pattern>
+            </PatternLayout>
+        </Console>
+    </Appenders>
+    <Loggers>
+        <Root level="INFO">
+            <AppenderRef ref="Console Appender"/>
+        </Root>
+    </Loggers>
+</Configuration>

maven-binding-builder/src/main/kotlin/io/github/typesafegithub/workflows/mavenbinding/JarBuilding.kt

@@ -81,8 +81,8 @@ private fun compileBinding(sourceFilePaths: List<Path>): Path {
             services = Services.EMPTY,
             arguments = args,
         )
-    require(exitCode == ExitCode.OK) {
-        "Binding compilation failed! Compiler messages: $compilerMessagesOutputStream"
+    check(exitCode == ExitCode.OK) {
+        "Binding compilation failed! Compiler messages:\n$compilerMessagesOutputStream"
     }
     return compilationOutput
 }