feat: enhance analysis command with statistics option

Refactored the analysis command to support an enhanced statistics option, enabling users to opt-in for detailed performance metrics of the analysis process. This change introduces a more flexible approach to handling statistics, allowing for a clearer separation between the analysis output and performance metrics, thereby improving the usability and insights provided to the user.

Signed-off-by: Matthis Holleville <[email protected]>

Author: matthisholleville

cmd/analyze/analyze.go

@@ -40,7 +40,7 @@ var (
 	interactiveMode bool
 	customAnalysis  bool
 	customHeaders   []string
-	stats           bool
+	withStats       bool
 )
 
 // AnalyzeCmd represents the problems command
@@ -64,6 +64,7 @@ var AnalyzeCmd = &cobra.Command{
 			withDoc,
 			interactiveMode,
 			customHeaders,
+			withStats,
 		)
 
 		if err != nil {
@@ -77,12 +78,6 @@ var AnalyzeCmd = &cobra.Command{
 		}
 		config.RunAnalysis()
 
-		if stats {
-			statsData := config.PrintStats()
-			fmt.Println(string(statsData))
-			os.Exit(0)
-		}
-
 		if explain {
 			if err := config.GetAIResults(output, anonymize); err != nil {
 				color.Red("Error: %v", err)
@@ -95,6 +90,12 @@ var AnalyzeCmd = &cobra.Command{
 			color.Red("Error: %v", err)
 			os.Exit(1)
 		}
+
+		if withStats {
+			statsData := config.PrintStats()
+			fmt.Println(string(statsData))
+		}
+
 		fmt.Println(string(output_data))
 
 		if interactiveMode && explain {
@@ -154,5 +155,5 @@ func init() {
 	// label selector flag
 	AnalyzeCmd.Flags().StringVarP(&labelSelector, "selector", "L", "", "Label selector (label query) to filter on, supports '=', '==', and '!='. (e.g. -L key1=value1,key2=value2). Matching objects must satisfy all of the specified label constraints.")
 	// print stats
-	AnalyzeCmd.Flags().BoolVarP(&stats, "stats", "s", false, "Print analysis stats. This option disables errors display.")
+	AnalyzeCmd.Flags().BoolVarP(&withStats, "with-stat", "s", false, "Print analysis stats. This option disables errors display.")
 }

pkg/analysis/analysis.go

@@ -50,6 +50,7 @@ type Analysis struct {
 	MaxConcurrency     int
 	AnalysisAIProvider string // The name of the AI Provider used for this analysis
 	WithDoc            bool
+	WithStats          bool
 	Stats              []common.AnalysisStats
 }
 
@@ -83,6 +84,7 @@ func NewAnalysis(
 	withDoc bool,
 	interactiveMode bool,
 	httpHeaders []string,
+	withStats bool,
 ) (*Analysis, error) {
 	// Get kubernetes client from viper.
 	kubecontext := viper.GetString("kubecontext")
@@ -113,6 +115,7 @@ func NewAnalysis(
 		Explain:        explain,
 		MaxConcurrency: maxConcurrency,
 		WithDoc:        withDoc,
+		WithStats:      withStats,
 	}
 	if !explain {
 		// Return early if AI use was not requested.
@@ -282,14 +285,21 @@ func (a *Analysis) RunAnalysis() {
 func (a *Analysis) executeAnalyzer(analyzer common.IAnalyzer, filter string, analyzerConfig common.Analyzer, semaphore chan struct{}, wg *sync.WaitGroup, mutex *sync.Mutex) {
 	defer wg.Done()
 
+	var startTime time.Time
+	var elapsedTime time.Duration
+
 	// Start the timer
-	startTime := time.Now()
+	if a.WithStats {
+		startTime = time.Now()
+	}
 
 	// Run the analyzer
 	results, err := analyzer.Analyze(analyzerConfig)
 
 	// Measure the time taken
-	elapsedTime := time.Since(startTime)
+	if a.WithStats {
+		elapsedTime = time.Since(startTime)
+	}
 	stat := common.AnalysisStats{
 		Analyzer:     filter,
 		DurationTime: elapsedTime,
@@ -299,10 +309,14 @@ func (a *Analysis) executeAnalyzer(analyzer common.IAnalyzer, filter string, ana
 	defer mutex.Unlock()
 
 	if err != nil {
-		a.Stats = append(a.Stats, stat)
+		if a.WithStats {
+			a.Stats = append(a.Stats, stat)
+		}
 		a.Errors = append(a.Errors, fmt.Sprintf("[%s] %s", filter, err))
 	} else {
-		a.Stats = append(a.Stats, stat)
+		if a.WithStats {
+			a.Stats = append(a.Stats, stat)
+		}
 		a.Results = append(a.Results, results...)
 	}
 	<-semaphore

pkg/server/analyze/analyze.go

@@ -1,9 +1,10 @@
 package analyze
 
 import (
-	schemav1 "buf.build/gen/go/k8sgpt-ai/k8sgpt/protocolbuffers/go/schema/v1"
 	"context"
 	json "encoding/json"
+
+	schemav1 "buf.build/gen/go/k8sgpt-ai/k8sgpt/protocolbuffers/go/schema/v1"
 	"github.com/k8sgpt-ai/k8sgpt/pkg/analysis"
 )
 
@@ -31,6 +32,7 @@ func (h *Handler) Analyze(ctx context.Context, i *schemav1.AnalyzeRequest) (
 		false,      // Kubernetes Doc disabled in server mode
 		false,      // Interactive mode disabled in server mode
 		[]string{}, //TODO: add custom http headers in server mode
+		false,      // with stats disable
 	)
 	config.Context = ctx // Replace context for correct timeouts.
 	if err != nil {