feat: enable pprof

Author: 0x416e746f6e

cmd/serve.go

@@ -12,11 +12,12 @@ import (
 )
 
 const (
-	categoryChaos       = "chaos"
 	categoryAuthrpc     = "authrpc"
+	categoryChaos       = "chaos"
 	categoryFlashblocks = "flashblocks"
-	categoryRPC         = "rpc"
 	categoryMetrics     = "metrics"
+	categoryPprof       = "pprof"
+	categoryRPC         = "rpc"
 )
 
 func CommandServe(cfg *config.Config) *cli.Command {
@@ -542,11 +543,22 @@ func CommandServe(cfg *config.Config) *cli.Command {
 		},
 	}
 
+	pprofFlags := []cli.Flag{ // --pprof-xxx
+		&cli.StringFlag{ // --pprof-listen-address
+			Category:    strings.ToUpper(categoryPprof),
+			Destination: &cfg.Pprof.ListenAddress,
+			EnvVars:     []string{envPrefix + strings.ToUpper(categoryPprof) + "_LISTEN_ADDRESS"},
+			Name:        categoryPprof + "-listen-address",
+			Usage:       "`host:port` for pprof server",
+		},
+	}
+
 	flags := slices.Concat(
 		authrpcFlags,
 		flashblocksFlags,
-		rpcFlags,
 		metricsFlags,
+		pprofFlags,
+		rpcFlags,
 	)
 
 	return &cli.Command{

config/config.go

@@ -12,13 +12,15 @@ type Config struct {
 
 	Log     *Log     `yaml:"log"`
 	Metrics *Metrics `yaml:"metrics"`
+	Pprof   *Pprof   `yaml:"pprof"`
 	Version string   `yaml:"-"`
 }
 
 func New(version string) *Config {
 	return &Config{
 		Log:     &Log{},
 		Metrics: &Metrics{},
+		Pprof:   &Pprof{},
 		Version: version,
 
 		Authrpc: &Authrpc{HttpProxy: &HttpProxy{

config/pprof.go

@@ -0,0 +1,27 @@
+package config
+
+import (
+	"errors"
+	"fmt"
+	"net"
+)
+
+var (
+	errPprofInvalidListenAddress = errors.New("invalid pprof listen address")
+)
+
+type Pprof struct {
+	ListenAddress string `yaml:"listen_address"`
+}
+
+func (cfg *Pprof) Pprof() error {
+	if cfg.ListenAddress != "" {
+		if _, err := net.ResolveTCPAddr("tcp", cfg.ListenAddress); err != nil {
+			return fmt.Errorf("%w: %s: %w",
+				errPprofInvalidListenAddress, cfg.ListenAddress, err,
+			)
+		}
+	}
+
+	return nil
+}

readme.md

@@ -84,6 +84,10 @@ OPTIONS:
 
    --metrics-listen-address host:port  host:port for metrics server (default: "0.0.0.0:6785") [$BPROXY_METRICS_LISTEN_ADDRESS]
 
+   PPROF
+
+   --pprof-listen-address host:port  host:port for pprof server [$BPROXY_PPROF_LISTEN_ADDRESS]
+
    RPC
 
    --rpc-backend url                                                                        url of rpc backend (default: "http://127.0.0.1:18545") [$BPROXY_RPC_BACKEND]

server/server.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"errors"
 	"net/http"
+	"net/http/pprof"
 	"os"
 	"os/signal"
 	"syscall"
@@ -64,17 +65,31 @@ func New(cfg *config.Config) (*Server, error) {
 		s.rpc = rpc
 	}
 
-	mux := http.NewServeMux()
-	mux.Handle("/", promhttp.Handler())
-	mux.Handle("/metrics", promhttp.Handler())
-
-	s.metrics = &http.Server{
-		Addr:              cfg.Metrics.ListenAddress,
-		Handler:           mux,
-		MaxHeaderBytes:    1024,
-		ReadHeaderTimeout: 30 * time.Second,
-		ReadTimeout:       30 * time.Second,
-		WriteTimeout:      30 * time.Second,
+	{
+		mux := http.NewServeMux()
+		mux.Handle("/", promhttp.Handler())
+		mux.Handle("/metrics", promhttp.Handler())
+
+		s.metrics = &http.Server{
+			Addr:              cfg.Metrics.ListenAddress,
+			Handler:           mux,
+			MaxHeaderBytes:    1024,
+			ReadHeaderTimeout: 30 * time.Second,
+			ReadTimeout:       30 * time.Second,
+			WriteTimeout:      30 * time.Second,
+		}
+	}
+
+	if cfg.Pprof.ListenAddress != "" {
+		go func() {
+			mux := http.NewServeMux()
+			mux.HandleFunc("/debug/pprof/", pprof.Index)
+			mux.HandleFunc("/debug/pprof/cmdline", pprof.Cmdline)
+			mux.HandleFunc("/debug/pprof/profile", pprof.Profile)
+			mux.HandleFunc("/debug/pprof/symbol", pprof.Symbol)
+			mux.HandleFunc("/debug/pprof/trace", pprof.Trace)
+			_ = http.ListenAndServe(cfg.Pprof.ListenAddress, mux)
+		}()
 	}
 
 	return s, nil