DAOS-10625 control: Create the tool to collect the logs/config for support purpose

src/control/cmd/daos_agent/main.go

@@ -38,6 +38,7 @@ type cliOptions struct {
 	DumpInfo   dumpAttachInfoCmd      `command:"dump-attachinfo" description:"Dump system attachinfo"`
 	DumpTopo   hwprov.DumpTopologyCmd `command:"dump-topology" description:"Dump system topology"`
 	NetScan    netScanCmd             `command:"net-scan" description:"Perform local network fabric scan"`
+	Support    supportCmd             `command:"support" description:"Perform debug tasks to help support team"`
 }
 
 type (
@@ -114,6 +115,25 @@ func exitWithError(log logging.Logger, err error) {
 	os.Exit(1)
 }
 
+type (
+	supportAgentConfig interface {
+		setSupportConf(string)
+		getSupportConf() string
+	}
+
+	supportAgentConfigCmd struct {
+		supportCfgPath string
+	}
+)
+
+func (cmd *supportAgentConfigCmd) setSupportConf(cfgPath string) {
+	cmd.supportCfgPath = cfgPath
+}
+
+func (cmd *supportAgentConfigCmd) getSupportConf() string {
+	return cmd.supportCfgPath
+}
+
 func parseOpts(args []string, opts *cliOptions, invoker control.Invoker, log *logging.LeveledLogger) error {
 	p := flags.NewParser(opts, flags.Default)
 	p.Options ^= flags.PrintErrors // Don't allow the library to print errors
@@ -176,6 +196,10 @@ func parseOpts(args []string, opts *cliOptions, invoker control.Invoker, log *lo
 			log.Debugf("agent config loaded from %s", cfgPath)
 		}
 
+		if suppCmd, ok := cmd.(supportAgentConfig); ok {
+			suppCmd.setSupportConf(cfgPath)
+		}
+
 		if opts.RuntimeDir != "" {
 			log.Debugf("Overriding socket path from config file with %s", opts.RuntimeDir)
 			cfg.RuntimeDir = opts.RuntimeDir

src/control/cmd/daos_agent/support.go

@@ -0,0 +1,99 @@
+//
+// (C) Copyright 2022-2023 Intel Corporation.
+//
+// SPDX-License-Identifier: BSD-2-Clause-Patent
+//
+
+package main
+
+import (
+	"fmt"
+	"os"
+	"path/filepath"
+
+	"github.com/daos-stack/daos/src/control/common/cmdutil"
+	"github.com/daos-stack/daos/src/control/lib/support"
+)
+
+// supportCmd is the struct representing the top-level support subcommand.
+type supportCmd struct {
+	CollectLog      collectLogCmd `command:"collect-log" description:"Collect logs from client"`
+	agentConfigPath string
+}
+
+// collectLogCmd is the struct representing the command to collect the log from client side.
+type collectLogCmd struct {
+	supportAgentConfigCmd
+	cmdutil.LogCmd
+	support.CollectLogSubCmd
+}
+
+func (cmd *collectLogCmd) Execute(_ []string) error {
+	var LogCollection = map[int32][]string{
+		support.CopyAgentConfigEnum:  {""},
+		support.CollectAgentLogEnum:  {""},
+		support.CollectAgentCmdEnum:  support.AgentCmd,
+		support.CollectClientLogEnum: {""},
+		support.CollectSystemCmdEnum: support.SystemCmd,
+	}
+
+	// Default 3 steps of log/conf collection.
+	progress := support.ProgressBar{
+		Total:     len(LogCollection),
+		NoDisplay: false,
+	}
+
+	if cmd.Archive {
+		progress.Total++
+	}
+
+	// Copy the custom log folder
+	if cmd.ExtraLogsDir != "" {
+		LogCollection[support.CollectExtraLogsDirEnum] = []string{""}
+		progress.Total++
+	}
+
+	if cmd.TargetFolder == "" {
+		cmd.TargetFolder = filepath.Join(os.TempDir(), "daos_support_client_logs")
+	}
+	cmd.Infof("Support Logs will be copied to %s", cmd.TargetFolder)
+
+	progress.Steps = 100 / progress.Total
+	params := support.CollectLogsParams{}
+	params.TargetFolder = cmd.TargetFolder
+	params.ExtraLogsDir = cmd.ExtraLogsDir
+	params.Config = cmd.getSupportConf()
+	for logFunc, logCmdSet := range LogCollection {
+		for _, logCmd := range logCmdSet {
+			cmd.Debugf("Log Function Enum = %d -- Log Collect Cmd = %s ", logFunc, logCmd)
+			params.LogFunction = logFunc
+			params.LogCmd = logCmd
+
+			err := support.CollectSupportLog(cmd.Logger, params)
+			if err != nil {
+				fmt.Println(err)
+				if cmd.Stop {
+					return err
+				}
+			}
+		}
+		fmt.Printf(progress.Display())
+	}
+
+	if cmd.Archive {
+		cmd.Debugf("Archiving the Log Folder %s", cmd.TargetFolder)
+		err := support.ArchiveLogs(cmd.Logger, params)
+		if err != nil {
+			return err
+		}
+
+		// FIXME: DAOS-13290 Workaround for files held open
+		for i := 1; i < 3; i++ {
+			os.RemoveAll(cmd.TargetFolder)
+		}
+	}
+
+	fmt.Printf(progress.Display())
+
+	return nil
+}

src/control/cmd/daos_server/main.go

@@ -47,6 +47,7 @@ type mainOpts struct {
 	Version       versionCmd             `command:"version" description:"Print daos_server version"`
 	MgmtSvc       msCmdRoot              `command:"ms" description:"Perform tasks related to management service replicas"`
 	DumpTopo      hwprov.DumpTopologyCmd `command:"dump-topology" description:"Dump system topology"`
+	Support       supportCmd             `command:"support" description:"Perform debug tasks to help support team"`
 	Config        configCmd              `command:"config" alias:"cfg" description:"Perform tasks related to configuration of hardware on the local server"`
 
 	// Allow a set of tests to be run before executing commands.

src/control/cmd/daos_server/support.go

@@ -0,0 +1,97 @@
+//
+// (C) Copyright 2022-2023 Intel Corporation.
+//
+// SPDX-License-Identifier: BSD-2-Clause-Patent
+//
+
+package main
+
+import (
+	"fmt"
+	"os"
+	"path/filepath"
+
+	"github.com/daos-stack/daos/src/control/common/cmdutil"
+	"github.com/daos-stack/daos/src/control/lib/support"
+)
+
+// supportCmd is the struct representing the top-level support subcommand.
+type supportCmd struct {
+	CollectLog collectLogCmd `command:"collect-log" description:"Collect logs from server"`
+}
+
+// collectLogCmd is the struct representing the command to collect the Logs/config for support purpose
+type collectLogCmd struct {
+	cfgCmd
+	cmdutil.LogCmd
+	support.CollectLogSubCmd
+}
+
+func (cmd *collectLogCmd) Execute(_ []string) error {
+	var LogCollection = map[int32][]string{
+		support.CopyServerConfigEnum:     {""},
+		support.CollectSystemCmdEnum:     support.SystemCmd,
+		support.CollectServerLogEnum:     support.ServerLog,
+		support.CollectDaosServerCmdEnum: support.DaosServerCmd,
+	}
+
+	// Default 4 steps of log/conf collection.
+	progress := support.ProgressBar{
+		Total:     len(LogCollection),
+		NoDisplay: false,
+	}
+
+	if cmd.Archive {
+		progress.Total++
+	}
+
+	// Copy custom log folder
+	if cmd.ExtraLogsDir != "" {
+		LogCollection[support.CollectExtraLogsDirEnum] = []string{""}
+		progress.Total++
+	}
+
+	if cmd.TargetFolder == "" {
+		cmd.TargetFolder = filepath.Join(os.TempDir(), "daos_support_server_logs")
+	}
+	cmd.Infof("Support logs will be copied to %s", cmd.TargetFolder)
+
+	progress.Steps = 100 / progress.Total
+	params := support.CollectLogsParams{}
+	params.Config = cmd.configPath()
+	params.TargetFolder = cmd.TargetFolder
+	params.ExtraLogsDir = cmd.ExtraLogsDir
+	for logFunc, logCmdSet := range LogCollection {
+		for _, logCmd := range logCmdSet {
+			cmd.Debugf("Log Function Enum = %d -- Log Collect Cmd = %s ", logFunc, logCmd)
+			params.LogFunction = logFunc
+			params.LogCmd = logCmd
+
+			err := support.CollectSupportLog(cmd.Logger, params)
+			if err != nil {
+				fmt.Println(err)
+				if cmd.Stop {
+					return err
+				}
+			}
+		}
+		fmt.Printf(progress.Display())
+	}
+
+	if cmd.Archive {
+		cmd.Debugf("Archiving the Log Folder %s", cmd.TargetFolder)
+		err := support.ArchiveLogs(cmd.Logger, params)
+		if err != nil {
+			return err
+		}
+
+		// FIXME: DAOS-13290 Workaround for files held open
+		for i := 1; i < 3; i++ {
+			os.RemoveAll(cmd.TargetFolder)
+		}
+	}
+
+	fmt.Printf(progress.Display())
+
+	return nil
+}

src/control/cmd/dmg/command_test.go

@@ -1,5 +1,5 @@
 //
-// (C) Copyright 2019-2022 Intel Corporation.
+// (C) Copyright 2019-2023 Intel Corporation.
 //
 // SPDX-License-Identifier: BSD-2-Clause-Patent
 //

src/control/cmd/dmg/json_test.go

@@ -67,7 +67,7 @@ func TestDmg_JsonOutput(t *testing.T) {
 			testArgs := append([]string{"-i", "--json"}, args...)
 			switch strings.Join(args, " ") {
 			case "version", "telemetry config", "telemetry run", "config generate",
-				"manpage", "system set-prop":
+				"manpage", "system set-prop", "support collect-log":
 				return
 			case "storage nvme-rebind":
 				testArgs = append(testArgs, "-l", "foo.com", "-a",

src/control/cmd/dmg/main.go

@@ -196,6 +196,7 @@ type cliOptions struct {
 	Config         configCmd      `command:"config" alias:"cfg" description:"Perform tasks related to configuration of hardware on remote servers"`
 	System         SystemCmd      `command:"system" alias:"sys" description:"Perform distributed tasks related to DAOS system"`
 	Network        NetCmd         `command:"network" alias:"net" description:"Perform tasks related to network devices attached to remote servers"`
+	Support        supportCmd     `command:"support" alias:"supp" description:"Perform debug tasks to help support team"`
 	Pool           PoolCmd        `command:"pool" description:"Perform tasks related to DAOS pools"`
 	Cont           ContCmd        `command:"container" alias:"cont" description:"Perform tasks related to DAOS containers"`
 	Version        versionCmd     `command:"version" description:"Print dmg version"`