Refactor tx_pool_latency_analysis and tx_pool_throughput_analysis to replace 'measureInterval' with 'logInterval' for consistency. Update related documentation and configuration files to reflect this change, and adjust TPS values in playbooks for improved testing scenarios.

Author: tosettil-polimi

pkg/coordinator/tasks/tx_pool_latency_analysis/README.md

@@ -15,7 +15,7 @@ The `tx_pool_latency_analysis` task evaluates latency of transaction processing
 - **`duration_s`**:
   The test duration (the number of transactions to send is calculated as `tps * duration_s`).
 
-- **`measureInterval`**:
+- **`logInterval`**:
   The interval at which the script logs progress (e.g., every 100 transactions).
 
 ### Outputs
@@ -37,9 +37,9 @@ The `tx_pool_latency_analysis` task evaluates latency of transaction processing
 ```yaml
 - name: tx_pool_latency_analysis
   config:
-    tps: 100
+    tps: 1000
     duration_s: 10  
-    measureInterval: 1000
+    logInterval: 1000
   configVars:
     privateKey: "walletPrivkey"
 ```

pkg/coordinator/tasks/tx_pool_latency_analysis/config.go

@@ -5,15 +5,15 @@ type Config struct {
 
 	TPS                  int   `yaml:"tps" json:"tps"`
 	Duration_s           int   `yaml:"duration_s" json:"duration_s"`
-	MeasureInterval      int   `yaml:"measureInterval" json:"measureInterval"`
+	LogInterval          int   `yaml:"logInterval" json:"logInterval"`
 	SecondsBeforeRunning int64 `yaml:"secondsBeforeRunning" json:"secondsBeforeRunning"`
 }
 
 func DefaultConfig() Config {
 	return Config{
 		TPS:                  100,
 		Duration_s:           60,
-		MeasureInterval:      100,
+		LogInterval:          100,
 		SecondsBeforeRunning: 0,
 	}
 }

pkg/coordinator/tasks/tx_pool_latency_analysis/task.go

@@ -113,7 +113,7 @@ func (t *Task) Execute(ctx context.Context) error {
 	var testDeadline time.Time = time.Now().Add(time.Duration(t.config.Duration_s+60*30) * time.Second)
 
 	load_target := tx_load_tool.NewLoadTarget(ctx, t.ctx, t.logger, t.wallet, client)
-	load := tx_load_tool.NewLoad(load_target, t.config.TPS, t.config.Duration_s, testDeadline)
+	load := tx_load_tool.NewLoad(load_target, t.config.TPS, t.config.Duration_s, testDeadline, t.config.LogInterval)
 
 	// Generate and sending transactions, waiting for their propagation
 	err = load.Execute()

pkg/coordinator/tasks/tx_pool_throughput_analysis/README.md

@@ -15,7 +15,7 @@ The `tx_pool_throughput_analysis` task evaluates the throughput of transaction p
 - **`duration_s`**:
   The test duration (the number of transactions to send is calculated as `tps * duration_s`).
 
-- **`measureInterval`**:
+- **`logInterval`**:
   The interval at which the script logs progress (e.g., every 100 transactions).
 
 ### Outputs
@@ -31,9 +31,9 @@ The `tx_pool_throughput_analysis` task evaluates the throughput of transaction p
 ```yaml
 - name: tx_pool_throughput_analysis
   config:
-    tps: 100
+    tps: 1000
     duration_s: 10  
-    measureInterval: 1000
+    logInterval: 1000
   configVars:
     privateKey: "walletPrivkey"
 ```

pkg/coordinator/tasks/tx_pool_throughput_analysis/config.go

@@ -5,15 +5,15 @@ type Config struct {
 
 	TPS                  int `yaml:"tps" json:"tps"`
 	Duration_s           int `yaml:"duration_s" json:"duration_s"`
-	MeasureInterval      int `yaml:"measureInterval" json:"measureInterval"`
+	LogInterval          int `yaml:"logInterval" json:"logInterval"`
 	SecondsBeforeRunning int `yaml:"secondsBeforeRunning" json:"secondsBeforeRunning"`
 }
 
 func DefaultConfig() Config {
 	return Config{
 		TPS:                  100,
 		Duration_s:           60,
-		MeasureInterval:      100,
+		LogInterval:          100,
 		SecondsBeforeRunning: 0,
 	}
 }

pkg/coordinator/tasks/tx_pool_throughput_analysis/task.go

@@ -112,7 +112,7 @@ func (t *Task) Execute(ctx context.Context) error {
 	var testDeadline time.Time = time.Now().Add(time.Duration(t.config.Duration_s+60*30) * time.Second)
 
 	load_target := tx_load_tool.NewLoadTarget(ctx, t.ctx, t.logger, t.wallet, client)
-	load := tx_load_tool.NewLoad(load_target, t.config.TPS, t.config.Duration_s, testDeadline)
+	load := tx_load_tool.NewLoad(load_target, t.config.TPS, t.config.Duration_s, testDeadline, t.config.LogInterval)
 
 	// Generate and sending transactions, waiting for their propagation
 	err = load.Execute()

pkg/coordinator/utils/tx_load_tool/tx_load_tool.go

@@ -20,8 +20,6 @@ import (
 	"github.com/sirupsen/logrus"
 )
 
-const logInterval = 100 // Log every 100 transactions
-
 type LoadTarget struct {
 	ctx      context.Context
 	task_ctx *types.TaskContext
@@ -73,21 +71,23 @@ func NewLoadResult(totNumberOfTxes int) *LoadResult {
 }
 
 type Load struct {
-	target       *LoadTarget
-	testDeadline time.Time
-	TPS          int
-	Duration_s   int
-	Result       *LoadResult
+	target          *LoadTarget
+	testDeadline    time.Time
+	TPS             int
+	Duration_s      int
+	LogInterval     int
+	Result          *LoadResult
 }
 
 // NewLoad creates a new Load instance
-func NewLoad(target *LoadTarget, TPS int, duration_s int, testDeadline time.Time) *Load {
+func NewLoad(target *LoadTarget, TPS int, duration_s int, testDeadline time.Time, logInterval int) *Load {
 	return &Load{
-		target:       target,
-		TPS:          TPS,
-		Duration_s:   duration_s,
-		testDeadline: testDeadline,
-		Result:       NewLoadResult(TPS * duration_s),
+		target:          target,
+		TPS:             TPS,
+		Duration_s:      duration_s,
+		testDeadline:    testDeadline,
+		LogInterval:     logInterval,
+		Result:          NewLoadResult(TPS * duration_s),
 	}
 }
 
@@ -140,7 +140,7 @@ func (l *Load) Execute() error {
 				l.Result.SentTxCount++
 
 				// log transaction sending
-				if l.Result.SentTxCount%logInterval == 0 {
+				if l.Result.SentTxCount%l.LogInterval == 0 {
 					elapsed := time.Since(l.Result.StartTime)
 					l.target.logger.Infof("Sent %d transactions in %.2fs", l.Result.SentTxCount, elapsed.Seconds())
 				}
@@ -234,7 +234,7 @@ func (l *Load) MeasurePropagationLatencies() (*LoadResult, error) {
 				receivedEvents++
 			}
 
-			if receivedEvents%logInterval == 0 {
+			if receivedEvents%l.LogInterval == 0 {
 				l.target.logger.Infof("Received %d p2p events", receivedEvents)
 			}
 		}

playbooks/dev/tx-pool-check-short.yaml

@@ -11,7 +11,7 @@ tasks:
   config:
     tps: 1000
     duration_s: 10
-    measureInterval: 1000
+    logInterval: 1000
   configVars:
     privateKey: "walletPrivkey"
 - name: tx_pool_clean
@@ -25,6 +25,6 @@ tasks:
   config:
     tps: 1000
     duration_s: 10
-    measureInterval: 1000
+    logInterval: 1000
   configVars:
     privateKey: "walletPrivkey"

playbooks/dev/tx-pool-check.yaml

@@ -11,7 +11,7 @@ tasks:
   config:
     tps: 1000
     duration_s: 10
-    measureInterval: 1000
+    logInterval: 1000
   configVars:
     privateKey: "walletPrivkey"
 - name: tx_pool_clean
@@ -25,7 +25,7 @@ tasks:
   config:
     tps: 1000
     duration_s: 10
-    measureInterval: 1000
+    logInterval: 1000
   configVars:
     privateKey: "walletPrivkey"
 # - name: tx_pool_clean
@@ -38,7 +38,7 @@ tasks:
 #   timeout: 10m
 #   config:
 #     txCount: 10000
-#     measureInterval: 1000
+#     logInterval: 1000
 #     highLatency: 5000
 #     failOnHighLatency: true
 #   configVars:
@@ -53,7 +53,7 @@ tasks:
 #   timeout: 10m
 #   config:
 #     qps: 10000
-#     measureInterval: 1000
+#     logInterval: 1000
 #   configVars:
 #     privateKey: "walletPrivkey"
 # - name: tx_pool_clean
@@ -66,7 +66,7 @@ tasks:
 #   timeout: 30m
 #   config:
 #     txCount: 15000
-#     measureInterval: 1500
+#     logInterval: 1500
 #     highLatency: 7000
 #     failOnHighLatency: true
 #   configVars:
@@ -81,6 +81,6 @@ tasks:
 #   title: "Check transaction pool throughput with 15.000 transactions in one second"
 #   config:
 #     qps: 15000
-#     measureInterval: 1500
+#     logInterval: 1500
 #   configVars:
 #     privateKey: "walletPrivkey"