Add SortBy and GroupBy actions for Icicle Graphs (#3479)

* ui/package/profile/ProfileIcicleGraph: Add more actions

We want to add sorting to the icicle graph itself. This allows to not only sort by function name (the default and what's currently supported) but also sort by cumulative values (such that the highest functions are always left) and in compare mode by diff value (meaning the functions that got worse are left and better right).

This can make finding specific things even easier.

* proto/parca: Add optional groupBy field strings to Query

* ui/shared/profile: Add GroupBy dropdown to Arrow IcicleGraph

* ui/shared/profile: Fix small issues

* pkg/query: Fix BenchmarkQuery using RenderReport

* proto: Add missing GroupBy comment

* Re-rendering fix

---------

Co-authored-by: Manoj Vivek <p.manoj.vivek@gmail.com>

gen/proto/swagger/parca/query/v1alpha1/query.swagger.json

@@ -327,6 +327,17 @@
             "required": false,
             "type": "number",
             "format": "float"
+          },
+          {
+            "name": "groupBy.fields",
+            "description": "the names of the fields to group by.\nspecial fields are the ones prefixed with \"labels.\" which are grouping by pprof labels.",
+            "in": "query",
+            "required": false,
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "collectionFormat": "multi"
           }
         ],
         "tags": [
@@ -723,6 +734,10 @@
           "type": "number",
           "format": "float",
           "title": "node_trim_threshold is the threshold % where the nodes with Value less than this will be removed from the report"
+        },
+        "groupBy": {
+          "$ref": "#/definitions/v1alpha1GroupBy",
+          "title": "group_by indicates the fields to group by"
         }
       },
       "title": "QueryRequest is a request for a profile query"
@@ -1108,6 +1123,19 @@
       },
       "title": "FlamegraphRootNode is a root node of a flame graph"
     },
+    "v1alpha1GroupBy": {
+      "type": "object",
+      "properties": {
+        "fields": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "the names of the fields to group by.\nspecial fields are the ones prefixed with \"labels.\" which are grouping by pprof labels."
+        }
+      },
+      "title": "GroupBy encapsulates the repeated fields to group by"
+    },
     "v1alpha1LabelSet": {
       "type": "object",
       "properties": {

pkg/query/columnquery.go

@@ -180,6 +180,7 @@ func (q *ColumnQueryAPI) Query(ctx context.Context, req *pb.QueryRequest) (*pb.Q
 		req.GetReportType(),
 		req.GetNodeTrimThreshold(),
 		filtered,
+		req.GetGroupBy().GetFields(),
 	)
 }
 
@@ -240,8 +241,9 @@ func (q *ColumnQueryAPI) renderReport(
 	typ pb.QueryRequest_ReportType,
 	nodeTrimThreshold float32,
 	filtered int64,
+	groupBy []string,
 ) (*pb.QueryResponse, error) {
-	return RenderReport(ctx, q.tracer, p, typ, nodeTrimThreshold, filtered, q.tableConverterPool, q.mem)
+	return RenderReport(ctx, q.tracer, p, typ, nodeTrimThreshold, filtered, groupBy, q.tableConverterPool, q.mem)
 }
 
 func RenderReport(
@@ -251,6 +253,7 @@ func RenderReport(
 	typ pb.QueryRequest_ReportType,
 	nodeTrimThreshold float32,
 	filtered int64,
+	groupBy []string,
 	pool *sync.Pool,
 	mem memory.Allocator,
 ) (*pb.QueryResponse, error) {
@@ -291,8 +294,17 @@ func RenderReport(
 			},
 		}, nil
 	case pb.QueryRequest_REPORT_TYPE_FLAMEGRAPH_ARROW:
-		// TODO: Make the fields to aggregate by configurable via the API.
-		fa, total, err := GenerateFlamegraphArrow(ctx, mem, tracer, p, []string{FlamegraphFieldFunctionName}, nodeTrimFraction)
+		allowedGroupBy := map[string]struct{}{
+			FlamegraphFieldFunctionName: {},
+			FlamegraphFieldLabels:       {},
+		}
+		for _, f := range groupBy {
+			if _, allowed := allowedGroupBy[f]; !allowed {
+				return nil, status.Errorf(codes.InvalidArgument, "invalid group by field: %s", f)
+			}
+		}
+
+		fa, total, err := GenerateFlamegraphArrow(ctx, mem, tracer, p, groupBy, nodeTrimFraction)
 		if err != nil {
 			return nil, status.Errorf(codes.Internal, "failed to generate arrow flamegraph: %v", err.Error())
 		}

pkg/query/columnquery_test.go

@@ -1145,7 +1145,17 @@ func BenchmarkQuery(b *testing.B) {
 	b.ResetTimer()
 
 	for i := 0; i < b.N; i++ {
-		_, _ = RenderReport(ctx, tracer, sp, pb.QueryRequest_REPORT_TYPE_FLAMEGRAPH_ARROW, 0, 0, NewTableConverterPool(), memory.DefaultAllocator)
+		_, _ = RenderReport(
+			ctx,
+			tracer,
+			sp,
+			pb.QueryRequest_REPORT_TYPE_FLAMEGRAPH_ARROW,
+			0,
+			0,
+			[]string{FlamegraphFieldFunctionName},
+			NewTableConverterPool(),
+			memory.DefaultAllocator,
+		)
 	}
 }
 

proto/parca/query/v1alpha1/query.proto

@@ -240,6 +240,16 @@ message QueryRequest {
 
   // node_trim_threshold is the threshold % where the nodes with Value less than this will be removed from the report
   optional float node_trim_threshold = 7;
+
+  // group_by indicates the fields to group by
+  optional GroupBy group_by = 8;
+}
+
+// GroupBy encapsulates the repeated fields to group by
+message GroupBy {
+  // the names of the fields to group by.
+  // special fields are the ones prefixed with "labels." which are grouping by pprof labels.
+  repeated string fields = 1;
 }
 
 // Top is the top report type