Remove pprof to file

- because it impacts performance if running all the time
- because you can easily download the file from the http server
- because it clutters the main code

Author: qdm12

cmd/gossamer/flags.go

@@ -97,14 +97,6 @@ var (
 		Name:  "basepath",
 		Usage: "Data directory for the node",
 	}
-	CPUProfFlag = cli.StringFlag{
-		Name:  "cpuprof",
-		Usage: "File to write CPU profile to",
-	}
-	MemProfFlag = cli.StringFlag{
-		Name:  "memprof",
-		Usage: "File to write memory profile to",
-	}
 	PprofServerFlag = cli.StringFlag{
 		Name:  "pprofserver",
 		Usage: "enable or disable the pprof HTTP server",
@@ -390,8 +382,6 @@ var (
 		ChainFlag,
 		ConfigFlag,
 		BasePathFlag,
-		CPUProfFlag,
-		MemProfFlag,
 		PprofServerFlag,
 		PprofAddressFlag,
 		PprofBlockRateFlag,

cmd/gossamer/main.go

@@ -200,12 +200,6 @@ func gossamerAction(ctx *cli.Context) error {
 		return fmt.Errorf("failed to read command argument: %q", arguments[0])
 	}
 
-	// begin profiling, if set
-	stopFunc, err := beginProfile(ctx)
-	if err != nil {
-		return err
-	}
-
 	// setup gossamer logger
 	lvl, err := setupLogger(ctx)
 	if err != nil {
@@ -283,7 +277,7 @@ func gossamerAction(ctx *cli.Context) error {
 		return err
 	}
 
-	node, err := dot.NewNode(cfg, ks, stopFunc)
+	node, err := dot.NewNode(cfg, ks)
 	if err != nil {
 		logger.Errorf("failed to create node services: %s", err)
 		return err

cmd/gossamer/profile.go

@@ -26,9 +26,7 @@ The global flags can be used in conjunction with any Gossamer command
 --basepath value   Data directory for the node 
 --chain value      Node implementation id used to load default node configuration
 --config value     TOML configuration file
---cpuprof          File to write CPU profile to
 --log value        Supports levels crit (silent) to trce (trace) (default: "info")
---memprof          File to write memory profile to
 --name value       Node implementation name
 --rewind value     Rewind head of chain by given number of blocks
 --pprofserver      Enable or disable the pprof HTTP server

docs/docs/usage/command-line.md

@@ -14,8 +14,6 @@ Gossamer consumes a `.toml` file containing predefined settings for the node fro
 [global]
 basepath = "~/.gossamer/gssmr" 
 log = " | trace | debug | info | warn | error | crit"
-cpuprof = "~/cpuprof.out"   
-memprof = "~/memprof.out"
 name = "gssmr"
 pprofserver = false
 pprofaddress = ":6060"

docs/docs/usage/configuration.md

@@ -37,7 +37,6 @@ var logger = log.NewFromGlobal(log.AddContext("pkg", "dot"))
 type Node struct {
 	Name     string
 	Services *services.ServiceRegistry // registry of all node services
-	StopFunc func()                    // func to call when node stops, currently used for profiling
 	wg       sync.WaitGroup
 	started  chan struct{}
 }
@@ -172,7 +171,7 @@ func LoadGlobalNodeName(basepath string) (nodename string, err error) {
 }
 
 // NewNode creates a new dot node from a dot node configuration
-func NewNode(cfg *Config, ks *keystore.GlobalKeystore, stopFunc func()) (*Node, error) {
+func NewNode(cfg *Config, ks *keystore.GlobalKeystore) (*Node, error) {
 	// set garbage collection percent to 10%
 	// can be overwritten by setting the GOGC env variable, which defaults to 100
 	prev := debug.SetGCPercent(10)
@@ -291,7 +290,6 @@ func NewNode(cfg *Config, ks *keystore.GlobalKeystore, stopFunc func()) (*Node,
 	serviceRegistryLogger := logger.New(log.AddContext("pkg", "services"))
 	node := &Node{
 		Name:     cfg.Global.Name,
-		StopFunc: stopFunc,
 		Services: services.NewServiceRegistry(serviceRegistryLogger),
 		started:  make(chan struct{}),
 	}
@@ -397,10 +395,6 @@ func (n *Node) Start() error {
 
 // Stop stops all dot node services
 func (n *Node) Stop() {
-	if n.StopFunc != nil {
-		n.StopFunc()
-	}
-
 	// stop all node services
 	n.Services.StopAll()
 	n.wg.Done()

dot/node.go

@@ -4,10 +4,8 @@
 package dot
 
 import (
-	"io"
 	"math/big"
 	"reflect"
-	"sync"
 	"testing"
 
 	"github.com/ChainSafe/gossamer/dot/core"
@@ -19,7 +17,6 @@ import (
 	"github.com/ChainSafe/gossamer/lib/genesis"
 	"github.com/ChainSafe/gossamer/lib/grandpa"
 	"github.com/ChainSafe/gossamer/lib/keystore"
-	"github.com/ChainSafe/gossamer/lib/services"
 	"github.com/ChainSafe/gossamer/lib/trie"
 	"github.com/ChainSafe/gossamer/lib/utils"
 
@@ -102,7 +99,7 @@ func TestNewNode(t *testing.T) {
 
 	cfg.Core.Roles = types.FullNodeRole
 
-	node, err := NewNode(cfg, ks, nil)
+	node, err := NewNode(cfg, ks)
 	require.NoError(t, err)
 
 	bp := node.Services.Get(&babe.Service{})
@@ -135,7 +132,7 @@ func TestNewNode_Authority(t *testing.T) {
 
 	cfg.Core.Roles = types.AuthorityRole
 
-	node, err := NewNode(cfg, ks, nil)
+	node, err := NewNode(cfg, ks)
 	require.NoError(t, err)
 
 	bp := node.Services.Get(&babe.Service{})
@@ -168,7 +165,7 @@ func TestStartNode(t *testing.T) {
 
 	cfg.Core.Roles = types.FullNodeRole
 
-	node, err := NewNode(cfg, ks, nil)
+	node, err := NewNode(cfg, ks)
 	require.NoError(t, err)
 
 	go func() {
@@ -270,7 +267,7 @@ func TestInitNode_LoadStorageRoot(t *testing.T) {
 	ks.Gran.Insert(ed25519Keyring.Alice())
 	sr25519Keyring, _ := keystore.NewSr25519Keyring()
 	ks.Babe.Insert(sr25519Keyring.Alice())
-	node, err := NewNode(cfg, ks, nil)
+	node, err := NewNode(cfg, ks)
 	require.NoError(t, err)
 
 	if reflect.TypeOf(node) != reflect.TypeOf(&Node{}) {
@@ -328,7 +325,7 @@ func TestInitNode_LoadBalances(t *testing.T) {
 	ed25519Keyring, _ := keystore.NewEd25519Keyring()
 	ks.Gran.Insert(ed25519Keyring.Alice())
 
-	node, err := NewNode(cfg, ks, nil)
+	node, err := NewNode(cfg, ks)
 	require.NoError(t, err)
 
 	if reflect.TypeOf(node) != reflect.TypeOf(&Node{}) {
@@ -356,26 +353,6 @@ func TestInitNode_LoadBalances(t *testing.T) {
 	require.Equal(t, expected, bal)
 }
 
-func TestNode_StopFunc(t *testing.T) {
-	testvar := "before"
-	stopFunc := func() {
-		testvar = "after"
-	}
-
-	serviceRegistryLogger := log.New(log.SetWriter(io.Discard))
-	servicesRegistry := services.NewServiceRegistry(serviceRegistryLogger)
-
-	node := &Node{
-		Services: servicesRegistry,
-		StopFunc: stopFunc,
-		wg:       sync.WaitGroup{},
-	}
-	node.wg.Add(1)
-
-	node.Stop()
-	require.Equal(t, testvar, "after")
-}
-
 func TestNode_PersistGlobalName_WhenInitialize(t *testing.T) {
 	globalName := RandomNodeName()