feat: added metrics of libp2p with supporting prometheus

config/example_config.toml

@@ -49,6 +49,11 @@
   # Default is false.
  ## enable_mdns = false
 
+  # `enable_metrics` provides network metrics for prometheus.
+  # Metrics provides information about network usage that you can show them in prometheus.
+  # Default is false.
+ ## enable_metrics = false
+
     # `network.bootstrap` contains configuration for bootstrapping the node.
   [network.bootstrap]
 

docs/metrics/docker-compose.yml

@@ -0,0 +1,7 @@
+services:
+  prometheus:
+    image: prom/prometheus:latest
+    ports:
+      - "9090:9090"
+    volumes:
+      - ./prometheus.yml:/etc/prometheus/prometheus.yml

docs/metrics/metrics.md

@@ -0,0 +1,31 @@
+# Metrics
+
+Before starting to get metrics of the Pactus software, there are a few important steps that need to be followed.
+Please follow the instructions below:
+
+1. after you `Init` the Pactus in your working directory you need to update `config.toml` file before starting the node.
+
+by default metrics in the Pactus is not enable!
+
+        1.1. open config.toml file which its in your working directory.
+        1.2. go to network section.
+        1.3.find enable_metrics = false
+        1.4. change it to enable_metrics = true
+        1.5. done!, now you can save the file.
+
+2. start the Pactus node.
+
+
+3. now metrics are available, for example if you want to get metrics in the Pactus testnet you can find it at below url
+
+```
+http://localhost:8080/metrics/prometheus
+```
+
+4. if you want to use metrics in monitoring tools like `Prometheus` you can use the `docker-compose` file.
+
+just be careful about the addresses and ports that they're existing in `docker-compose` and `prometheus` yml.
+
+if you run the Pactus node on docker container you should change targets of `pactus-testnet` job in `prometheus.yml`
+
+

docs/metrics/prometheus.yml

@@ -0,0 +1,13 @@
+global:
+  scrape_interval: 1m
+
+scrape_configs:
+  - job_name: "prometheus"
+    scrape_interval: 1m
+    static_configs:
+      - targets: [ "127.0.0.1:9090" ]
+
+  - job_name: "pactus-metrics"
+    metrics_path: /metrics/prometheus
+    static_configs:
+      - targets: [ "127.0.0.1:8080" ]

network/config.go

@@ -9,14 +9,15 @@ import (
 )
 
 type Config struct {
-	Name        string           `toml:"name"`
-	Listens     []string         `toml:"listens"`
-	NetworkKey  string           `toml:"network_key"`
-	EnableNAT   bool             `toml:"enable_nat"`
-	EnableRelay bool             `toml:"enable_relay"`
-	RelayAddrs  []string         `toml:"relay_addresses"`
-	EnableMdns  bool             `toml:"enable_mdns"`
-	Bootstrap   *BootstrapConfig `toml:"bootstrap"`
+	Name          string           `toml:"name"`
+	Listens       []string         `toml:"listens"`
+	NetworkKey    string           `toml:"network_key"`
+	EnableNAT     bool             `toml:"enable_nat"`
+	EnableRelay   bool             `toml:"enable_relay"`
+	RelayAddrs    []string         `toml:"relay_addresses"`
+	EnableMdns    bool             `toml:"enable_mdns"`
+	EnableMetrics bool             `toml:"enable_metrics"`
+	Bootstrap     *BootstrapConfig `toml:"bootstrap"`
 }
 
 // BootstrapConfig holds all configuration options related to bootstrap nodes.
@@ -47,12 +48,13 @@ func DefaultConfig() *Config {
 	}
 
 	return &Config{
-		Name:        "pactus",
-		Listens:     []string{"/ip4/0.0.0.0/tcp/21777", "/ip6/::/tcp/21777"},
-		NetworkKey:  "network_key",
-		EnableNAT:   true,
-		EnableRelay: false,
-		EnableMdns:  false,
+		Name:          "pactus",
+		Listens:       []string{"/ip4/0.0.0.0/tcp/21777", "/ip6/::/tcp/21777"},
+		NetworkKey:    "network_key",
+		EnableNAT:     true,
+		EnableRelay:   false,
+		EnableMdns:    false,
+		EnableMetrics: false,
 		Bootstrap: &BootstrapConfig{
 			Addresses:    addresses,
 			MinThreshold: 8,

network/network.go

@@ -11,11 +11,14 @@
 	lp2pcrypto "github.com/libp2p/go-libp2p/core/crypto"
 	lp2phost "github.com/libp2p/go-libp2p/core/host"
 	lp2ppeer "github.com/libp2p/go-libp2p/core/peer"
+	rcmgr "github.com/libp2p/go-libp2p/p2p/host/resource-manager"
+	rcmgrObs "github.com/libp2p/go-libp2p/p2p/host/resource-manager/obs"
 	ma "github.com/multiformats/go-multiaddr"
 	"github.com/pactus-project/pactus/util"
 	"github.com/pactus-project/pactus/util/errors"
 	"github.com/pactus-project/pactus/util/logger"
 	"github.com/pactus-project/pactus/version"
+	"github.com/prometheus/client_golang/prometheus"
 )
 
 var _ Network = &network{}
@@ -81,12 +84,36 @@
 		return nil, errors.Errorf(errors.ErrNetwork, err.Error())
 	}
 
+	//libp2p prometheus metrics
+	if conf.EnableMetrics {
+		rcmgrObs.MustRegisterWith(prometheus.DefaultRegisterer)
+	}
+
+	str, err := rcmgrObs.NewStatsTraceReporter()
+	if err != nil {
+		return nil, errors.Errorf(errors.ErrNetwork, err.Error())
+	}
+
+	rmgr, err := rcmgr.NewResourceManager(
+		rcmgr.NewFixedLimiter(rcmgr.DefaultLimits.AutoScale()),
+		rcmgr.WithTraceReporter(str),
+	)
+
+	if err != nil {
+		return nil, errors.Errorf(errors.ErrNetwork, err.Error())
+	}
+
 	opts = append(opts,
 		lp2p.Identity(networkKey),
 		lp2p.ListenAddrStrings(conf.Listens...),
 		lp2p.UserAgent(version.Agent()),
+		lp2p.ResourceManager(rmgr),
 	)
 
+	if !conf.EnableMetrics {
+		opts = append(opts, lp2p.DisableMetrics())
+	}
+
 	if conf.EnableNAT {
 		opts = append(opts,
 			lp2p.EnableNATService(),

www/http/server.go

@@ -10,6 +10,8 @@ import (
 	"strings"
 	"time"
 
+	"github.com/prometheus/client_golang/prometheus/promhttp"
+
 	"github.com/gorilla/handlers"
 	"github.com/gorilla/mux"
 	"github.com/pactus-project/pactus/util"
@@ -72,6 +74,7 @@ func (s *Server) StartServer(grpcServer string) error {
 	s.router.HandleFunc("/account/number/{number}", s.GetAccountByNumberHandler)
 	s.router.HandleFunc("/validator/address/{address}", s.GetValidatorHandler)
 	s.router.HandleFunc("/validator/number/{number}", s.GetValidatorByNumberHandler)
+	http.Handle("/metrics/prometheus", promhttp.Handler())
 	http.Handle("/", handlers.RecoveryHandler()(s.router))
 
 	l, err := net.Listen("tcp", s.config.Listen)