1.23.1 (#107)

* Catch and report exceptions on labels json deserialization
* Update ktor and logging jars
* Fix platform type issue
* Default Plain content types to charset UTF-8
* Replace explicit size check with .isNotEmpty() call
* Add charset to JSON values
* Add logging to --debug option

Makefile

@@ -1,4 +1,4 @@
-VERSION=1.23.0
+VERSION=1.23.1
 
 default: versioncheck
 

README.md

@@ -68,13 +68,13 @@ agent {
     {
       name: "App2 metrics"
       path: app2_metrics
-      labels: "{\"key3\": \"value3\", \"key4\": \"value4\"}"
+      labels: "{\"key3\": \"value3\", \"key4\": 4}"
       url: "http://app2.local:9100/metrics"
     },
     {
       name: "App3 metrics"
       path: app3_metrics
-      labels: "{\"key5\": \"value5\", \"key6\": \"value6\"}"
+      labels: "{\"key5\": \"value5\", \"key6\": 6}"
       url: "http://app3.local:9100/metrics"
     }
   ]
@@ -116,8 +116,8 @@ scrape_configs:
 The docker images are available via:
 
 ```bash
-docker pull pambrose/prometheus-proxy:1.23.0
-docker pull pambrose/prometheus-agent:1.23.0
+docker pull pambrose/prometheus-proxy:1.23.1
+docker pull pambrose/prometheus-agent:1.23.1
 ```
 
 Start a proxy container with:
@@ -126,15 +126,15 @@ Start a proxy container with:
 docker run --rm -p 8082:8082 -p 8092:8092 -p 50051:50051 -p 8080:8080 \
         --env ADMIN_ENABLED=true \
         --env METRICS_ENABLED=true \
-        pambrose/prometheus-proxy:1.23.0
+        pambrose/prometheus-proxy:1.23.1
 ```
 
 Start an agent container with:
 
 ```bash
 docker run --rm -p 8083:8083 -p 8093:8093 \
         --env AGENT_CONFIG='https://raw.githubusercontent.com/pambrose/prometheus-proxy/master/examples/simple.conf' \
-        pambrose/prometheus-agent:1.23.0
+        pambrose/prometheus-agent:1.23.1
 ```
 
 Using the config
@@ -152,7 +152,7 @@ is in your current directory, run an agent container with:
 docker run --rm -p 8083:8083 -p 8093:8093 \
     --mount type=bind,source="$(pwd)"/prom-agent.conf,target=/app/prom-agent.conf \
     --env AGENT_CONFIG=prom-agent.conf \
-    pambrose/prometheus-agent:1.23.0
+    pambrose/prometheus-agent:1.23.1
 ```
 
 **Note:** The `WORKDIR` of the proxy and agent images is `/app`, so make sure to use `/app` as the base directory in the
@@ -303,15 +303,15 @@ docker run --rm -p 8082:8082 -p 8092:8092 -p 50440:50440 -p 8080:8080 \
     --env PROXY_CONFIG=tls-no-mutual-auth.conf \
     --env ADMIN_ENABLED=true \
     --env METRICS_ENABLED=true \
-    pambrose/prometheus-proxy:1.23.0
+    pambrose/prometheus-proxy:1.23.1
 
 docker run --rm -p 8083:8083 -p 8093:8093 \
     --mount type=bind,source="$(pwd)"/testing/certs,target=/app/testing/certs \
     --mount type=bind,source="$(pwd)"/examples/tls-no-mutual-auth.conf,target=/app/tls-no-mutual-auth.conf \
     --env AGENT_CONFIG=tls-no-mutual-auth.conf \
     --env PROXY_HOSTNAME=mymachine.lan:50440 \
     --name docker-agent \
-    pambrose/prometheus-agent:1.23.0
+    pambrose/prometheus-agent:1.23.1
 ```
 
 **Note:** The `WORKDIR` of the proxy and agent images is `/app`, so make sure to use `/app` as the base directory in the

bin/docker-agent.sh

@@ -3,4 +3,4 @@
 docker run --rm -p 8083:8083 -p 8093:8093 \
   --env AGENT_CONFIG='https://raw.githubusercontent.com/pambrose/prometheus-proxy/master/examples/simple.conf' \
   --env PROXY_HOSTNAME=mymachine.lan \
-  pambrose/prometheus-agent:1.23.0
+  pambrose/prometheus-agent:1.23.1

bin/docker-proxy.sh

@@ -2,4 +2,4 @@
 
 docker run --rm -p 8082:8082 -p 8092:8092 -p 50051:50051 -p 8080:8080 \
   --env PROXY_CONFIG='https://raw.githubusercontent.com/pambrose/prometheus-proxy/master/examples/simple.conf' \
-  pambrose/prometheus-proxy:1.23.0
+  pambrose/prometheus-proxy:1.23.1

build.gradle.kts

@@ -30,13 +30,13 @@ plugins {
 }
 
 group = "io.prometheus"
-version = "1.23.0"
+version = "1.23.1"
 
 buildConfig {
   packageName("io.prometheus")
   buildConfigField("String", "APP_NAME", "\"${project.name}\"")
   buildConfigField("String", "APP_VERSION", "\"${project.version}\"")
-  buildConfigField("String", "APP_RELEASE_DATE", "\"11/29/2024\"")
+  buildConfigField("String", "APP_RELEASE_DATE", "\"12/09/2024\"")
   buildConfigField("long", "BUILD_TIME", "${System.currentTimeMillis()}L")
 }
 

etc/compose/proxy.yml

@@ -1,6 +1,6 @@
 prometheus-proxy:
   autoredeploy: true
-  image: 'pambrose/prometheus-proxy:1.23.0'
+  image: 'pambrose/prometheus-proxy:1.23.1'
   ports:
     - '8080:8080'
     - '8082:8082'

examples/myapps.conf

@@ -9,13 +9,13 @@ agent {
     {
       name: "App2 metrics"
       path: app2_metrics
-      labels: "{\"key3\": \"value3\", \"key4\": \"value4\"}"
+      labels: "{\"key3\": \"value3\", \"key4\": 4}"
       url: "http://app2.local:9100/metrics"
     },
     {
       name: "App3 metrics"
       path: app3_metrics
-      labels: "{\"key5\": \"value5\", \"key6\": \"value6\"}"
+      labels: "{\"key5\": \"value5\", \"key6\": 6}"
       url: "http://app3.local:9100/metrics"
     }
   ]

examples/simple.conf

@@ -17,14 +17,14 @@ agent {
     {
       name: "Proxy metrics"
       path: proxy_metrics
-      labels: "{\"key1\": \"value1\", \"key2\": \"value2\"}"
+      labels: "{\"key1\": \"value1\", \"key2\": 2}"
       url: "http://localhost:8082/metrics"
       //url: "http://"${?HOSTNAME}":8082/metrics"
     }
     {
       name: "Agent metrics"
       path: agent_metrics
-      labels: "{\"key3\": \"value3\", \"key4\": \"value4\"}"
+      labels: "{\"key3\": \"value3\", \"key4\": 4}"
       url: "http://localhost:8083/metrics"
       //url: "http://"${?HOSTNAME}":8083/metrics"
     }

gradle.properties

@@ -28,9 +28,9 @@ jettyVersion=10.0.24
 junitVersion=5.11.3
 kluentVersion=1.73
 kotlinVersion=2.1.0
-ktorVersion=3.0.1
+ktorVersion=3.0.2
 logbackVersion=1.5.12
-loggingVersion=7.0.0
+loggingVersion=7.0.3
 # Keep in sync with grpc
 tcnativeVersion=2.0.69.Final
 prometheusVersion=0.16.0
@@ -41,5 +41,5 @@ protocVersion=3.25.4
 serializationVersion=1.7.3
 slf4jVersion=2.0.13
 typesafeVersion=1.4.3
-utilsVersion=2.3.1
+utilsVersion=2.3.4
 zipkinVersion=6.0.3

src/main/kotlin/io/prometheus/Proxy.kt

@@ -28,6 +28,7 @@ import com.github.pambrose.common.time.format
 import com.github.pambrose.common.util.MetricsUtils.newMapHealthCheck
 import com.github.pambrose.common.util.getBanner
 import com.github.pambrose.common.util.isNotNull
+import com.github.pambrose.common.util.simpleClassName
 import com.google.common.base.Joiner
 import com.google.common.collect.EvictingQueue
 import io.github.oshai.kotlinlogging.KotlinLogging
@@ -127,7 +128,7 @@ class Proxy(
             listOf(
               toPlainText(),
               pathManager.toPlainText(),
-              if (recentReqs.size > 0) "\n${recentReqs.size} most recent requests:" else "",
+              if (recentReqs.isNotEmpty()) "\n${recentReqs.size} most recent requests:" else "",
               recentReqs.reversed().joinToString("\n"),
             ).joinToString("\n")
           },
@@ -255,8 +256,12 @@ class Proxy(
               put("hostName", JsonPrimitive(agentContexts.joinToString { it.hostName }))
 
               val labels = agentContextInfo.labels
-              val json = labels.toJsonElement()
-              json.jsonObject.forEach { (k, v) -> put(k, v) }
+              runCatching {
+                val json = labels.toJsonElement()
+                json.jsonObject.forEach { (k, v) -> put(k, v) }
+              }.onFailure { e ->
+                logger.warn { "Invalid JSON in labels value: $labels - ${e.simpleClassName}: ${e.message}" }
+              }
             } else {
               logger.warn { "No agent context info for path: $path" }
             }

src/main/kotlin/io/prometheus/agent/AgentGrpcService.kt

@@ -228,7 +228,7 @@ internal class AgentGrpcService(
           it.labels = labelsJson
         }
         .build()
-    return stub.registerPath(request)//.toDataClass()
+    return stub.registerPath(request)
       .apply {
         agent.markMsgSent()
         if (!valid)
@@ -246,7 +246,7 @@ internal class AgentGrpcService(
           it.agentId = agent.agentId
           it.path = path
         }.build()
-    return stub.unregisterPath(request)//.toDataClass()
+    return stub.unregisterPath(request)
       .apply {
         agent.markMsgSent()
         if (!valid)
@@ -260,7 +260,7 @@ internal class AgentGrpcService(
         if (agentId.isNotEmpty())
           runCatching {
             val request = HeartBeatRequest.newBuilder().also { it.agentId = agentId }.build()
-            stub.sendHeartBeat(request)//.toDataClass()
+            stub.sendHeartBeat(request)
               .apply {
                 agent.markMsgSent()
                 if (!valid) {
@@ -294,9 +294,8 @@ internal class AgentGrpcService(
           .readRequestsFromProxy(agentInfo)
           .collect { grpcRequest: ScrapeRequest ->
             // The actual fetch happens at the other end of the channel, not here.
-            val request = grpcRequest//.toDataClass()
-            logger.debug { "readRequestsFromProxy():\n$request" }
-            connectionContext.scrapeRequestsChannel.send { agentHttpService.fetchScrapeUrl(request) }
+            logger.debug { "readRequestsFromProxy():\n$grpcRequest" }
+            connectionContext.scrapeRequestsChannel.send { agentHttpService.fetchScrapeUrl(grpcRequest) }
             agent.scrapeRequestBacklogSize.incrementAndGet()
           }
       }
@@ -313,7 +312,7 @@ internal class AgentGrpcService(
 
       if (!scrapeResults.zipped) {
         logger.debug { "Writing non-chunked msg scrapeId: $scrapeId length: ${scrapeResults.contentAsText.length}" }
-        nonChunkedChannel.send(scrapeResults.toScrapeResponse()/*.toProto()*/)
+        nonChunkedChannel.send(scrapeResults.toScrapeResponse())
         agent.metrics { scrapeResultCount.labels(agent.launchId, "non-gzipped").inc() }
       } else {
         val zipped = scrapeResults.contentAsZipped
@@ -323,7 +322,7 @@ internal class AgentGrpcService(
 
         if (zipped.size < chunkContentSize) {
           logger.debug { "Writing zipped non-chunked msg scrapeId: $scrapeId length: ${zipped.size}" }
-          nonChunkedChannel.send(scrapeResults.toScrapeResponse() /*.toProto()*/)
+          nonChunkedChannel.send(scrapeResults.toScrapeResponse())
           agent.metrics { scrapeResultCount.labels(agent.launchId, "gzipped").inc() }
         } else {
           scrapeResults.toScrapeResponseHeader()
@@ -347,14 +346,14 @@ internal class AgentGrpcService(
             newScrapeResponseChunk(scrapeId, totalChunkCount, readByteCount, checksum, buffer)
               .also {
                 logger.debug { "Writing chunk $totalChunkCount for scrapeId: $scrapeId" }
-                chunkedChannel.send(it/*.toProto()*/)
+                chunkedChannel.send(it)
               }
           }
 
           newScrapeResponseSummary(scrapeId, totalChunkCount, totalByteCount, checksum)
             .also {
               logger.debug { "Writing summary totalChunkCount: $totalChunkCount for scrapeID: $scrapeId" }
-              chunkedChannel.send(it /*.toProto()*/)
+              chunkedChannel.send(it)
               agent.metrics { scrapeResultCount.labels(agent.launchId, "chunked").inc() }
             }
         }
@@ -376,9 +375,7 @@ internal class AgentGrpcService(
       CoroutineExceptionHandler { _, e ->
         if (agent.isRunning)
           Status.fromThrowable(e)
-            .apply {
-              logger.error { "Error in writeResponsesToProxyUntilDisconnected(): $code $description" }
-            }
+            .apply { logger.error { "Error in writeResponsesToProxyUntilDisconnected(): $code $description" } }
       }
 
     coroutineScope {

src/main/kotlin/io/prometheus/agent/AgentHttpService.kt

@@ -71,8 +71,8 @@ internal class AgentHttpService(
       val url = pathContext.url + decodeParams(scrapeRequest.encodedQueryParams)
       logger.debug { "Fetching $pathContext ${if (url.isNotBlank()) "URL: $url" else ""}" }
 
+      // Content is fetched here
       try {
-        // Content is fetched here
         fetchContent(url, scrapeRequest, scrapeResults)
       } finally {
         requestTimer?.observeDuration()
@@ -132,6 +132,8 @@ internal class AgentHttpService(
     with(scrapeResults) {
       if (response.status.isSuccess()) {
         contentType = response.headers[CONTENT_TYPE].orEmpty()
+        if (agent.options.debugEnabled)
+          logger.info { "CT check - setScrapeDetailsAndDebugInfo() contentType: $contentType" }
         // Zip the content here
         val content = response.bodyAsText()
         zipped = content.length > agent.configVals.agent.minGzipSizeBytes

src/main/kotlin/io/prometheus/agent/AgentPathManager.kt

@@ -75,7 +75,7 @@ internal class AgentPathManager(
     val labelsJson = labels.defaultEmptyJsonObject()
     val pathId = agent.grpcService.registerPathOnProxy(path, labelsJson).pathId
     if (!agent.isTestMode)
-      logger.info { "Registered $url as /$path with labels: $labelsJson" }
+      logger.info { "Registered $url as /$path with labels $labelsJson" }
     pathContextMap[path] = PathContext(pathId, path, url, labelsJson)
   }
 

src/main/kotlin/io/prometheus/common/GrpcObjects.kt

@@ -64,7 +64,7 @@ internal object GrpcObjects {
           }
           .build()
       }
-      .build()
+      .build()!!
 
   fun newScrapeResponseSummary(
     scrapeId: Long,
@@ -86,5 +86,5 @@ internal object GrpcObjects {
             }
             .build()
       }
-      .build()
+      .build()!!
 }

src/main/kotlin/io/prometheus/common/ScrapeResults.kt

@@ -74,7 +74,7 @@ internal class ScrapeResults(
         it.failureReason = failureReason
         it.url = url
       }
-      .build()
+      .build()!!
 
   fun toScrapeResponseHeader() =
     ChunkedScrapeResponse
@@ -92,7 +92,7 @@ internal class ScrapeResults(
             it.headerContentType = contentType
           }
           .build()
-      }.build()
+      }.build()!!
 
   companion object {
     private val logger = KotlinLogging.logger {}

src/main/kotlin/io/prometheus/proxy/ProxyHttpConfig.kt

@@ -18,7 +18,7 @@ package io.prometheus.proxy
 
 import com.github.pambrose.common.util.simpleClassName
 import io.github.oshai.kotlinlogging.KotlinLogging
-import io.ktor.http.ContentType.Text.Plain
+import io.ktor.http.ContentType.Text
 import io.ktor.http.HttpHeaders
 import io.ktor.http.HttpStatusCode
 import io.ktor.http.HttpStatusCode.Companion.NotFound
@@ -105,7 +105,7 @@ internal object ProxyHttpConfig {
     }
 
     status(NotFound) { call, cause ->
-      call.respond(TextContent("${cause.value} ${cause.description}", Plain.withCharset(Charsets.UTF_8), cause))
+      call.respond(TextContent("${cause.value} ${cause.description}", Text.Plain.withCharset(Charsets.UTF_8), cause))
     }
   }
 }