Merge pull request #10613 from saubyk/update-getdebuginfo-rpc

Update getdebuginfo rpc

Author: yyforyongyu

cmd/commands/cmd_debug.go

@@ -23,14 +23,26 @@ var getDebugInfoCommand = cli.Command{
 	Category: "Debug",
 	Usage:    "Returns debug information related to the active daemon.",
 	Action:   actionDecorator(getDebugInfo),
+	Flags: []cli.Flag{
+		cli.BoolFlag{
+			Name: "include_log",
+			Usage: "if set, the log file content is " +
+				"included in the response in " +
+				"addition to the config",
+		},
+	},
 }
 
+// getDebugInfo retrieves debug information from the daemon, optionally
+// including the log file content.
 func getDebugInfo(ctx *cli.Context) error {
 	ctxc := getContext()
 	client, cleanUp := getClient(ctx)
 	defer cleanUp()
 
-	req := &lnrpc.GetDebugInfoRequest{}
+	req := &lnrpc.GetDebugInfoRequest{
+		IncludeLog: ctx.Bool("include_log"),
+	}
 	resp, err := client.GetDebugInfo(ctxc, req)
 	if err != nil {
 		return err
@@ -61,12 +73,14 @@ var encryptDebugPackageCommand = cli.Command{
 
 	The file by default contains the output of the following commands:
 	- lncli getinfo
-	- lncli getdebuginfo
+	- lncli getdebuginfo (config only)
 	- lncli getnetworkinfo
 
 	By specifying the following flags, additional information can be added
 	to the file (usually this will be requested by the developer depending
 	on the issue at hand):
+		--include_log:
+			- includes the log file content in the debug info
 		--peers:
 			- lncli listpeers
 		--onchain:
@@ -113,6 +127,11 @@ var encryptDebugPackageCommand = cli.Command{
 				"(lncli listchannels, lncli pendingchannels, " +
 				"lncli closedchannels)",
 		},
+		cli.BoolFlag{
+			Name: "include_log",
+			Usage: "include the log file content in the " +
+				"debug package",
+		},
 	},
 	Action: actionDecorator(encryptDebugPackage),
 }
@@ -226,7 +245,9 @@ func collectDebugPackageInfo(ctx *cli.Context) ([]byte, error) {
 	}
 
 	debugInfo, err := client.GetDebugInfo(
-		ctxc, &lnrpc.GetDebugInfoRequest{},
+		ctxc, &lnrpc.GetDebugInfoRequest{
+			IncludeLog: ctx.Bool("include_log"),
+		},
 	)
 	if err != nil {
 		return nil, fmt.Errorf("error getting debug info: %w", err)

docs/release-notes/release-notes-0.21.0.md

@@ -134,10 +134,28 @@
   events](https://github.com/lightningnetwork/lnd/pull/10543) to be able to
   subscribe to state changes.
 
+* The [`GetDebugInfo`](https://github.com/lightningnetwork/lnd/pull/10613) RPC
+  request now accepts an `include_log` flag. By default, only the configuration
+  map is returned. When `include_log` is set to `true`, the log file content is
+  also included in the response.
+
 ## lncli Updates
 
+* The `getdebuginfo` command now supports an `--include_log` flag. By default,
+  only the daemon's configuration is returned. When set, the log file content is
+  also included in the response.
+
+* The `encryptdebugpackage` command now supports an `--include_log` flag. When
+  set, the log file content is included in the encrypted debug package.
+
 ## Breaking Changes
 
+* The [`GetDebugInfo`](https://github.com/lightningnetwork/lnd/pull/10613) RPC
+  no longer returns log file content by default. Clients that rely on the `log`
+  field must now explicitly set `include_log` to `true` in the request. The
+  `lncli getdebuginfo` and `lncli encryptdebugpackage` commands similarly
+  require the `--include_log` flag to include logs in the output.
+
 ## Performance Improvements
 
 * [Replace the catch-all `FilterInvoices` SQL query with five focused,

lnrpc/lightning.pb.go

@@ -2139,6 +2139,9 @@ message GetInfoResponse {
 }
 
 message GetDebugInfoRequest {
+    // If set to true, the log file content will be included in the response.
+    // By default, only the config information is returned.
+    bool include_log = 1;
 }
 
 message GetDebugInfoResponse {

lnrpc/lightning.pb.gw.go

@@ -1095,6 +1095,15 @@
             }
           }
         },
+        "parameters": [
+          {
+            "name": "include_log",
+            "description": "If set to true, the log file content will be included in the response.\nBy default, only the config information is returned.",
+            "in": "query",
+            "required": false,
+            "type": "boolean"
+          }
+        ],
         "tags": [
           "Lightning"
         ]

lnrpc/lightning.proto

@@ -3458,28 +3458,38 @@ func (r *rpcServer) GetInfo(_ context.Context,
 }
 
 // GetDebugInfo returns debug information concerning the state of the daemon
-// and its subsystems. This includes the full configuration and the latest log
-// entries from the log file.
+// and its subsystems. By default, this returns only the configuration. If the
+// `include_log` flag is set in the request, the latest log entries from the
+// log file are also included.
 func (r *rpcServer) GetDebugInfo(_ context.Context,
-	_ *lnrpc.GetDebugInfoRequest) (*lnrpc.GetDebugInfoResponse, error) {
+	req *lnrpc.GetDebugInfoRequest) (*lnrpc.GetDebugInfoResponse, error) {
 
 	flatConfig, _, err := configToFlatMap(*r.cfg)
 	if err != nil {
 		return nil, fmt.Errorf("error converting config to flat map: "+
 			"%w", err)
 	}
 
+	resp := &lnrpc.GetDebugInfoResponse{
+		Config: flatConfig,
+	}
+
+	// If the include_log flag is not set, we only return the config and
+	// skip the log file content which can be large.
+	if !req.IncludeLog {
+		return resp, nil
+	}
+
 	logFileName := filepath.Join(r.cfg.LogDir, defaultLogFilename)
 	logContent, err := os.ReadFile(logFileName)
 	if err != nil {
 		return nil, fmt.Errorf("error reading log file '%s': %w",
 			logFileName, err)
 	}
 
-	return &lnrpc.GetDebugInfoResponse{
-		Config: flatConfig,
-		Log:    strings.Split(string(logContent), "\n"),
-	}, nil
+	resp.Log = strings.Split(string(logContent), "\n")
+
+	return resp, nil
 }
 
 // GetRecoveryInfo returns a boolean indicating whether the wallet is started