add config to enable or disable http logs (#2709)

* add config to enable or disable http logs

* update doc

config/config_test.go

@@ -353,6 +353,10 @@ func Test_Defaults(t *testing.T) {
 			path:          "RPC.MaxNativeBlockHashBlockRange",
 			expectedValue: uint64(60000),
 		},
+		{
+			path:          "RPC.EnableHttpLog",
+			expectedValue: true,
+		},
 		{
 			path:          "RPC.WebSockets.Enabled",
 			expectedValue: true,

config/default.go

@@ -80,6 +80,7 @@ BatchRequestsLimit = 20
 MaxLogsCount = 10000
 MaxLogsBlockRange = 10000
 MaxNativeBlockHashBlockRange = 60000
+EnableHttpLog = true
 	[RPC.WebSockets]
 		Enabled = true
 		Host = "0.0.0.0"

docs/config-file/node-config-doc.md

@@ -735,6 +735,7 @@ GlobalQueue=1024
 | - [MaxLogsCount](#RPC_MaxLogsCount )                                         | No      | integer          | No         | -          | MaxLogsCount is a configuration to set the max number of logs that can be returned<br />in a single call to the state, if zero it means no limit                                      |
 | - [MaxLogsBlockRange](#RPC_MaxLogsBlockRange )                               | No      | integer          | No         | -          | MaxLogsBlockRange is a configuration to set the max range for block number when querying TXs<br />logs in a single call to the state, if zero it means no limit                       |
 | - [MaxNativeBlockHashBlockRange](#RPC_MaxNativeBlockHashBlockRange )         | No      | integer          | No         | -          | MaxNativeBlockHashBlockRange is a configuration to set the max range for block number when querying<br />native block hashes in a single call to the state, if zero it means no limit |
+| - [EnableHttpLog](#RPC_EnableHttpLog )                                       | No      | boolean          | No         | -          | EnableHttpLog allows the user to enable or disable the logs related to the HTTP<br />requests to be captured by the server.                                                           |
 
 ### <a name="RPC_Host"></a>8.1. `RPC.Host`
 
@@ -1022,6 +1023,21 @@ native block hashes in a single call to the state, if zero it means no limit
 MaxNativeBlockHashBlockRange=60000
 ```
 
+### <a name="RPC_EnableHttpLog"></a>8.16. `RPC.EnableHttpLog`
+
+**Type:** : `boolean`
+
+**Default:** `true`
+
+**Description:** EnableHttpLog allows the user to enable or disable the logs related to the HTTP
+requests to be captured by the server.
+
+**Example setting the default value** (true):
+```
+[RPC]
+EnableHttpLog=true
+```
+
 ## <a name="Synchronizer"></a>9. `[Synchronizer]`
 
 **Type:** : `object`

docs/config-file/node-config-schema.json

@@ -383,6 +383,11 @@
 					"type": "integer",
 					"description": "MaxNativeBlockHashBlockRange is a configuration to set the max range for block number when querying\nnative block hashes in a single call to the state, if zero it means no limit",
 					"default": 60000
+				},
+				"EnableHttpLog": {
+					"type": "boolean",
+					"description": "EnableHttpLog allows the user to enable or disable the logs related to the HTTP\nrequests to be captured by the server.",
+					"default": true
 				}
 			},
 			"additionalProperties": false,

jsonrpc/config.go

@@ -58,6 +58,10 @@ type Config struct {
 	// MaxNativeBlockHashBlockRange is a configuration to set the max range for block number when querying
 	// native block hashes in a single call to the state, if zero it means no limit
 	MaxNativeBlockHashBlockRange uint64 `mapstructure:"MaxNativeBlockHashBlockRange"`
+
+	// EnableHttpLog allows the user to enable or disable the logs related to the HTTP
+	// requests to be captured by the server.
+	EnableHttpLog bool `mapstructure:"EnableHttpLog"`
 }
 
 // WebSocketsConfig has parameters to config the rpc websocket support

jsonrpc/server.go

@@ -260,7 +260,7 @@ func (s *Server) handle(w http.ResponseWriter, req *http.Request) {
 		respLen = s.handleBatchRequest(req, w, data)
 	}
 	metrics.RequestDuration(start)
-	combinedLog(req, start, http.StatusOK, respLen)
+	s.combinedLog(req, start, http.StatusOK, respLen)
 }
 
 // validateRequest returns a non-zero response code and error message if the
@@ -517,7 +517,11 @@ func RPCErrorResponseWithData(code int, message string, data *[]byte, err error,
 	return nil, types.NewRPCErrorWithData(code, message, data)
 }
 
-func combinedLog(r *http.Request, start time.Time, httpStatus, dataLen int) {
+func (s *Server) combinedLog(r *http.Request, start time.Time, httpStatus, dataLen int) {
+	if !s.config.EnableHttpLog {
+		return
+	}
+
 	log.Infof("%s - - %s \"%s %s %s\" %d %d \"%s\" \"%s\"",
 		r.RemoteAddr,
 		start.Format("[02/Jan/2006:15:04:05 -0700]"),