[ETCM-573] Add metrics on block imports #919
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,12 @@ | ||
| package io.iohk.ethereum.sync | ||
|
|
||
| import com.typesafe.config.ConfigValueFactory | ||
| import io.iohk.ethereum.FreeSpecBase | ||
| import io.iohk.ethereum.metrics.{Metrics, MetricsConfig} | ||
| import io.iohk.ethereum.sync.util.RegularSyncItSpecUtils.FakePeer | ||
| import io.iohk.ethereum.sync.util.SyncCommonItSpec._ | ||
| import io.iohk.ethereum.utils.Config | ||
| import io.prometheus.client.CollectorRegistry | ||
| import monix.execution.Scheduler | ||
| import org.scalatest.BeforeAndAfterAll | ||
| import org.scalatest.matchers.should.Matchers | ||
|
|
@@ -12,6 +16,12 @@ import scala.concurrent.duration._ | |
| class RegularSyncItSpec extends FreeSpecBase with Matchers with BeforeAndAfterAll { | ||
| implicit val testScheduler = Scheduler.fixedPool("test", 16) | ||
|
|
||
| override def beforeAll(): Unit = { | ||
| Metrics.configure( | ||
| MetricsConfig(Config.config.withValue("metrics.enabled", ConfigValueFactory.fromAnyRef(true))) | ||
| ) | ||
| } | ||
|
|
||
| override def afterAll(): Unit = { | ||
| testScheduler.shutdown() | ||
| testScheduler.awaitTermination(120.second) | ||
|
|
@@ -20,12 +30,12 @@ class RegularSyncItSpec extends FreeSpecBase with Matchers with BeforeAndAfterAl | |
| "peer 2 should sync to the top of peer1 blockchain" - { | ||
| "given a previously imported blockchain" in customTestCaseResourceM(FakePeer.start2FakePeersRes()) { | ||
| case (peer1, peer2) => | ||
| val blockNumber: Int = 2000 | ||
| for { | ||
| _ <- peer1.importBlocksUntil(blockNumber)(IdentityUpdate) | ||
| _ <- peer2.startRegularSync() | ||
| _ <- peer2.connectToPeers(Set(peer1.node)) | ||
| _ <- peer2.waitForRegularSyncLoadLastBlock(blockNumber) | ||
| } yield { | ||
| assert(peer1.bl.getBestBlock().hash == peer2.bl.getBestBlock().hash) | ||
| } | ||
|
|
@@ -96,4 +106,39 @@ class RegularSyncItSpec extends FreeSpecBase with Matchers with BeforeAndAfterAl | |
| } | ||
| } | ||
|
|
||
| "A metric about mining a new block should be available" in customTestCaseResourceM( | ||
| FakePeer.start2FakePeersRes() | ||
| ) { case (peer1, peer2) => | ||
| import MantisRegistries._ | ||
|
|
||
| val minedMetricBefore = sampleMetric(TimerCountMetric, MinedBlockPropagation) | ||
| val defaultMetricBefore = sampleMetric(TimerCountMetric, DefaultBlockPropagation) | ||
|
|
||
| for { | ||
| _ <- peer1.startRegularSync() | ||
| _ <- peer1.mineNewBlocks(10.milliseconds, 1)(IdentityUpdate) | ||
|
There was a problem hiding this comment. Note that it may be nice to create a value class for number of blocks: case class NumBlocks(val underlying: Int) extends AnyValThis would help make invocations like this a little clearer (at present, the only way to figure out way this Of course there is a tiny bit of extra code for this and whether it's worth paying that cost depends on how central the concept is in the codebase. Just using a regular (Same thinking applies to block number in
|
||
| _ <- peer1.waitForRegularSyncLoadLastBlock(1) | ||
| _ <- peer2.startRegularSync() | ||
| _ <- peer2.connectToPeers(Set(peer1.node)) | ||
| _ <- peer2.waitForRegularSyncLoadLastBlock(1) | ||
| } yield { | ||
|
|
||
| val minedMetricAfter = sampleMetric(TimerCountMetric, MinedBlockPropagation).doubleValue() | ||
| val defaultMetricAfter = sampleMetric(TimerCountMetric, DefaultBlockPropagation).doubleValue() | ||
|
|
||
| minedMetricAfter shouldBe minedMetricBefore + 1.0d | ||
| defaultMetricAfter shouldBe defaultMetricBefore + 1.0d | ||
| } | ||
| } | ||
|
|
||
| object MantisRegistries { | ||
| val TimerCountMetric = "app_regularsync_blocks_propagation_timer_seconds_count" | ||
| val DefaultBlockPropagation = "DefaultBlockPropagation" | ||
| val MinedBlockPropagation = "MinedBlockPropagation" | ||
| def sampleMetric(metricName: String, blockType: String): Double = CollectorRegistry.defaultRegistry.getSampleValue( | ||
| metricName, | ||
| Array("blocktype"), | ||
| Array(blockType) | ||
| ) | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Very nice that you tested the metric 👍 (Though this was perhaps also out of necessity?)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, it was. I need to understand better what was happening. I started by modifying an existing test and then created this one that is a bit more specific. I also found a bit weird that there are no tests on metrics at all