Fix #34906: replace Alloy by Loki docker driver

LEDfan · LEDfan · commit 357c1bbe0d5e · 2025-04-29T08:28:07.000+02:00
diff --git a/src/main/kotlin/eu/openanalytics/shinyproxyoperator/impl/docker/DockerOrchestrator.kt b/src/main/kotlin/eu/openanalytics/shinyproxyoperator/impl/docker/DockerOrchestrator.kt
@@ -49,6 +49,7 @@ import org.mandas.docker.client.DockerClient
 import org.mandas.docker.client.builder.jersey.JerseyDockerClientBuilder
 import org.mandas.docker.client.messages.ContainerConfig
 import org.mandas.docker.client.messages.HostConfig
+import org.mandas.docker.client.messages.LogConfig
 import java.io.FileWriter
 import java.nio.file.Files
 import java.nio.file.Path
@@ -211,7 +212,7 @@ class DockerOrchestrator(channel: Channel<ShinyProxyEvent>,
 
                 copyTemplates(shinyProxy, dir)
 
-                val hostConfig = HostConfig.builder()
+                val hostConfigBuilder = HostConfig.builder()
                     .networkMode(networkName)
                     .binds(
                         HostConfig.Bind.builder()
@@ -245,11 +246,21 @@ class DockerOrchestrator(channel: Channel<ShinyProxyEvent>,
                     .memory(memoryToBytes(shinyProxy.memoryLimit))
                     .cpuPeriod(cpuPeriod)
                     .cpuQuota(cpuQuota)
-                    .build()
+
+                if (monitoringConfig.isEnabled()) {
+                    hostConfigBuilder.logConfig(LogConfig.builder()
+                        .logType("loki")
+                        .logOptions(mapOf(
+                            "loki-url" to monitoringConfig.grafanaLokiConfig.getLokiPushUrl(),
+                            "mode" to "non-blocking",
+                            "loki-external-labels" to "sp_realm_id=${shinyProxy.realmId},sp_instance=${shinyProxyInstance.hashOfSpec},namespace=${shinyProxy.namespace},app=shinyproxy"
+                        ))
+                        .build())
+                }
 
                 val containerConfig = ContainerConfig.builder()
                     .image(shinyProxy.image)
-                    .hostConfig(hostConfig)
+                    .hostConfig(hostConfigBuilder.build())
                     .labels(shinyProxy.labels + LabelFactory.labelsForShinyProxyInstance(shinyProxyInstance, version))
                     .env("PROXY_VERSION=${version}", "PROXY_REALM_ID=${shinyProxy.realmId}", "SPRING_CONFIG_IMPORT=/opt/shinyproxy/generated.yml")
                     .build()
@@ -438,18 +449,19 @@ class DockerOrchestrator(channel: Channel<ShinyProxyEvent>,
                     )
                 )
             ),
-            "proxy" to hashMapOf(
-                "docker" to mapOf(
-                    "default-container-network" to networkName
-                ),
-                "template-path" to "/opt/shinyproxy/templates"
-            )
+            "proxy" to buildMap {
+                put("docker", buildMap {
+                    put("default-container-network", networkName)
+                    if (monitoringConfig.isEnabled()) {
+                        put("loki-url", monitoringConfig.grafanaLokiConfig.getLokiPushUrl())
+                    }
+                })
+                put("template-path", "/opt/shinyproxy/templates")
+                if (monitoringConfig.isEnabled()) {
+                    put("monitoring", mapOf("grafana-url" to monitoringConfig.grafanaConfig.getGrafanaUrl(shinyProxy)))
+                }
+            }
         )
-        if (monitoringConfig.isEnabled()) {
-            config["proxy"]?.put("monitoring", hashMapOf(
-                "grafana-url" to monitoringConfig.grafanaConfig.getGrafanaUrl(shinyProxy)
-            ))
-        }
         return objectMapper.writeValueAsString(config)
     }
 
diff --git a/src/main/kotlin/eu/openanalytics/shinyproxyoperator/impl/docker/monitoring/GrafanaAlloyConfig.kt b/src/main/kotlin/eu/openanalytics/shinyproxyoperator/impl/docker/monitoring/GrafanaAlloyConfig.kt
diff --git a/src/main/kotlin/eu/openanalytics/shinyproxyoperator/impl/docker/monitoring/GrafanaLokiConfig.kt b/src/main/kotlin/eu/openanalytics/shinyproxyoperator/impl/docker/monitoring/GrafanaLokiConfig.kt
@@ -28,6 +28,7 @@ import io.github.oshai.kotlinlogging.KotlinLogging
 import org.mandas.docker.client.DockerClient
 import org.mandas.docker.client.messages.ContainerConfig
 import org.mandas.docker.client.messages.HostConfig
+import org.mandas.docker.client.messages.PortBinding
 import java.nio.file.Path
 
 class GrafanaLokiConfig(private val dockerClient: DockerClient, private val dockerActions: DockerActions, mainDataDir: Path, config: Config) {
@@ -67,11 +68,13 @@ class GrafanaLokiConfig(private val dockerClient: DockerClient, private val dock
                     .build(),
             )
             .restartPolicy(HostConfig.RestartPolicy.always())
+            .portBindings(mapOf("3100" to listOf(PortBinding.of("127.0.0.1", "3100"))))
             .build()
 
         val containerConfig = ContainerConfig.builder()
             .image(lokiImage)
             .hostConfig(hostConfig)
+            .exposedPorts("3100")
             .user("1000")
             .labels(mapOf("app" to "grafana-loki"))
             .build()
@@ -81,4 +84,8 @@ class GrafanaLokiConfig(private val dockerClient: DockerClient, private val dock
         dockerClient.startContainer(containerId)
     }
 
+    fun getLokiPushUrl(): String {
+        return "http://localhost:3100/loki/api/v1/push"
+    }
+
 }
diff --git a/src/main/kotlin/eu/openanalytics/shinyproxyoperator/impl/docker/monitoring/MonitoringConfig.kt b/src/main/kotlin/eu/openanalytics/shinyproxyoperator/impl/docker/monitoring/MonitoringConfig.kt
@@ -31,15 +31,13 @@ class MonitoringConfig(dockerClient: DockerClient, dockerActions: DockerActions,
 
     private val enableMonitoring = config.readConfigValue(false, "SPO_ENABLE_MONITORING") { it.toBoolean() }
 
-    private val grafanaAlloyConfig = GrafanaAlloyConfig(dockerClient, dockerActions, mainDataDir, config)
-    private val grafanaLokiConfig = GrafanaLokiConfig(dockerClient, dockerActions, mainDataDir, config)
+    internal val grafanaLokiConfig = GrafanaLokiConfig(dockerClient, dockerActions, mainDataDir, config)
     private val prometheusConfig = PrometheusConfig(dockerClient, dockerActions, mainDataDir, config)
     private val cAdvisorConfig = CAdvisorConfig(dockerClient, dockerActions, config)
     internal val grafanaConfig = GrafanaConfig(dockerClient, dockerActions, mainDataDir, caddyConfig, config)
 
     suspend fun reconcile(shinyProxy: ShinyProxy) {
         if (enableMonitoring) {
-            grafanaAlloyConfig.reconcile()
             grafanaLokiConfig.reconcile()
             prometheusConfig.reconcile()
             cAdvisorConfig.reconcile()
diff --git a/src/main/resources/configs/docker/monitoring/config.alloy b/src/main/resources/configs/docker/monitoring/config.alloy
diff --git a/src/main/resources/configs/docker/monitoring/grafana/dashboards/shinyproxy-app-logs.json b/src/main/resources/configs/docker/monitoring/grafana/dashboards/shinyproxy-app-logs.json
@@ -507,7 +507,7 @@
             "type": "loki",
             "uid": "${datasource}"
           },
-          "expr": "{sp_realm_id=~\".+\", namespace=~\"$namespace\", sp_realm_id=~\"$realm\", sp_user_id=~\"$user\", sp_spec_id=~\"$app\", sp_proxy_instance=~\"$instance\", sp_proxy_id=\"$id\", sp_proxy_id!=\"\"} | line_format `[App]: {{ __line__ }}` ",
+          "expr": "{sp_realm_id=~\".+\", namespace=~\"$namespace\", sp_realm_id=~\"$realm\", sp_proxy_id=\"$id\", sp_proxy_id!=\"\"} | line_format `[App]: {{ __line__ }}` ",
           "legendFormat": "",
           "refId": "A"
         },
diff --git a/src/main/resources/configs/docker/monitoring/grafana/dashboards/shinyproxy-delegate-app-logs.json b/src/main/resources/configs/docker/monitoring/grafana/dashboards/shinyproxy-delegate-app-logs.json
@@ -323,7 +323,7 @@
             "type": "loki",
             "uid": "${datasource}"
           },
-          "expr": "{sp_realm_id=~\".+\", namespace=~\"$namespace\", sp_realm_id=~\"$realm\", sp_spec_id=~\"$app\", sp_proxy_id=\"$id\", sp_proxy_id!=\"\"} | line_format `[App]: {{ __line__ }}` ",
+          "expr": "{sp_realm_id=~\".+\", namespace=~\"$namespace\", sp_realm_id=~\"$realm\", sp_proxy_id=\"$id\", sp_proxy_id!=\"\"} | line_format `[App]: {{ __line__ }}` ",
           "legendFormat": "",
           "refId": "A"
         },
diff --git a/src/test/kotlin/eu/openanalytics/shinyproxyoperator/impl/docker/MainIntegrationTest.kt b/src/test/kotlin/eu/openanalytics/shinyproxyoperator/impl/docker/MainIntegrationTest.kt
@@ -548,21 +548,26 @@ class MainIntegrationTest : IntegrationTestBase() {
             dockerAssertions.assertShinyProxyContainer(shinyProxyContainer1, shinyProxyInstance1)
             dockerAssertions.assertShinyProxyContainer(shinyProxyContainer2, shinyProxyInstance2)
 
+            // LOKI DRIVER
+            val containerInfo1 = dockerClient.inspectContainer(shinyProxyContainer1.id())
+            assertEquals("loki", containerInfo1.hostConfig().logConfig().logType())
+            assertEquals("http://localhost:3100/loki/api/v1/push", containerInfo1.hostConfig().logConfig().logOptions()["loki-url"])
+            assertEquals("non-blocking", containerInfo1.hostConfig().logConfig().logOptions()["mode"])
+            assertEquals("sp_realm_id=default-realm1,sp_instance=${hash1},namespace=default,app=shinyproxy", containerInfo1.hostConfig().logConfig().logOptions()["loki-external-labels"])
+
+            val containerInfo2 = dockerClient.inspectContainer(shinyProxyContainer2.id())
+            assertEquals("loki", containerInfo2.hostConfig().logConfig().logType())
+            assertEquals("http://localhost:3100/loki/api/v1/push", containerInfo2.hostConfig().logConfig().logOptions()["loki-url"])
+            assertEquals("non-blocking", containerInfo2.hostConfig().logConfig().logOptions()["mode"])
+            assertEquals("sp_realm_id=default-realm2,sp_instance=${hash2},namespace=default,app=shinyproxy", containerInfo2.hostConfig().logConfig().logOptions()["loki-external-labels"])
+
             // CADVISOR
             val cadvisorContainer = inspectContainer(getContainerByName("sp-cadvisor"))
             assertNotNull(cadvisorContainer)
             assertEquals(true, cadvisorContainer.state().running())
             assertEquals("sp-shared-network", cadvisorContainer.hostConfig().networkMode())
             assertEquals("always", cadvisorContainer.hostConfig().restartPolicy().name())
 
-            // GRAFANA-ALLOY
-            val alloyContainer = inspectContainer(getContainerByName("sp-grafana-alloy"))
-            assertNotNull(alloyContainer)
-            assertEquals(true, alloyContainer.state().running())
-            assertEquals("sp-shared-network", alloyContainer.hostConfig().networkMode())
-            assertEquals("always", alloyContainer.hostConfig().restartPolicy().name())
-            assertNotNull(dataDir.resolve("sp-grafana-alloy/config.alloy").readText())
-
             // GRAFANA
             val grafanaContainer = inspectContainer(getContainerByName("sp-grafana-grafana-default-realm1"))
             assertNotNull(grafanaContainer)
