Add configurable structured logs limit for RPC debug (#298)

* Add StructLogLimit variable

* Add rpc.structloglimit flag

* Add structLogLimit field for checking max logs limit

* Init api with StructLogLimit variable

* Adjust Limit condition

* Set value for the flag from cli

* Update description about zero and negative values

cmd/sonicd/app/launcher.go

@@ -131,6 +131,8 @@ func initFlags() {
 		flags.RPCGlobalTimeoutFlag,
 		flags.BatchRequestLimit,
 		flags.BatchResponseMaxSize,
+		flags.MaxResponseSizeFlag,
+		flags.StructLogLimitFlag,
 	}
 
 	metricsFlags = []cli.Flag{

config/config.go

@@ -176,7 +176,12 @@ func gossipConfigWithFlags(ctx *cli.Context, src gossip.Config) gossip.Config {
 	if ctx.GlobalIsSet(flags.RPCGlobalTimeoutFlag.Name) {
 		cfg.RPCTimeout = ctx.GlobalDuration(flags.RPCGlobalTimeoutFlag.Name)
 	}
-
+	if ctx.GlobalIsSet(flags.MaxResponseSizeFlag.Name) {
+		cfg.MaxResponseSize = ctx.GlobalInt(flags.MaxResponseSizeFlag.Name)
+	}
+	if ctx.IsSet(flags.StructLogLimitFlag.Name) {
+		cfg.StructLogLimit = ctx.GlobalInt(flags.StructLogLimitFlag.Name)
+	}
 	return cfg
 }
 

config/flags/flags.go

@@ -307,6 +307,11 @@ var (
 		Usage: "Limit maximum size in some RPC calls execution",
 		Value: gossip.DefaultConfig(cachescale.Identity).MaxResponseSize,
 	}
+	StructLogLimitFlag = cli.IntFlag{
+		Name:  "rpc.structloglimit",
+		Usage: "Limit maximum number of debug logs for structured EVM logs, 0=unlimited, negative value means no log results",
+		Value: gossip.DefaultConfig(cachescale.Identity).StructLogLimit,
+	}
 	ModeFlag = cli.StringFlag{
 		Name:  "mode",
 		Usage: `Mode of the node ("rpc" or "validator")`,

ethapi/api.go

@@ -1923,12 +1923,17 @@ func (s *PublicTransactionPoolAPI) Resend(ctx context.Context, sendArgs Transact
 type PublicDebugAPI struct {
 	b               Backend
 	maxResponseSize int // in bytes
+	structLogLimit  int
 }
 
 // NewPublicDebugAPI creates a new API definition for the public debug methods
 // of the Ethereum service.
-func NewPublicDebugAPI(b Backend, maxResponseSize int) *PublicDebugAPI {
-	return &PublicDebugAPI{b: b, maxResponseSize: maxResponseSize}
+func NewPublicDebugAPI(b Backend, maxResponseSize int, structLogLimit int) *PublicDebugAPI {
+	return &PublicDebugAPI{
+		b:               b,
+		maxResponseSize: maxResponseSize,
+		structLogLimit:  structLogLimit,
+	}
 }
 
 // GetBlockRlp retrieves the RLP encoded for of a single block.
@@ -2037,6 +2042,15 @@ func (api *PublicDebugAPI) traceTx(ctx context.Context, tx *types.Transaction, m
 	}
 	// Default tracer is the struct logger
 	if config.Tracer == nil {
+		if config.Config == nil {
+			config.Config = &logger.Config{Limit: api.structLogLimit}
+		} else {
+			if api.structLogLimit > 0 &&
+				(config.Config.Limit == 0 || config.Config.Limit > api.structLogLimit) {
+
+				config.Config.Limit = api.structLogLimit
+			}
+		}
 		logger := logger.NewStructLogger(config.Config)
 		tracer = &tracers.Tracer{
 			Hooks:     logger.Hooks(),

gossip/config.go

@@ -89,6 +89,9 @@ type (
 		// MaxResponseSize is a limit for maximum response size in some RPC calls in bytes
 		MaxResponseSize int
 
+		// StructLogLimit is a limit for maximum number of logs in structured EVM debug log
+		StructLogLimit int
+
 		RPCBlockExt bool
 	}
 
@@ -197,6 +200,7 @@ func DefaultConfig(scale cachescale.Func) Config {
 		RPCTimeout:  5 * time.Second,
 
 		MaxResponseSize: 25 * 1024 * 1024,
+		StructLogLimit:  2000,
 	}
 	sessionCfg := cfg.Protocol.DagStreamLeecher.Session
 	cfg.Protocol.DagProcessor.EventsBufferLimit.Num = idx.Event(sessionCfg.ParallelChunksDownload)*

gossip/service.go

@@ -404,7 +404,7 @@ func (s *Service) APIs() []rpc.API {
 		}, {
 			Namespace: "debug",
 			Version:   "1.0",
-			Service:   ethapi.NewPublicDebugAPI(s.EthAPI, s.config.MaxResponseSize),
+			Service:   ethapi.NewPublicDebugAPI(s.EthAPI, s.config.MaxResponseSize, s.config.StructLogLimit),
 			Public:    true,
 		}, {
 			Namespace: "trace",