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

Update opentelemetry-api, ... to 1.11.0 #1833

Merged
merged 2 commits into from
Feb 8, 2022
Merged

Update opentelemetry-api, ... to 1.11.0 #1833

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cb3b3a9
Update opentelemetry-api, ... to 1.11.0
scala-steward Feb 4, 2022
2d78e1d
added test metrics dependency and adjusted code
kubinio123 Feb 8, 2022
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
5 changes: 3 additions & 2 deletions build.sbt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -637,8 +637,9 @@ lazy val opentelemetryMetrics: ProjectMatrix = (projectMatrix in file("metrics/o
.settings(
name := "tapir-opentelemetry-metrics",
libraryDependencies ++= Seq(
"io.opentelemetry" % "opentelemetry-api" % "1.9.1",
"io.opentelemetry" % "opentelemetry-sdk" % "1.9.1",
"io.opentelemetry" % "opentelemetry-api" % "1.11.0",
"io.opentelemetry" % "opentelemetry-sdk" % "1.11.0",
"io.opentelemetry" % "opentelemetry-sdk-metrics-testing" % "1.11.0-alpha" % Test,
"io.opentelemetry" % "opentelemetry-sdk-metrics" % "1.5.0-alpha" % Test,
scalaTest.value % Test
)
Expand Down
38 changes: 22 additions & 16 deletions ...ry-metrics/src/test/scala/sttp/tapir/metrics/opentelemetry/OpenTelemetryMetricsTest.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package sttp.tapir.metrics.opentelemetry
import io.opentelemetry.api.common.{AttributeKey, Attributes}
import io.opentelemetry.sdk.metrics.SdkMeterProvider
import io.opentelemetry.sdk.metrics.data.LongPointData
import io.opentelemetry.sdk.testing.exporter.InMemoryMetricReader
import org.scalatest.concurrent.PatienceConfiguration.Timeout
import org.scalatest.concurrent.ScalaFutures
import org.scalatest.flatspec.AnyFlatSpec
Expand All @@ -24,7 +25,8 @@ class OpenTelemetryMetricsTest extends AnyFlatSpec with Matchers {

"default metrics" should "collect requests total" in {
// given
val provider = SdkMeterProvider.builder().build()
val reader = InMemoryMetricReader.create()
val provider = SdkMeterProvider.builder().registerMetricReader(reader).build()
val meter = provider.get("tapir-instrumentation")
val serverEp = PersonsApi().serverEp
val metrics = OpenTelemetryMetrics[Id](meter).withRequestsTotal()
Expand All @@ -37,14 +39,15 @@ class OpenTelemetryMetricsTest extends AnyFlatSpec with Matchers {
interpreter.apply(PersonsApi.request("Janusz"), TestRequestBody)

// then
val point = longSumData(provider).head
val point = longSumData(reader).head
point.getAttributes shouldBe Attributes.of(AttributeKey.stringKey("method"), "GET", AttributeKey.stringKey("path"), "/person")
point.getValue shouldBe 3
}

"default metrics" should "collect requests active" in {
// given
val provider = SdkMeterProvider.builder().build()
val reader = InMemoryMetricReader.create()
val provider = SdkMeterProvider.builder().registerMetricReader(reader).build()
val meter = provider.get("tapir-instrumentation")
val serverEp = PersonsApi { name =>
Thread.sleep(900)
Expand All @@ -60,20 +63,21 @@ class OpenTelemetryMetricsTest extends AnyFlatSpec with Matchers {
Thread.sleep(100)

// then
val point = longSumData(provider).head
val point = longSumData(reader).head
point.getAttributes shouldBe Attributes.of(AttributeKey.stringKey("method"), "GET", AttributeKey.stringKey("path"), "/person")
point.getValue shouldBe 1

ScalaFutures.whenReady(response, Timeout(Span(1, Second))) { _ =>
val point = longSumData(provider).head
val point = longSumData(reader).head
point.getAttributes shouldBe Attributes.of(AttributeKey.stringKey("method"), "GET", AttributeKey.stringKey("path"), "/person")
point.getValue shouldBe 0
}
}

"default metrics" should "collect responses total" in {
// given
val provider = SdkMeterProvider.builder().build()
val reader = InMemoryMetricReader.create()
val provider = SdkMeterProvider.builder().registerMetricReader(reader).build()
val meter = provider.get("tapir-instrumentation")
val serverEp = PersonsApi().serverEp
val metrics = OpenTelemetryMetrics[Id](meter).withResponsesTotal()
Expand All @@ -91,7 +95,7 @@ class OpenTelemetryMetricsTest extends AnyFlatSpec with Matchers {
interpreter.apply(PersonsApi.request(""), TestRequestBody)

// then
longSumData(provider)
longSumData(reader)
.count {
case dp
if dp.getAttributes == Attributes.of(
Expand Down Expand Up @@ -119,7 +123,8 @@ class OpenTelemetryMetricsTest extends AnyFlatSpec with Matchers {

"default metrics" should "collect responses duration" in {
// given
val provider = SdkMeterProvider.builder().build()
val reader = InMemoryMetricReader.create()
val provider = SdkMeterProvider.builder().registerMetricReader(reader).build()
val meter = provider.get("tapir-instrumentation")
val waitServerEp: Int => ServerEndpoint[Any, Id] = millis => {
PersonsApi { name =>
Expand All @@ -143,7 +148,7 @@ class OpenTelemetryMetricsTest extends AnyFlatSpec with Matchers {
interpret(200)
interpret(300)

val point = provider.collectAllMetrics().asScala.head.getDoubleSummaryData.getPoints.asScala.head
val point = reader.collectAllMetrics().asScala.head.getDoubleHistogramData.getPoints.asScala.head
point.getAttributes shouldBe Attributes.of(
AttributeKey.stringKey("method"),
"GET",
Expand All @@ -152,14 +157,14 @@ class OpenTelemetryMetricsTest extends AnyFlatSpec with Matchers {
AttributeKey.stringKey("status"),
"2xx"
)
point.getPercentileValues.size() shouldBe 2
}

"default metrics" should "customize labels" in {
// given
val serverEp = PersonsApi().serverEp
val labels = MetricLabels(forRequest = Seq("key" -> { case (_, _) => "value" }), forResponse = Seq())
val provider = SdkMeterProvider.builder().build()
val reader = InMemoryMetricReader.create()
val provider = SdkMeterProvider.builder().registerMetricReader(reader).build()
val meter = provider.get("tapir-instrumentation")
val metrics = OpenTelemetryMetrics[Id](meter).withResponsesTotal(labels)
val interpreter =
Expand All @@ -169,13 +174,14 @@ class OpenTelemetryMetricsTest extends AnyFlatSpec with Matchers {
interpreter.apply(PersonsApi.request("Jacob"), TestRequestBody)

// then
val point = longSumData(provider).head
val point = longSumData(reader).head
point.getAttributes shouldBe Attributes.of(AttributeKey.stringKey("key"), "value")
}

"metrics" should "be collected on exception when response from exception handler" in {
val serverEp = PersonsApi { _ => throw new RuntimeException("Ups") }.serverEp
val provider = SdkMeterProvider.builder().build()
val reader = InMemoryMetricReader.create()
val provider = SdkMeterProvider.builder().registerMetricReader(reader).build()
val meter = provider.get("tapir-instrumentation")
val metrics = OpenTelemetryMetrics[Id](meter).withResponsesTotal()
val interpreter = new ServerInterpreter[Any, Id, String, NoStreams](
Expand All @@ -189,7 +195,7 @@ class OpenTelemetryMetricsTest extends AnyFlatSpec with Matchers {
interpreter.apply(PersonsApi.request("Jacob"), TestRequestBody)

// then
val point = longSumData(provider).head
val point = longSumData(reader).head
point.getAttributes shouldBe Attributes.of(
AttributeKey.stringKey("method"),
"GET",
Expand All @@ -201,6 +207,6 @@ class OpenTelemetryMetricsTest extends AnyFlatSpec with Matchers {
point.getValue shouldBe 1
}

private def longSumData(provider: SdkMeterProvider): List[LongPointData] =
provider.collectAllMetrics().asScala.head.getLongSumData.getPoints.asScala.toList
private def longSumData(reader: InMemoryMetricReader): List[LongPointData] =
reader.collectAllMetrics().asScala.head.getLongSumData.getPoints.asScala.toList
}