feat: added metrics of libp2p with supporting prometheus

config/config.go

@@ -113,7 +113,7 @@ func SaveTestnetConfig(path string, numValidators int) error {
 		"/ip4/94.101.184.118/tcp/4002/p2p/12D3KooWCRHn8vjrKNBEQcut8uVCYX5q77RKidPaE6iMK31qEVHb",
 	}
 	conf.GRPC.Enable = true
-	conf.GRPC.Listen = "[::]:9090"
+	conf.GRPC.Listen = "[::]:5105"
 	conf.GRPC.Gateway.Enable = true
 	conf.GRPC.Gateway.Listen = "[::]:80"
 	conf.HTTP.Enable = true

config/example_config.toml

@@ -49,6 +49,10 @@
   # Default is false.
  ## enable_mdns = false
 
+  # `enable_metrics` if enabled, it provides network metrics for the Prometheus software.
+  # Default is false.
+ ## enable_metrics = false
+
     # `network.bootstrap` contains configuration for bootstrapping the node.
   [network.bootstrap]
 

docs/metrics/metrics.md

@@ -0,0 +1,43 @@
+# Metrics
+
+The Pactus blockchain offers [Prometheus](https://prometheus.io/) metrics for its network module, enabling users to monitor and analyze various network-related statistics. To activate this feature, inside the `config.toml`,  set the `enable_metrics` parameter to true.  Also, ensure that the HTTP module is enabled. You can enable HTTP module under the `[http]` section of the `config.toml` file. Once enabled, the metrics can be accessed at [http://localhost:8080/metrics/prometheus](http://localhost:8080/metrics/prometheus).
+
+After these changes, restart the Pactus node; you should now be able to view the metrics.
+
+## Prometheus Configuration
+
+Prometheus is an open-source monitoring and alerting tool that facilitates the collection and processing of metrics. A common method of running Prometheus is via Docker containers. To use Prometheus with Docker, follow these steps:
+
+1- Ensure [Docker](https://www.docker.com/) is installed on your system.
+
+2- Pull the Prometheus Docker image:
+
+```text
+docker pull prom/prometheus
+```
+
+3- Create a configuration file named `prometheus.yml` to define the Prometheus configuration. You can refer to the Prometheus [documentation](https://prometheus.io/docs/prometheus/latest/configuration/configuration/) for more guidance. As an example, here's a simple configuration:
+
+```yaml
+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" ]
+```
+4- Start Prometheus as a Docker container:
+
+```text
+docker run -p 9090:9090 -v /path/to/prometheus.yml:/etc/prometheus/prometheus.yml prom/prometheus
+```
+Replace `/path/to/prometheus.yml` with the actual path to your configuration file.
+
+5- Prometheus should now be up and running. Access the Prometheus web interface by visiting [http://localhost:9090/](http://localhost:9090/) in your web browser.

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,35 @@
 		return nil, errors.Errorf(errors.ErrNetwork, err.Error())
 	}
 
+	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)
@@ -130,6 +133,7 @@ func (s *Server) RootHandler(w http.ResponseWriter, _ *http.Request) {
 		return
 	}
 
+	buf.WriteString("<a href=\"/metrics/prometheus\">/metrics/prometheus</a></br>")
 	buf.WriteString("</body></html>")
 	s.writeHTML(w, buf.String())
 }