Small Improvements

Author: AlexsanderHamir

cli/api.go

@@ -70,7 +70,7 @@ func createProfAuto() *cobra.Command {
 	profileFlag := "profiles"
 	tagFlag := "tag"
 	countFlag := "count"
-	example := fmt.Sprintf(`prof %s --%s BenchmarkGenPool --%s cpu,memory --%s 10 --%s "tag1"`, shared.AUTOCMD, benchFlag, profileFlag, countFlag, tagFlag)
+	example := fmt.Sprintf(`prof %s --%s "BenchmarkGenPool" --%s "cpu,memory" --%s 10 --%s "tag1"`, shared.AUTOCMD, benchFlag, profileFlag, countFlag, tagFlag)
 
 	cmd := &cobra.Command{
 		Use:     shared.AUTOCMD,
@@ -79,8 +79,8 @@ func createProfAuto() *cobra.Command {
 		Example: example,
 	}
 
-	cmd.Flags().StringSliceVar(&benchmarks, benchFlag, []string{}, `Benchmarks to run (e.g., "[BenchmarkGenPool]")"`)
-	cmd.Flags().StringSliceVar(&profiles, profileFlag, []string{}, `Profiles to use (e.g., "[cpu,memory,mutex]")`)
+	cmd.Flags().StringSliceVar(&benchmarks, benchFlag, []string{}, `Benchmarks to run (e.g., "BenchmarkGenPool")"`)
+	cmd.Flags().StringSliceVar(&profiles, profileFlag, []string{}, `Profiles to use (e.g., "cpu,memory,mutex")`)
 	cmd.Flags().StringVar(&tag, tagFlag, "", "The tag is used to organize the results")
 	cmd.Flags().IntVar(&count, countFlag, 0, "Number of runs")
 
@@ -114,9 +114,11 @@ func createTrackAutoCmd() *cobra.Command {
 	outputFormatFlag := "output-format"
 	example := fmt.Sprintf(`prof track auto --%s "tag1" --%s "tag2" --%s "cpu" --%s "BenchmarkGenPool" --%s "summary"`, baseTagFlag, currentTagFlag, profileTypeFlag, benchNameFlag, outputFormatFlag)
 	longExplanation := fmt.Sprintf("This command only works if the %s command was used to collect and organize the benchmark and profile data, as it expects a specific directory structure generated by that process.", shared.AUTOCMD)
+	shortExplanation := "If prof auto was used to collect the data, track auto can be used to analyze it, you just have to pass the tag name."
 
 	cmd := &cobra.Command{
 		Use:     shared.TrackAutoCMD,
+		Short:   shortExplanation,
 		Long:    longExplanation,
 		RunE:    runTrackAuto,
 		Example: example,

engine/benchmark/helpers.go

@@ -121,11 +121,17 @@ func runBenchmarkCommand(cmd []string, outputFile string) error {
 	execCmd := exec.Command(cmd[0], cmd[1:]...)
 
 	output, err := execCmd.CombinedOutput()
+
+	// Always print the output, even if there was an error - it may contain meaningful information
+	fmt.Println("🚀 ==================== BENCHMARK OUTPUT ==================== 🚀")
+	fmt.Println(string(output))
+	fmt.Println("📊 ========================================================== 📊")
+
 	if err != nil {
 		if strings.Contains(string(output), moduleNotFoundMsg) {
-			return fmt.Errorf("%s - ensure you're in a Go project directory", moduleNotFoundMsg)
+			return fmt.Errorf("❌ %s - ensure you're in a Go project directory 📁", moduleNotFoundMsg)
 		}
-		return errors.New(string(output))
+		return fmt.Errorf("💥 BENCHMARK COMMAND FAILED 💥\n%s", string(output))
 	}
 
 	return os.WriteFile(outputFile, output, shared.PermFile)