Added sugestions to CPU and Memory usage in logs (#2379)

Signed-off-by: João Reigota <[email protected]>
Checkmarx · Apr 26, 2021 · a280a4e · a280a4e
1 parent f83414f
commit a280a4e
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 11 deletions.
diff --git a/internal/console/kics.go b/internal/console/kics.go
@@ -31,7 +31,7 @@ var (
 	noColor   bool
 	silent    bool
 	ci        bool
-	metric    string
+	profiling string
 
 	warning []string
 )
@@ -90,15 +90,11 @@ func initialize(rootCmd *cobra.Command) error {
 		"",
 		false,
 		"display only log messages to CLI output (mutually exclusive with silent)")
-	rootCmd.PersistentFlags().StringVarP(&metric,
-		"metrics",
+	rootCmd.PersistentFlags().StringVarP(&profiling,
+		"profiling",
 		"",
 		"",
-		"display metrics for the steps of kics exucution (CPU, MEM)")
-
-	if err := rootCmd.PersistentFlags().MarkHidden("metrics"); err != nil {
-		return err
-	}
+		"enables performance profiler that prints resource consumption metrics in the logs during the execution (CPU, MEM)")
 
 	if err := rootCmd.PersistentFlags().MarkDeprecated(printer.LogFileFlag, "please use --log-path instead"); err != nil {
 		return err

diff --git a/internal/console/scan.go b/internal/console/scan.go
@@ -93,7 +93,7 @@ func NewScanCmd() *cobra.Command {
 				return err
 			}
 			var err error
-			global.Metric, err = metrics.InitializeMetrics(cmd.InheritedFlags().Lookup("metrics"))
+			global.Metric, err = metrics.InitializeMetrics(cmd.InheritedFlags().Lookup("profiling"))
 			if err != nil {
 				sentry.CaptureException(err)
 				log.Err(err).Msg("Failed to initialize Metrics")

diff --git a/internal/metrics/metrics.go b/internal/metrics/metrics.go
@@ -45,7 +45,7 @@ func InitializeMetrics(metric *pflag.Flag) (*Metrics, error) {
 		metrics.Disable = true
 	default:
 		metrics.Disable = true
-		err = fmt.Errorf("unknonwn metric: %s (available metrics: cpu, mem)", metricStr)
+		err = fmt.Errorf("unknonwn metric: %s (available metrics: CPU, MEM)", metricStr)
 	}
 
 	// Create temporary dir to keep pprof file
@@ -91,7 +91,7 @@ func (m *Metrics) Stop() {
 		Msgf("Total %s usage for %s: %s", strings.ToUpper(m.metricsID), m.location, formatTotal(total, m.metric.getMap()))
 }
 
-// Get total goes through the profile samples summing their values according to
+// getTotal goes through the profile samples summing their values according to
 // the type of profile
 func getTotal(prof *profile.Profile, idx int) int64 {
 	var total, diffTotal int64