Adding runtime cpu profiling for core node

.gitignore

@@ -18,6 +18,7 @@ coverage.*
 resource/zoobc_*
 resource/snapshots*
 resource_cluster/zoobc_*
+resource/*.prof
 cmd/*.new
 accounts.txt
 .editorconfig

cmd/transaction/const.go

@@ -38,9 +38,6 @@ var (
 	nodeOwnerAccountAddress string
 	nodeAddress             string
 	lockedBalance           int64
-	poowMessageByte         []byte
-	signatureByte           []byte
-	nodePubKey              []byte
 	proofOfOwnershipHex     string
 	databasePath            string
 	databaseName            string

main.go

@@ -12,6 +12,8 @@ import (
 	"os"
 	"os/signal"
 	"path/filepath"
+	"runtime"
+	"runtime/pprof"
 	"strings"
 	"syscall"
 	"time"
@@ -46,7 +48,7 @@ import (
 
 var (
 	dbPath, dbName, badgerDbPath, badgerDbName, nodeSecretPhrase, nodeKeyPath,
-	nodeKeyFile, nodePreSeed, ownerAccountAddress, myAddress, nodeKeyFilePath, snapshotPath string
+	nodeKeyFile, nodePreSeed, ownerAccountAddress, myAddress, nodeKeyFilePath, snapshotPath, profilingFilePathName string
 	dbInstance                                      *database.SqliteDB
 	badgerDbInstance                                *database.BadgerDB
 	db                                              *sql.DB
@@ -94,6 +96,7 @@ var (
 	mainchainForkProcessor, spinechainForkProcessor blockchainsync.ForkingProcessorInterface
 	defaultSignatureType                            *crypto.Ed25519Signature
 	nodeKey                                         *model.NodeKey
+	cpuProfile, memProfile                          bool
 )
 
 func init() {
@@ -106,6 +109,8 @@ func init() {
 	flag.StringVar(&configPostfix, "config-postfix", "", "Usage")
 	flag.StringVar(&configPath, "config-path", "./resource", "Usage")
 	flag.BoolVar(&isDebugMode, "debug", false, "Usage")
+	flag.BoolVar(&cpuProfile, "cpu-profile", false, "if this flag is used, write cpu profile to file")
+	flag.BoolVar(&memProfile, "mem-profile", false, "if this flag is used, write memory (heap) profile to file")
 	flag.Parse()
 
 	loadNodeConfig(configPath, "config"+configPostfix, "toml")
@@ -257,6 +262,7 @@ func loadNodeConfig(configPath, configFileName, configExtension string) {
 	apiCertFile = viper.GetString("apiapiCertFile")
 	apiKeyFile = viper.GetString("apiKeyFile")
 	snapshotPath = viper.GetString("snapshotPath")
+	profilingFilePathName = viper.GetString("profilingFilePathName")
 
 	// get the node private key
 	nodeKeyFilePath = filepath.Join(nodeKeyPath, nodeKeyFile)
@@ -859,6 +865,42 @@ func startBlockchainSyncronizers() {
 }
 
 func main() {
+	// start cpu profiling if enabled
+	if cpuProfile {
+		if profilingFilePathName == "" {
+			log.Error("missing profilingFilePathName configuration parameter")
+		} else {
+			// add cpu to prof file name
+			f, err := os.Create(fmt.Sprintf(profilingFilePathName, "cpu"))
+			if err != nil {
+				log.Fatal("could not create CPU profile: ", err)
+			}
+			defer f.Close() // error handling omitted for example
+			if err := pprof.StartCPUProfile(f); err != nil {
+				log.Error("could not start CPU profile: ", err)
+			}
+			defer pprof.StopCPUProfile()
+		}
+	}
+
+	// start memory profiling if enabled
+	if memProfile {
+		if profilingFilePathName == "" {
+			log.Error("missing profilingFilePathName configuration parameter")
+		} else {
+			// add mem to prof file name
+			f, err := os.Create(fmt.Sprintf(profilingFilePathName, "mem"))
+			if err != nil {
+				log.Fatal("could not create memory profile: ", err)
+			}
+			defer f.Close() // error handling omitted for example
+			runtime.GC()    // get up-to-date statistics
+			if err := pprof.WriteHeapProfile(f); err != nil {
+				log.Error("could not write memory profile: ", err)
+			}
+		}
+	}
+
 	migration := database.Migration{Query: queryExecutor}
 	if err := migration.Init(); err != nil {
 		loggerCoreService.Fatal(err)
@@ -886,6 +928,7 @@ func main() {
 	signal.Notify(sigs, syscall.SIGINT, syscall.SIGTERM)
 	<-sigs
 	loggerCoreService.Info("Shutting down node...")
+
 	if mainchainProcessor != nil {
 		mainchainProcessor.Stop()
 	}

p2p/service/p2pServerService_test.go

@@ -130,7 +130,8 @@ func TestNewP2PServerService(t *testing.T) {
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			if got := NewP2PServerService(tt.args.fileService, tt.args.peerExplorer, tt.args.blockServices, tt.args.mempoolServices, tt.args.nodeSecretPhrase, tt.args.observer); !reflect.DeepEqual(got, tt.want) {
+			if got := NewP2PServerService(tt.args.fileService, tt.args.peerExplorer, tt.args.blockServices, tt.args.mempoolServices,
+				tt.args.nodeSecretPhrase, tt.args.observer); !reflect.DeepEqual(got, tt.want) {
 				t.Errorf("NewP2PServerService() = %v, want %v", got, tt.want)
 			}
 		})
@@ -1495,7 +1496,7 @@ func (*mockSendTransactionsMempoolServiceSuccess) ReceivedBlockTransactions(
 	lastBlock *model.Block,
 	nodeSecretPhrase string,
 ) ([]*model.BatchReceipt, error) {
-	return []*model.BatchReceipt{&model.BatchReceipt{
+	return []*model.BatchReceipt{{
 		SenderPublicKey: []byte{1},
 	}}, nil
 }
@@ -1608,7 +1609,7 @@ func TestP2PServerService_SendBlockTransactions(t *testing.T) {
 				chainType: &mockChainType,
 			},
 			want: &model.SendBlockTransactionsResponse{
-				BatchReceipts: []*model.BatchReceipt{&model.BatchReceipt{
+				BatchReceipts: []*model.BatchReceipt{{
 					SenderPublicKey: []byte{1},
 				}},
 			},
@@ -1821,7 +1822,7 @@ func TestP2PServerService_RequestDownloadFile(t *testing.T) {
 				fileChunkNames: []string{mockRequestDownloadFileName},
 			},
 			want: &model.FileDownloadResponse{
-				FileChunks: [][]byte{[]byte{1}},
+				FileChunks: [][]byte{{1}},
 			},
 			wantErr: false,
 		},

readme.md

@@ -89,6 +89,22 @@ go run main.go
     1. `debug` (bool): enters debug mode with capabilities like `prometheus monitoring` (uses port defined by `monitoringPort` in the config file).
     2. `config-postfix` (string): defines which config file with defined postfix to use. It will use the config file in `./resource/config{postfix}`.toml.
     3. `config-path` (string): defines the directory that will hold the resources and configs. by default it will use `./resource`. This will be useful particularly for robust resource placements, for example while used in Zoobc-Testing-Framework.
+    4. `cpu-profile` (bool): enable cpu profiling *(1)* for the running instance. A profile (node_cpu.prof) file will be persisted to storage 
+    at a
+     location defined in profilingFilePathName config parameter.
+    5. `mem-profile` (bool): enable memory (heap) profiling *(1)* for the running instance. A profile (node_mem.prof) file will be persisted
+     to 
+    storage at a
+     location defined in profilingFilePathName config parameter.
+
+    *(1)* Profiles can then be visualized with the pprof tool:
+    ```
+    go tool pprof .resource/node_cpu.prof 
+    ```
+
+    See [Getting started with Go CPU and memory profiling](https://flaviocopes.com/golang-profiling/) 
+    for documentation on how to use goLang pprof tool
+
 -   Command line tools
     ```bash
     cd cmd

resource/config.toml

@@ -3,6 +3,7 @@ dbName = "zoobc.db"
 badgerDbPath="./resource"
 badgerDbName="zoobc_1_kv/"
 configPath = "./resource/"
+profilingFilePathName = "./resource/node_%s.prof"
 nodeKeyFile = "node_keys.json"
 snapshotPath = "./resource/snapshots"
 

resource/config2.toml

@@ -3,6 +3,7 @@ dbName = "zoobc_2.db"
 badgerDbPath="./resource"
 badgerDbName="zoobc_2_kv/"
 configPath = "./resource/"
+profilingFilePathName = "./resource/node_2_%s.prof"
 nodeKeyFile = "node_keys_2.json"
 snapshotPath = "./resource/snapshots_2"
 

resource/config3.toml

@@ -3,6 +3,7 @@ dbName = "zoobc_3.db"
 badgerDbPath="./resource"
 badgerDbName="zoobc_3_kv/"
 configPath = "./resource/"
+profilingFilePathName = "./resource/node_3_%s.prof"
 nodeKeyFile = "node_keys_3.json"
 snapshotPath = "./resource/snapshots"
 

resource/config4.toml

@@ -3,6 +3,7 @@ dbName = "zoobc_4.db"
 badgerDbPath="./resource"
 badgerDbName="zoobc_4_kv/"
 configPath = "./resource/"
+profilingFilePathName = "./resource/node_4_%s.prof"
 nodeKeyFile = "node_keys_4.json"
 snapshotPath = "./resource/snapshots"
 

resource/config5.toml

@@ -4,6 +4,7 @@ badgerDbPath="./resource"
 badgerDbName="zoobc_5_kv/"
 configPath = "./resource/"
 nodeKeyFile = "node_keys_5.json"
+profilingFilePathName = "./resource/node_5_%s.prof"
 snapshotPath = "./resource/snapshots"
 
 # Peer