Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix prometheus label ordering #268

Merged
merged 1 commit into from
May 19, 2022
Merged

Fix prometheus label ordering #268

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions core/src/main/scala/fr/davit/akka/http/metrics/core/HttpMetricsRegistry.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,11 @@ abstract class HttpMetricsRegistry(settings: HttpMetricsSettings) extends HttpMe
builder.result()
}

protected def requestDimensions(request: HttpRequest): Seq[Dimension] = {
private def requestDimensions(request: HttpRequest): Seq[Dimension] = {
requestLabelers.map(_.dimension(request))
}

protected def responseDimensions(response: HttpResponse): Seq[Dimension] = {
private def responseDimensions(response: HttpResponse): Seq[Dimension] = {
responseLabelers.map(_.dimension(response))
}

Expand Down
40 changes: 16 additions & 24 deletions prometheus/src/main/scala/fr/davit/akka/http/metrics/prometheus/PrometheusRegistry.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@

package fr.davit.akka.http.metrics.prometheus

import akka.http.scaladsl.model.{HttpRequest, HttpResponse}
import fr.davit.akka.http.metrics.core._
import fr.davit.akka.http.metrics.prometheus.Quantiles.Quantile
import io.prometheus.client.CollectorRegistry
Expand Down Expand Up @@ -58,43 +57,36 @@ class PrometheusRegistry(settings: PrometheusSettings, val underlying: Collector
private val pathDimension = if (settings.includePathDimension) Some(PathLabeler.name) else None
private val statusDimension = if (settings.includeStatusDimension) Some(StatusGroupLabeler.name) else None

private val serverDimensions = settings.serverDimensions.map(_.name)
private val customRequestDimensions = settings.customDimensions.collect { case l: HttpRequestLabeler => l.name }
private val customResponseDimensions = settings.customDimensions.collect { case l: HttpResponseLabeler => l.name }

private val requestsDimensions =
(serverDimensions ++ methodDimension ++ customRequestDimensions).sorted
private val responsesDimensions =
(requestsDimensions ++ pathDimension ++ statusDimension ++ customResponseDimensions).sorted
private[prometheus] val serverDimensions = settings.serverDimensions.map(_.name)

override protected def requestDimensions(request: HttpRequest): Seq[Dimension] =
super.requestDimensions(request).sorted
private val customRequestDimensions = settings.customDimensions.collect { case l: HttpRequestLabeler => l.name }
private[prometheus] val requestsDimensions = (methodDimension ++ customRequestDimensions).toSeq

override protected def responseDimensions(response: HttpResponse): Seq[Dimension] =
super.responseDimensions(response).sorted
private val customResponseDimensions = settings.customDimensions.collect { case l: HttpResponseLabeler => l.name }
private[prometheus] val responsesDimensions = (statusDimension ++ pathDimension ++ customResponseDimensions).toSeq

lazy val requests: Counter = io.prometheus.client.Counter
.build()
.namespace(settings.namespace)
.name(settings.metricsNames.requests)
.help("Total HTTP requests")
.labelNames(requestsDimensions: _*)
.labelNames(serverDimensions ++ requestsDimensions: _*)
.register(underlying)

lazy val requestsActive: Gauge = io.prometheus.client.Gauge
.build()
.namespace(settings.namespace)
.name(settings.metricsNames.requestsActive)
.help("Active HTTP requests")
.labelNames(requestsDimensions: _*)
.labelNames(serverDimensions ++ requestsDimensions: _*)
.register(underlying)

lazy val requestsFailures: Counter = io.prometheus.client.Counter
.build()
.namespace(settings.namespace)
.name(settings.metricsNames.requestsFailures)
.help("Total unserved requests")
.labelNames(requestsDimensions: _*)
.labelNames(serverDimensions ++ requestsDimensions: _*)
.register(underlying)

lazy val requestsSize: Histogram = {
Expand All @@ -106,7 +98,7 @@ class PrometheusRegistry(settings: PrometheusSettings, val underlying: Collector
.namespace(settings.namespace)
.name(settings.metricsNames.requestsSize)
.help(help)
.labelNames(requestsDimensions: _*)
.labelNames(serverDimensions ++ requestsDimensions: _*)
.quantiles(qs: _*)
.maxAgeSeconds(maxAge.toSeconds)
.ageBuckets(ageBuckets)
Expand All @@ -118,7 +110,7 @@ class PrometheusRegistry(settings: PrometheusSettings, val underlying: Collector
.namespace(settings.namespace)
.name(settings.metricsNames.requestsSize)
.help(help)
.labelNames(requestsDimensions: _*)
.labelNames(serverDimensions ++ requestsDimensions: _*)
.buckets(bs: _*)
.register(underlying)
}
Expand All @@ -129,15 +121,15 @@ class PrometheusRegistry(settings: PrometheusSettings, val underlying: Collector
.namespace(settings.namespace)
.name(settings.metricsNames.responses)
.help("HTTP responses")
.labelNames(responsesDimensions: _*)
.labelNames(serverDimensions ++ requestsDimensions ++ responsesDimensions: _*)
.register(underlying)

lazy val responsesErrors: Counter = io.prometheus.client.Counter
.build()
.namespace(settings.namespace)
.name(settings.metricsNames.responsesErrors)
.help("Total HTTP errors")
.labelNames(responsesDimensions: _*)
.labelNames(serverDimensions ++ requestsDimensions ++ responsesDimensions: _*)
.register(underlying)

lazy val responsesDuration: Timer = {
Expand All @@ -150,7 +142,7 @@ class PrometheusRegistry(settings: PrometheusSettings, val underlying: Collector
.namespace(settings.namespace)
.name(settings.metricsNames.responsesDuration)
.help(help)
.labelNames(responsesDimensions: _*)
.labelNames(serverDimensions ++ requestsDimensions ++ responsesDimensions: _*)
.quantiles(qs: _*)
.maxAgeSeconds(maxAge.toSeconds)
.ageBuckets(ageBuckets)
Expand All @@ -161,7 +153,7 @@ class PrometheusRegistry(settings: PrometheusSettings, val underlying: Collector
.namespace(settings.namespace)
.name(settings.metricsNames.responsesDuration)
.help(help)
.labelNames(responsesDimensions: _*)
.labelNames(serverDimensions ++ requestsDimensions ++ responsesDimensions: _*)
.buckets(bs: _*)
.register(underlying)
}
Expand All @@ -177,7 +169,7 @@ class PrometheusRegistry(settings: PrometheusSettings, val underlying: Collector
.namespace(settings.namespace)
.name(settings.metricsNames.responsesSize)
.help(help)
.labelNames(responsesDimensions: _*)
.labelNames(serverDimensions ++ requestsDimensions ++ responsesDimensions: _*)
.quantiles(qs: _*)
.maxAgeSeconds(maxAge.toSeconds)
.ageBuckets(ageBuckets)
Expand All @@ -189,7 +181,7 @@ class PrometheusRegistry(settings: PrometheusSettings, val underlying: Collector
.namespace(settings.namespace)
.name(settings.metricsNames.responsesSize)
.help(help)
.labelNames(responsesDimensions: _*)
.labelNames(serverDimensions ++ requestsDimensions ++ responsesDimensions: _*)
.buckets(bs: _*)
.register(underlying)
}
Expand Down
85 changes: 51 additions & 34 deletions prometheus/src/test/scala/fr/davit/akka/http/metrics/prometheus/PrometheusRegistrySpec.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,6 @@ import scala.concurrent.duration._

class PrometheusRegistrySpec extends AnyFlatSpec with Matchers {

import PrometheusRegistry._

object CustomRequestLabeler extends HttpRequestLabeler {
override def name = "custom_request_dim"
def label = "custom_request_label"
Expand All @@ -40,20 +38,18 @@ class PrometheusRegistrySpec extends AnyFlatSpec with Matchers {
override def label(response: HttpResponse): String = label
}

val serverDimensions = List(Dimension("server_dim", "server_label"))
val customRequestDimensions = List(Dimension(CustomRequestLabeler.name, CustomRequestLabeler.label))
val customResponseDimensions = List(Dimension(CustomResponseLabeler.name, CustomResponseLabeler.label))

val requestsDimensions = (
serverDimensions ++
customRequestDimensions ++
List(Dimension(MethodLabeler.name, "GET"))
).sorted
val responsesDimensions = (
requestsDimensions ++
customResponseDimensions ++
List(Dimension(PathLabeler.name, "/api"), Dimension(StatusGroupLabeler.name, "2xx"))
).sorted
val serverDimensions = List(
Dimension("server_dim", "server_label")
)
val requestsDimensions = List(
Dimension(MethodLabeler.name, "GET"),
Dimension(CustomRequestLabeler.name, CustomRequestLabeler.label)
)
val responsesDimensions = List(
Dimension(StatusGroupLabeler.name, "2xx"),
Dimension(PathLabeler.name, "/api"),
Dimension(CustomResponseLabeler.name, CustomResponseLabeler.label)
)

trait Fixture {

Expand Down Expand Up @@ -105,6 +101,18 @@ class PrometheusRegistrySpec extends AnyFlatSpec with Matchers {
)
}

it should "not have any dimensions by default" in new Fixture {
registry.serverDimensions shouldBe empty
registry.requestsDimensions shouldBe empty
registry.responsesDimensions shouldBe empty
}

it should "add proper dimensions when configured" in new DimensionFixture {
registry.serverDimensions should contain theSameElementsInOrderAs serverDimensions.map(_.name)
registry.requestsDimensions should contain theSameElementsInOrderAs requestsDimensions.map(_.name)
registry.responsesDimensions should contain theSameElementsInOrderAs responsesDimensions.map(_.name)
}

it should "set requestsActive metrics in the underlying registry" in new Fixture {
registry.requestsActive.inc()
underlyingCounterValue("akka_http_requests_active") shouldBe 1L
Expand All @@ -116,8 +124,9 @@ class PrometheusRegistrySpec extends AnyFlatSpec with Matchers {
}

it should "set requestsActive metrics in the underlying registry with dimensions" in new DimensionFixture {
registry.requestsActive.inc(requestsDimensions)
underlyingCounterValue("akka_http_requests_active", requestsDimensions) shouldBe 1L
val dim = serverDimensions ++ requestsDimensions
registry.requestsActive.inc(dim)
underlyingCounterValue("akka_http_requests_active", dim) shouldBe 1L
}

it should "set requests metrics in the underlying registry" in new Fixture {
Expand All @@ -131,8 +140,9 @@ class PrometheusRegistrySpec extends AnyFlatSpec with Matchers {
}

it should "set requests metrics in the underlying registry with dimensions" in new DimensionFixture {
registry.requests.inc(requestsDimensions)
underlyingCounterValue("akka_http_requests_total", requestsDimensions) shouldBe 1L
val dims = serverDimensions ++ requestsDimensions
registry.requests.inc(dims)
underlyingCounterValue("akka_http_requests_total", dims) shouldBe 1L
}

it should "set requestsSize metrics in the underlying registry" in new Fixture {
Expand All @@ -146,8 +156,9 @@ class PrometheusRegistrySpec extends AnyFlatSpec with Matchers {
}

it should "set requestsSize metrics in the underlying registry with dimensions" in new DimensionFixture {
registry.requestsSize.update(3, requestsDimensions)
underlyingHistogramValue("akka_http_requests_size_bytes", requestsDimensions) shouldBe 3L
val dims = serverDimensions ++ requestsDimensions
registry.requestsSize.update(3, dims)
underlyingHistogramValue("akka_http_requests_size_bytes", dims) shouldBe 3L
}

it should "set responses metrics in the underlying registry" in new Fixture {
Expand All @@ -161,8 +172,9 @@ class PrometheusRegistrySpec extends AnyFlatSpec with Matchers {
}

it should "set responses metrics in the underlying registry with dimensions" in new DimensionFixture {
registry.responses.inc(responsesDimensions)
underlyingCounterValue("akka_http_responses_total", responsesDimensions) shouldBe 1L
val dims = serverDimensions ++ requestsDimensions ++ responsesDimensions
registry.responses.inc(dims)
underlyingCounterValue("akka_http_responses_total", dims) shouldBe 1L
}

it should "set responsesErrors metrics in the underlying registry" in new Fixture {
Expand All @@ -176,8 +188,9 @@ class PrometheusRegistrySpec extends AnyFlatSpec with Matchers {
}

it should "set responsesErrors metrics in the underlying registry with dimensions" in new DimensionFixture {
registry.responsesErrors.inc(responsesDimensions)
underlyingCounterValue("akka_http_responses_errors_total", responsesDimensions) shouldBe 1L
val dims = serverDimensions ++ requestsDimensions ++ responsesDimensions
registry.responsesErrors.inc(dims)
underlyingCounterValue("akka_http_responses_errors_total", dims) shouldBe 1L
}

it should "set responsesDuration metrics in the underlying registry" in new Fixture {
Expand All @@ -191,8 +204,9 @@ class PrometheusRegistrySpec extends AnyFlatSpec with Matchers {
}

it should "set responsesDuration metrics in the underlying registry with dimension" in new DimensionFixture {
registry.responsesDuration.observe(3.seconds, responsesDimensions)
underlyingHistogramValue("akka_http_responses_duration_seconds", responsesDimensions) shouldBe 3.0
val dims = serverDimensions ++ requestsDimensions ++ responsesDimensions
registry.responsesDuration.observe(3.seconds, dims)
underlyingHistogramValue("akka_http_responses_duration_seconds", dims) shouldBe 3.0
}

it should "set responsesSize metrics in the underlying registry" in new Fixture {
Expand All @@ -206,8 +220,9 @@ class PrometheusRegistrySpec extends AnyFlatSpec with Matchers {
}

it should "set responsesSize metrics in the underlying registry with dimensions" in new DimensionFixture {
registry.responsesSize.update(3, responsesDimensions)
underlyingHistogramValue("akka_http_responses_size_bytes", responsesDimensions) shouldBe 3L
val dims = serverDimensions ++ requestsDimensions ++ responsesDimensions
registry.responsesSize.update(3, dims)
underlyingHistogramValue("akka_http_responses_size_bytes", dims) shouldBe 3L
}

it should "set connectionsActive metrics in the underlying registry" in new Fixture {
Expand All @@ -221,8 +236,9 @@ class PrometheusRegistrySpec extends AnyFlatSpec with Matchers {
}

it should "set connectionsActive metrics in the underlying registry with dimensions" in new DimensionFixture {
registry.connectionsActive.inc(serverDimensions)
underlyingCounterValue("akka_http_connections_active", serverDimensions) shouldBe 1L
val dims = serverDimensions
registry.connectionsActive.inc(dims)
underlyingCounterValue("akka_http_connections_active", dims) shouldBe 1L
}

it should "set connections metrics in the underlying registry" in new Fixture {
Expand All @@ -236,7 +252,8 @@ class PrometheusRegistrySpec extends AnyFlatSpec with Matchers {
}

it should "set connections metrics in the underlying registry with dimensions" in new DimensionFixture {
registry.connections.inc(serverDimensions)
underlyingCounterValue("akka_http_connections_total", serverDimensions) shouldBe 1L
val dims = serverDimensions
registry.connections.inc(dims)
underlyingCounterValue("akka_http_connections_total", dims) shouldBe 1L
}
}