Moved objectives to a separate package

digital-asset · May 27, 2021 · 5054869 · 5054869
1 parent cac0eea
commit 5054869
Show file tree

Hide file tree

Showing 11 changed files with 39 additions and 26 deletions.
diff --git a/...ch-tool/src/main/scala/com/daml/ledger/api/benchtool/metrics/ConsumptionSpeedMetric.scala b/...ch-tool/src/main/scala/com/daml/ledger/api/benchtool/metrics/ConsumptionSpeedMetric.scala
@@ -4,6 +4,7 @@
 package com.daml.ledger.api.benchtool.metrics
 
 import com.daml.ledger.api.benchtool.metrics.Metric.rounded
+import com.daml.ledger.api.benchtool.metrics.objectives.ServiceLevelObjective
 import com.google.protobuf.timestamp.Timestamp
 
 import java.time.Instant
@@ -116,15 +117,4 @@ object ConsumptionSpeedMetric {
     }
   }
 
-  // TODO: add warm-up parameter
-  final case class MinConsumptionSpeed(minSpeed: Double) extends ServiceLevelObjective[Value] {
-    override def isViolatedBy(metricValue: Value): Boolean =
-      Ordering[Value].lt(metricValue, v)
-
-    override def formatted: String =
-      s"min allowed speed: $minSpeed [-]"
-
-    private val v = Value(Some(minSpeed))
-  }
-
 }
diff --git a/...ger-api-bench-tool/src/main/scala/com/daml/ledger/api/benchtool/metrics/DelayMetric.scala b/...ger-api-bench-tool/src/main/scala/com/daml/ledger/api/benchtool/metrics/DelayMetric.scala
@@ -3,6 +3,7 @@
 
 package com.daml.ledger.api.benchtool.metrics
 
+import com.daml.ledger.api.benchtool.metrics.objectives.ServiceLevelObjective
 import com.google.protobuf.timestamp.Timestamp
 
 import java.time.{Clock, Duration, Instant}

diff --git a/...r/ledger-api-bench-tool/src/main/scala/com/daml/ledger/api/benchtool/metrics/Metric.scala b/...r/ledger-api-bench-tool/src/main/scala/com/daml/ledger/api/benchtool/metrics/Metric.scala
@@ -3,6 +3,8 @@
 
 package com.daml.ledger.api.benchtool.metrics
 
+import com.daml.ledger.api.benchtool.metrics.objectives.ServiceLevelObjective
+
 trait Metric[Elem] {
 
   type V <: MetricValue

diff --git a/...-bench-tool/src/main/scala/com/daml/ledger/api/benchtool/metrics/TransactionMetrics.scala b/...-bench-tool/src/main/scala/com/daml/ledger/api/benchtool/metrics/TransactionMetrics.scala
@@ -6,6 +6,7 @@ package com.daml.ledger.api.benchtool.metrics
 import akka.actor.typed.{ActorRef, ActorSystem, Props, SpawnProtocol}
 import akka.util.Timeout
 import com.daml.ledger.api.benchtool.Config.StreamConfig.Objectives
+import com.daml.ledger.api.benchtool.metrics.objectives.{MaxDelay, MinConsumptionSpeed}
 import com.daml.ledger.api.v1.transaction_service.{
   GetTransactionTreesResponse,
   GetTransactionsResponse,
@@ -101,7 +102,7 @@ object TransactionMetrics {
     val delayObjectives =
       objectives.maxDelaySeconds.map(MaxDelay).toList
     val consumptionSpeedObjectives =
-      objectives.minConsumptionSpeed.map(ConsumptionSpeedMetric.MinConsumptionSpeed).toList
+      objectives.minConsumptionSpeed.map(MinConsumptionSpeed).toList
     List[Metric[T]](
       CountMetric.empty[T](reportingPeriodMillis, countingFunction),
       SizeMetric.empty[T](reportingPeriodMillis, sizingFunction),

diff --git a/...dger/api/benchtool/metrics/MaxDelay.scala → ...nchtool/metrics/objectives/MaxDelay.scala b/...dger/api/benchtool/metrics/MaxDelay.scala → ...nchtool/metrics/objectives/MaxDelay.scala
@@ -1,7 +1,9 @@
 // Copyright (c) 2021 Digital Asset (Switzerland) GmbH and/or its affiliates. All rights reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-package com.daml.ledger.api.benchtool.metrics
+package com.daml.ledger.api.benchtool.metrics.objectives
+
+import com.daml.ledger.api.benchtool.metrics.DelayMetric
 
 final case class MaxDelay(maxDelaySeconds: Long) extends ServiceLevelObjective[DelayMetric.Value] {
   override def isViolatedBy(metricValue: DelayMetric.Value): Boolean =

diff --git a/...src/main/scala/com/daml/ledger/api/benchtool/metrics/objectives/MinConsumptionSpeed.scala b/...src/main/scala/com/daml/ledger/api/benchtool/metrics/objectives/MinConsumptionSpeed.scala
@@ -0,0 +1,18 @@
+// Copyright (c) 2021 Digital Asset (Switzerland) GmbH and/or its affiliates. All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+package com.daml.ledger.api.benchtool.metrics.objectives
+
+import com.daml.ledger.api.benchtool.metrics.ConsumptionSpeedMetric
+
+// TODO: add warm-up parameter
+final case class MinConsumptionSpeed(minSpeed: Double)
+    extends ServiceLevelObjective[ConsumptionSpeedMetric.Value] {
+  override def isViolatedBy(metricValue: ConsumptionSpeedMetric.Value): Boolean =
+    Ordering[ConsumptionSpeedMetric.Value].lt(metricValue, v)
+
+  override def formatted: String =
+    s"min allowed speed: $minSpeed [-]"
+
+  private val v = ConsumptionSpeedMetric.Value(Some(minSpeed))
+}
diff --git a/...htool/metrics/ServiceLevelObjective.scala → ...cs/objectives/ServiceLevelObjective.scala b/...htool/metrics/ServiceLevelObjective.scala → ...cs/objectives/ServiceLevelObjective.scala
@@ -1,7 +1,9 @@
 // Copyright (c) 2021 Digital Asset (Switzerland) GmbH and/or its affiliates. All rights reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-package com.daml.ledger.api.benchtool.metrics
+package com.daml.ledger.api.benchtool.metrics.objectives
+
+import com.daml.ledger.api.benchtool.metrics.MetricValue
 
 trait ServiceLevelObjective[MetricValueType <: MetricValue] {
   def isViolatedBy(metricValue: MetricValueType): Boolean

diff --git a/...c/test/suite/scala/com/daml/ledger/api/benchtool/metrics/ConsumptionSpeedMetricSpec.scala b/...c/test/suite/scala/com/daml/ledger/api/benchtool/metrics/ConsumptionSpeedMetricSpec.scala
@@ -4,12 +4,12 @@
 package com.daml.ledger.api.benchtool
 
 import com.daml.ledger.api.benchtool.metrics.ConsumptionSpeedMetric
+import com.daml.ledger.api.benchtool.metrics.objectives.MinConsumptionSpeed
 import com.google.protobuf.timestamp.Timestamp
 import org.scalatest.matchers.should.Matchers
 import org.scalatest.wordspec.AnyWordSpec
 
 import java.time.{Clock, Instant}
-
 import scala.language.existentials
 
 class ConsumptionSpeedMetricSpec extends AnyWordSpec with Matchers {
@@ -250,7 +250,7 @@ class ConsumptionSpeedMetricSpec extends AnyWordSpec with Matchers {
         )
       )
 
-      val objective = ConsumptionSpeedMetric.MinConsumptionSpeed(minAllowedSpeed)
+      val objective = MinConsumptionSpeed(minAllowedSpeed)
       val metric: ConsumptionSpeedMetric[String] =
         ConsumptionSpeedMetric.empty[String](
           periodMillis = periodMillis,

diff --git a/...nch-tool/src/test/suite/scala/com/daml/ledger/api/benchtool/metrics/DelayMetricSpec.scala b/...nch-tool/src/test/suite/scala/com/daml/ledger/api/benchtool/metrics/DelayMetricSpec.scala
@@ -3,13 +3,13 @@
 
 package com.daml.ledger.api.benchtool
 
-import com.daml.ledger.api.benchtool.metrics.{DelayMetric, MaxDelay}
+import com.daml.ledger.api.benchtool.metrics.DelayMetric
+import com.daml.ledger.api.benchtool.metrics.objectives.MaxDelay
 import com.google.protobuf.timestamp.Timestamp
 import org.scalatest.matchers.should.Matchers
 import org.scalatest.wordspec.AnyWordSpec
 
 import java.time.{Clock, Duration, Instant, ZoneId}
-
 import scala.language.existentials
 
 class DelayMetricSpec extends AnyWordSpec with Matchers {

diff --git a/...-tool/src/test/suite/scala/com/daml/ledger/api/benchtool/metrics/MetricsManagerSpec.scala b/...-tool/src/test/suite/scala/com/daml/ledger/api/benchtool/metrics/MetricsManagerSpec.scala
@@ -12,12 +12,8 @@ import akka.actor.testkit.typed.scaladsl.{
 }
 import akka.actor.typed.{ActorRef, Behavior}
 import com.daml.ledger.api.benchtool.metrics.MetricsManager.Message
-import com.daml.ledger.api.benchtool.metrics.{
-  Metric,
-  MetricValue,
-  MetricsManager,
-  ServiceLevelObjective,
-}
+import com.daml.ledger.api.benchtool.metrics.objectives.ServiceLevelObjective
+import com.daml.ledger.api.benchtool.metrics.{Metric, MetricValue, MetricsManager}
 import org.scalatest.wordspec.AnyWordSpecLike
 
 import scala.concurrent.duration._

diff --git a/...rc/test/suite/scala/com/daml/ledger/api/benchtool/metrics/ServiceLevelObjectiveSpec.scala b/...rc/test/suite/scala/com/daml/ledger/api/benchtool/metrics/ServiceLevelObjectiveSpec.scala
@@ -3,7 +3,8 @@
 
 package com.daml.ledger.api.benchtool
 
-import com.daml.ledger.api.benchtool.metrics.{ConsumptionSpeedMetric, DelayMetric, MaxDelay}
+import com.daml.ledger.api.benchtool.metrics.objectives.{MaxDelay, MinConsumptionSpeed}
+import com.daml.ledger.api.benchtool.metrics.{ConsumptionSpeedMetric, DelayMetric}
 import org.scalatest.matchers.should.Matchers
 import org.scalatest.prop.TableDrivenPropertyChecks
 import org.scalatest.wordspec.AnyWordSpec
@@ -54,7 +55,7 @@ class ServiceLevelObjectiveSpec extends AnyWordSpec with Matchers with TableDriv
     "correctly report violation" in {
       import ConsumptionSpeedMetric.Value
       val objectiveSpeed = Random.nextDouble()
-      val objective = ConsumptionSpeedMetric.MinConsumptionSpeed(objectiveSpeed)
+      val objective = MinConsumptionSpeed(objectiveSpeed)
       val lowerSpeed = objectiveSpeed - 1.0
       val higherSpeed = objectiveSpeed + 1.0
       val cases = Table(