[ETCM-528] block creation metrics (#904)

Author: Jaap van der Plas

docker/monitoring/grafana/provisioning/dashboards/mantis-dashboard.json

@@ -0,0 +1,11 @@
+package io.iohk.ethereum.consensus
+
+import io.iohk.ethereum.metrics.MetricsContainer
+
+object ConsensusMetrics extends MetricsContainer {
+  private final val blockGenTimer = "consensus.blocks.generate.timer"
+  final val EthashBlockGeneratorTiming = metrics.timer(blockGenTimer, "class", "EthashBlockGenerator")
+  final val RestrictedEthashBlockGeneratorTiming =
+    metrics.timer(blockGenTimer, "class", "RestrictedEthashBlockGenerator")
+  final val NoOmmersBlockGeneratorTiming = metrics.timer(blockGenTimer, "class", "NoOmmersBlockGenerator")
+}

src/main/scala/io/iohk/ethereum/consensus/ConsensusMetrics.scala

@@ -5,6 +5,7 @@ import io.iohk.ethereum.consensus.difficulty.DifficultyCalculator
 import io.iohk.ethereum.domain._
 import io.iohk.ethereum.ledger.{BlockPreparator, InMemoryWorldStateProxy}
 import io.iohk.ethereum.utils.BlockchainConfig
+import io.iohk.ethereum.consensus.ConsensusMetrics
 
 abstract class NoOmmersBlockGenerator(
     blockchain: Blockchain,
@@ -44,8 +45,7 @@ abstract class NoOmmersBlockGenerator(
       beneficiary: Address,
       x: Nil.type,
       initialWorldStateBeforeExecution: Option[InMemoryWorldStateProxy]
-  ): PendingBlockAndState = {
-
+  ): PendingBlockAndState = ConsensusMetrics.NoOmmersBlockGeneratorTiming.record { () =>
     val pHeader = parent.header
     val blockNumber = pHeader.number + 1
 

src/main/scala/io/iohk/ethereum/consensus/blocks/NoOmmersBlockGenerator.scala

@@ -10,6 +10,7 @@ import io.iohk.ethereum.crypto.kec256
 import io.iohk.ethereum.domain._
 import io.iohk.ethereum.ledger.{BlockPreparator, InMemoryWorldStateProxy}
 import io.iohk.ethereum.utils.BlockchainConfig
+import io.iohk.ethereum.consensus.ConsensusMetrics
 
 /** Internal API, used for testing (especially mocks) */
 trait EthashBlockGenerator extends TestBlockGenerator {
@@ -73,7 +74,7 @@ class EthashBlockGeneratorImpl(
       beneficiary: Address,
       x: Ommers,
       initialWorldStateBeforeExecution: Option[InMemoryWorldStateProxy]
-  ): PendingBlockAndState = {
+  ): PendingBlockAndState = ConsensusMetrics.EthashBlockGeneratorTiming.record { () =>
     val pHeader = parent.header
     val blockNumber = pHeader.number + 1
     val parentHash = pHeader.hash

src/main/scala/io/iohk/ethereum/consensus/ethash/blocks/EthashBlockGenerator.scala

@@ -9,6 +9,7 @@ import io.iohk.ethereum.domain.{Address, Block, Blockchain, SignedTransaction}
 import io.iohk.ethereum.ledger.{BlockPreparator, InMemoryWorldStateProxy}
 import io.iohk.ethereum.utils.BlockchainConfig
 import org.bouncycastle.crypto.AsymmetricCipherKeyPair
+import io.iohk.ethereum.consensus.ConsensusMetrics
 
 class RestrictedEthashBlockGeneratorImpl(
     validators: ValidatorsExecutor,
@@ -35,7 +36,7 @@ class RestrictedEthashBlockGeneratorImpl(
       beneficiary: Address,
       ommers: Ommers,
       initialWorldStateBeforeExecution: Option[InMemoryWorldStateProxy]
-  ): PendingBlockAndState = {
+  ): PendingBlockAndState = ConsensusMetrics.RestrictedEthashBlockGeneratorTiming.record { () =>
     val pHeader = parent.header
     val blockNumber = pHeader.number + 1
     val parentHash = pHeader.hash

src/main/scala/io/iohk/ethereum/consensus/ethash/blocks/RestrictedEthashBlockGeneratorImpl.scala

@@ -1,6 +1,8 @@
 package io.iohk.ethereum.jsonrpc
 
 import io.iohk.ethereum.metrics.MetricsContainer
+import java.util.concurrent.TimeUnit
+import java.time.Duration
 
 case object JsonRpcControllerMetrics extends MetricsContainer {
 
@@ -9,10 +11,14 @@ case object JsonRpcControllerMetrics extends MetricsContainer {
     */
   final val NotFoundMethodsCounter = metrics.counter("json.rpc.notfound.calls.counter")
 
-  final val MethodsTimer = metrics.timer("json.rpc.methods.timer")
   final val MethodsSuccessCounter = metrics.counter("json.rpc.methods.success.counter")
   final val MethodsExceptionCounter = metrics.counter("json.rpc.methods.exception.counter")
   final val MethodsErrorCounter = metrics.counter("json.rpc.methods.error.counter")
 
   final val HealhcheckErrorCounter = metrics.counter("json.rpc.healthcheck.error.counter")
+
+  final val MethodsTimerName = "json.rpc.methods.timer"
+
+  def recordMethodTime(method: String, time: Duration): Unit =
+    metrics.timer("json.rpc.methods.timer", "method", method).record(time)
 }

src/main/scala/io/iohk/ethereum/jsonrpc/JsonRpcControllerMetrics.scala

@@ -17,6 +17,9 @@ import org.json4s.{DefaultFormats, native}
 import scala.collection.immutable.ArraySeq
 import scala.concurrent.ExecutionContext
 import scala.concurrent.duration.FiniteDuration
+import io.micrometer.core.instrument.Timer
+import io.micrometer.core.annotation.Timed
+import java.time.Duration
 
 trait ApisBase {
   def available: List[String]
@@ -67,9 +70,8 @@ trait JsonRpcBaseController {
           Task {
             JsonRpcControllerMetrics.MethodsSuccessCounter.increment()
 
-            val endTimeNanos = System.nanoTime()
-            val dtNanos = endTimeNanos - startTimeNanos
-            JsonRpcControllerMetrics.MethodsTimer.record(dtNanos, TimeUnit.NANOSECONDS)
+            val time = Duration.ofNanos(System.nanoTime() - startTimeNanos)
+            JsonRpcControllerMetrics.recordMethodTime(request.method, time)
           }
       }
       .onErrorRecoverWith { case t: Throwable =>

src/main/scala/io/iohk/ethereum/jsonrpc/server/controllers/JsonRpcBaseController.scala

@@ -54,9 +54,10 @@ case class Metrics(metricsPrefix: String, registry: MeterRegistry, serverPort: I
   /**
     * Returns a [[io.micrometer.core.instrument.Timer Timer]].
     */
-  def timer(name: String): Timer =
+  def timer(name: String, tags: String*): Timer =
     Timer
       .builder(mkName(name))
+      .tags(tags: _*)
       .register(registry)
 
   /**

src/main/scala/io/iohk/ethereum/metrics/Metrics.scala

@@ -625,7 +625,7 @@ class MerklePatriciaTrieSuite extends AnyFunSuite with ScalaCheckPropertyChecks
         val keyToFind = x._1
         val proof = trie.getProof(keyToFind)
         assert(proof.isDefined)
-        proof.map{ p =>
+        proof.map { p =>
           assert(verifyProof[Array[Byte], Array[Byte]](trie.getRootHash, keyToFind, p) == ValidProof)
         }
       })

src/test/scala/io/iohk/ethereum/mpt/MerklePatriciaTrieSuite.scala

@@ -23,7 +23,7 @@ object MptProofVerifier {
   )(implicit kSer: ByteArrayEncoder[K], vSer: ByteArraySerializable[V]): ProofVerifyResult = {
     val mptStore = mkStorage(proof)
     rebuildMpt(rootHash, mptStore)(kSer, vSer)
-      .flatMap( trie => getKey(key, trie) )
+      .flatMap(trie => getKey(key, trie))
       .fold(InvalidProof.apply, _ => ValidProof)
   }
 
@@ -39,12 +39,14 @@ object MptProofVerifier {
       kSer: ByteArrayEncoder[K],
       vSer: ByteArraySerializable[V]
   ): Either[MptProofError, MerklePatriciaTrie[K, V]] =
-    Either.catchNonFatal {
-      MerklePatriciaTrie[K, V](
-        rootHash = rootHash,
-        source = storage
-      )
-    }.leftMap(_ => MptProofError.UnableRebuildMpt)
+    Either
+      .catchNonFatal {
+        MerklePatriciaTrie[K, V](
+          rootHash = rootHash,
+          source = storage
+        )
+      }
+      .leftMap(_ => MptProofError.UnableRebuildMpt)
 
   private def getKey[V, K](key: K, trie: MerklePatriciaTrie[K, V]): Either[MptProofError, Option[V]] =
     Either