Prometheus metrics improvements (#5570)

* db size metrics

* Refactor & Syncing

* Fix issues

* Fix build

* Network metric

* Revert "Network metric"

This reverts commit 1711149.

* Instance & Network

* SyncType & PruningMode

* Fix sync time

* Refactor

* Refactor

* Fix test

* Add test

* Add all dbs

* Typo

* Exception & property

* Fix build

src/Nethermind/Nethermind.Blockchain/BlockTree.cs

@@ -214,7 +214,8 @@ public BlockTree(
                              $"lowest inserted header {LowestInsertedHeader?.Number}, " +
                              $"body {LowestInsertedBodyNumber}, " +
                              $"lowest sync inserted block number {LowestInsertedBeaconHeader?.Number}");
-            ThisNodeInfo.AddInfo("Chain ID     :", $"{(ChainId == NetworkId ? Core.BlockchainIds.GetBlockchainName(NetworkId) : ChainId)}");
+            ProductInfo.Network = $"{(ChainId == NetworkId ? BlockchainIds.GetBlockchainName(NetworkId) : ChainId)}";
+            ThisNodeInfo.AddInfo("Chain ID     :", ProductInfo.Network);
             ThisNodeInfo.AddInfo("Chain head   :", $"{Head?.Header.ToString(BlockHeader.Format.Short) ?? "0"}");
             if (ChainId != NetworkId)
             {

src/Nethermind/Nethermind.Core/ProductInfo.cs

@@ -47,4 +47,12 @@ static ProductInfo()
     public static string Runtime { get; }
 
     public static string Version { get; }
+
+    public static string Network { get; set; } = "";
+
+    public static string Instance { get; set; } = "";
+
+    public static string SyncType { get; set; } = "";
+
+    public static string PruningMode { get; set; } = "";
 }

src/Nethermind/Nethermind.Db.Rocks/ColumnDb.cs

@@ -123,6 +123,8 @@ public void Flush()
 
     private void UpdateReadMetrics() => _mainDb.UpdateReadMetrics();
 
+    public long GetSize() => _mainDb.GetSize();
+
     public Span<byte> GetSpan(ReadOnlySpan<byte> key) => _rocksDb.GetSpan(key, _columnFamily);
 
     public void PutSpan(ReadOnlySpan<byte> key, ReadOnlySpan<byte> value)

src/Nethermind/Nethermind.Db.Rocks/DbOnTheRocks.cs

@@ -231,6 +231,21 @@ protected internal void UpdateWriteMetrics()
             Metrics.OtherDbWrites++;
     }
 
+    public long GetSize()
+    {
+        try
+        {
+            return long.TryParse(_db.GetProperty("rocksdb.total-sst-files-size"), out long size) ? size : 0;
+        }
+        catch (RocksDbSharpException e)
+        {
+            if (_logger.IsWarn)
+                _logger.Warn($"Failed to update DB size metrics {e.Message}");
+        }
+
+        return 0;
+    }
+
     protected virtual void BuildOptions<T>(PerTableDbConfig dbConfig, Options<T> options) where T : Options<T>
     {
         _maxThisDbSize = 0;

src/Nethermind/Nethermind.Db.Rpc/RpcDb.cs

@@ -36,6 +36,8 @@ public void Dispose()
             _recordDb.Dispose();
         }
 
+        public long GetSize() => 0;
+
         public string Name { get; } = "RpcDb";
 
         public byte[] this[ReadOnlySpan<byte> key]

src/Nethermind/Nethermind.Db/FullPruning/FullPruningDb.cs

@@ -4,9 +4,7 @@
 using System;
 using System.Collections.Concurrent;
 using System.Collections.Generic;
-using System.Diagnostics.CodeAnalysis;
 using System.Threading;
-using System.Threading.Tasks;
 using Nethermind.Core;
 using Nethermind.Logging;
 
@@ -89,6 +87,8 @@ public void Dispose()
             _pruningContext?.CloningDb.Dispose();
         }
 
+        public long GetSize() => _currentDb.GetSize() + (_pruningContext?.CloningDb.GetSize() ?? 0);
+
         public string Name => _settings.DbName;
 
         public KeyValuePair<byte[], byte[]?>[] this[byte[][] keys] => _currentDb[keys];

src/Nethermind/Nethermind.Db/IDb.cs

@@ -15,6 +15,7 @@ public interface IDb : IKeyValueStoreWithBatching, IDisposable
         IEnumerable<byte[]> GetAllValues(bool ordered = false);
         void Remove(ReadOnlySpan<byte> key);
         bool KeyExists(ReadOnlySpan<byte> key);
+        long GetSize();
 
         void Flush();
 

src/Nethermind/Nethermind.Db/MemDb.cs

@@ -101,6 +101,8 @@ public virtual IBatch StartBatch()
 
         public int Count => _db.Count;
 
+        public long GetSize() => 0;
+
         public void Dispose()
         {
         }

src/Nethermind/Nethermind.Db/Metrics.cs

@@ -122,6 +122,46 @@ public static class Metrics
         [Description("Indicator if StadeDb is being pruned.")]
         public static int StateDbPruning { get; set; }
 
+        [GaugeMetric]
+        [Description("Size of state DB in bytes")]
+        public static long StateDbSize { get; set; }
+
+        [GaugeMetric]
+        [Description("Size of receipts DB in bytes")]
+        public static long ReceiptsDbSize { get; set; }
+
+        [GaugeMetric]
+        [Description("Size of headers DB in bytes")]
+        public static long HeadersDbSize { get; set; }
+
+        [GaugeMetric]
+        [Description("Size of blocks DB in bytes")]
+        public static long BlocksDbSize { get; set; }
+
+        [GaugeMetric]
+        [Description("Size of bloom DB in bytes")]
+        public static long BloomDbSize { get; set; }
+
+        [GaugeMetric]
+        [Description("Size of code DB in bytes")]
+        public static long CodeDbSize { get; set; }
+
+        [GaugeMetric]
+        [Description("Size of blockInfos DB in bytes")]
+        public static long BlockInfosDbSize { get; set; }
+
+        [GaugeMetric]
+        [Description("Size of cht DB in bytes")]
+        public static long ChtDbSize { get; set; }
+
+        [GaugeMetric]
+        [Description("Size of metadata DB in bytes")]
+        public static long MetadataDbSize { get; set; }
+
+        [GaugeMetric]
+        [Description("Size of witness DB in bytes")]
+        public static long WitnessDbSize { get; set; }
+
         [Description("Metrics extracted from RocksDB Compacion Stats and DB Statistics")]
         public static IDictionary<string, long> DbStats { get; set; } = new ConcurrentDictionary<string, long>();
     }

src/Nethermind/Nethermind.Db/NullDb.cs

@@ -43,6 +43,8 @@ public bool KeyExists(ReadOnlySpan<byte> key)
             return false;
         }
 
+        public long GetSize() => 0;
+
         public IDb Innermost => this;
         public void Flush() { }
         public void Clear() { }

src/Nethermind/Nethermind.Db/ReadOnlyDb.cs

@@ -70,6 +70,8 @@ public IBatch StartBatch()
             return this.LikeABatch();
         }
 
+        public long GetSize() => _wrappedDb.GetSize();
+
         public void Remove(ReadOnlySpan<byte> key) { }
 
         public bool KeyExists(ReadOnlySpan<byte> key)

src/Nethermind/Nethermind.Db/SimpleFilePublicKeyDb.cs

@@ -86,6 +86,8 @@ public bool KeyExists(ReadOnlySpan<byte> key)
             return _cache.ContainsKey(key);
         }
 
+        public long GetSize() => 0;
+
         public IDb Innermost => this;
         public void Flush() { }
         public void Clear()

src/Nethermind/Nethermind.Facade.Test/Eth/EthSyncingInfoTests.cs

@@ -1,6 +1,8 @@
 // SPDX-FileCopyrightText: 2022 Demerzel Solutions Limited
 // SPDX-License-Identifier: LGPL-3.0-only
 
+using System.Threading;
+using FluentAssertions;
 using Nethermind.Blockchain;
 using Nethermind.Blockchain.Receipts;
 using Nethermind.Blockchain.Synchronization;
@@ -118,6 +120,45 @@ public void IsSyncing_AncientBarriers(long? bodiesTail, long? receiptsTail, bool
             Assert.AreEqual(CreateSyncingResult(expectedResult, currentHead, highestBlock), syncingResult);
         }
 
+        [Test]
+        public void Should_calculate_sync_time()
+        {
+            SyncConfig syncConfig = new();
+            IBlockTree blockTree = Substitute.For<IBlockTree>();
+            IReceiptStorage receiptStorage = Substitute.For<IReceiptStorage>();
+
+            blockTree.FindBestSuggestedHeader().Returns(Build.A.BlockHeader.WithNumber(100).TestObject);
+            blockTree.Head.Returns(Build.A.Block.WithHeader(Build.A.BlockHeader.WithNumber(100).TestObject)
+                .TestObject);
+
+            EthSyncingInfo ethSyncingInfo = new(blockTree, receiptStorage, syncConfig, LimboLogs.Instance);
+
+            ethSyncingInfo.IsSyncing().Should().Be(false);
+            ethSyncingInfo.UpdateAndGetSyncTime().TotalMicroseconds.Should().Be(0);
+
+            blockTree.FindBestSuggestedHeader().Returns(Build.A.BlockHeader.WithNumber(100).TestObject);
+            blockTree.Head.Returns(Build.A.Block.WithHeader(Build.A.BlockHeader.WithNumber(80).TestObject)
+                .TestObject);
+
+            // First call starting timer
+            ethSyncingInfo.IsSyncing().Should().Be(true);
+            ethSyncingInfo.UpdateAndGetSyncTime().TotalMicroseconds.Should().Be(0);
+
+            Thread.Sleep(100);
+
+            // Second call timer should count some time
+            ethSyncingInfo.IsSyncing().Should().Be(true);
+            ethSyncingInfo.UpdateAndGetSyncTime().TotalMicroseconds.Should().NotBe(0);
+
+            // Sync ended time should be zero
+            blockTree.FindBestSuggestedHeader().Returns(Build.A.BlockHeader.WithNumber(100).TestObject);
+            blockTree.Head.Returns(Build.A.Block.WithHeader(Build.A.BlockHeader.WithNumber(100).TestObject)
+                .TestObject);
+
+            ethSyncingInfo.IsSyncing().Should().Be(false);
+            ethSyncingInfo.UpdateAndGetSyncTime().TotalMicroseconds.Should().Be(0);
+        }
+
         private SyncingResult CreateSyncingResult(bool isSyncing, long currentBlock, long highestBlock)
         {
             if (!isSyncing) return SyncingResult.NotSyncing;

src/Nethermind/Nethermind.Facade/Eth/EthSyncingInfo.cs

@@ -1,6 +1,8 @@
 // SPDX-FileCopyrightText: 2022 Demerzel Solutions Limited
 // SPDX-License-Identifier: LGPL-3.0-only
 
+using System;
+using System.Diagnostics;
 using Nethermind.Blockchain;
 using Nethermind.Blockchain.Receipts;
 using Nethermind.Blockchain.Synchronization;
@@ -72,6 +74,26 @@ private SyncingResult ReturnSyncing(long headNumberOrZero, long bestSuggestedNum
             };
         }
 
+        private readonly Stopwatch _syncStopwatch = new();
+        public TimeSpan UpdateAndGetSyncTime()
+        {
+            if (!_syncStopwatch.IsRunning)
+            {
+                if (IsSyncing())
+                {
+                    _syncStopwatch.Start();
+                }
+                return TimeSpan.Zero;
+            }
+
+            if (!IsSyncing())
+            {
+                _syncStopwatch.Stop();
+                return TimeSpan.Zero;
+            }
+
+            return _syncStopwatch.Elapsed;
+        }
 
         public bool IsSyncing()
         {

src/Nethermind/Nethermind.Facade/Eth/IEthSyncingInfo.cs

@@ -1,12 +1,16 @@
 // SPDX-FileCopyrightText: 2022 Demerzel Solutions Limited
 // SPDX-License-Identifier: LGPL-3.0-only
 
+using System;
+
 namespace Nethermind.Facade.Eth
 {
     public interface IEthSyncingInfo
     {
         SyncingResult GetFullInfo();
 
         bool IsSyncing();
+
+        TimeSpan UpdateAndGetSyncTime();
     }
 }

src/Nethermind/Nethermind.Facade/Nethermind.Facade.csproj

@@ -12,6 +12,8 @@
     <ProjectReference Include="..\Nethermind.Core\Nethermind.Core.csproj" />
     <ProjectReference Include="..\Nethermind.Crypto\Nethermind.Crypto.csproj" />
     <ProjectReference Include="..\Nethermind.Wallet\Nethermind.Wallet.csproj" />
+    <ProjectReference Include="..\Nethermind.Synchronization\Nethermind.Synchronization.csproj" />
+    <ProjectReference Include="..\Nethermind.Monitoring\Nethermind.Monitoring.csproj" />
   </ItemGroup>
 
 </Project>

src/Nethermind/Nethermind.Init/Metrics.cs

@@ -3,6 +3,7 @@
 
 using System.ComponentModel;
 using Nethermind.Core;
+using Nethermind.Db;
 using Nethermind.Monitoring.Metrics;
 
 namespace Nethermind.Init
@@ -14,6 +15,10 @@ public static class Metrics
         [MetricsStaticDescriptionTag(nameof(ProductInfo.Commit), typeof(ProductInfo))]
         [MetricsStaticDescriptionTag(nameof(ProductInfo.Runtime), typeof(ProductInfo))]
         [MetricsStaticDescriptionTag(nameof(ProductInfo.BuildTimestamp), typeof(ProductInfo))]
+        [MetricsStaticDescriptionTag(nameof(ProductInfo.Instance), typeof(ProductInfo))]
+        [MetricsStaticDescriptionTag(nameof(ProductInfo.Network), typeof(ProductInfo))]
+        [MetricsStaticDescriptionTag(nameof(ProductInfo.SyncType), typeof(ProductInfo))]
+        [MetricsStaticDescriptionTag(nameof(ProductInfo.PruningMode), typeof(ProductInfo))]
         public static long Version { get; set; }
     }
 }

src/Nethermind/Nethermind.Init/Steps/InitDatabase.cs

@@ -14,14 +14,13 @@
 using Nethermind.Db.Rpc;
 using Nethermind.JsonRpc.Client;
 using Nethermind.Logging;
-using Nethermind.Synchronization.ParallelSync;
 
 namespace Nethermind.Init.Steps
 {
     [RunnerStepDependencies(typeof(ApplyMemoryHint))]
     public class InitDatabase : IStep
     {
-        private readonly IBasicApi _api;
+        private readonly INethermindApi _api;
 
         public InitDatabase(INethermindApi api)
         {