Support Async Profiler Feature

assets/graphqls/profiling/asyncprofiler/CreateTask.graphql

@@ -0,0 +1,24 @@
+# Licensed to Apache Software Foundation (ASF) under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Apache Software Foundation (ASF) licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+mutation ($condition: AsyncProfilerTaskCreationRequest!) {
+    result: createAsyncProfilerTask(asyncProfilerTaskCreationRequest: $condition) {
+        errorReason
+        code
+        id
+    }
+}

assets/graphqls/profiling/asyncprofiler/GetAnalysis.graphql

@@ -0,0 +1,31 @@
+# Licensed to Apache Software Foundation (ASF) under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Apache Software Foundation (ASF) licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+query ($condition: AsyncProfilerAnalyzationRequest!) {
+    result: queryAsyncProfilerAnalyze(request: $condition) {
+        tree {
+            type
+            elements {
+                id
+                parentId
+                codeSignature
+                total
+                self
+            }
+        }
+    }
+}

assets/graphqls/profiling/asyncprofiler/GetTaskList.graphql

@@ -0,0 +1,31 @@
+# Licensed to Apache Software Foundation (ASF) under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Apache Software Foundation (ASF) licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+query ($condition: AsyncProfilerTaskListRequest) {
+    result: queryAsyncProfilerTaskList(request: $condition) {
+        errorReason
+        tasks {
+            serviceId
+            serviceInstanceIds
+            createTime
+            events
+            duration
+            execArgs
+            id
+        }
+    }
+}

assets/graphqls/profiling/asyncprofiler/GetTaskProgress.graphql

@@ -0,0 +1,30 @@
+# Licensed to Apache Software Foundation (ASF) under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Apache Software Foundation (ASF) licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+query ($taskId: String!){
+    result: queryAsyncProfilerTaskProgress(taskId: $taskId) {
+        errorInstanceIds
+        successInstanceIds
+        logs {
+            id
+            instanceId
+            instanceName
+            operationType
+            operationTime
+        }
+    }
+}

go.mod

@@ -18,7 +18,7 @@ require (
 	gopkg.in/yaml.v2 v2.4.0
 	k8s.io/apimachinery v0.22.1
 	sigs.k8s.io/controller-runtime v0.10.0
-	skywalking.apache.org/repo/goapi v0.0.0-20240227092755-edee3273b361
+	skywalking.apache.org/repo/goapi v0.0.0-20241023080050-2514649a8007
 )
 
 require (

go.sum

@@ -879,5 +879,5 @@ sigs.k8s.io/structured-merge-diff/v4 v4.1.2 h1:Hr/htKFmJEbtMgS/UD0N+gtgctAqz81t3
 sigs.k8s.io/structured-merge-diff/v4 v4.1.2/go.mod h1:j/nl6xW8vLS49O8YvXW1ocPhZawJtm+Yrr7PPRQ0Vg4=
 sigs.k8s.io/yaml v1.2.0 h1:kr/MCeFWJWTwyaHoR9c8EjH9OumOmoF9YGiZd7lFm/Q=
 sigs.k8s.io/yaml v1.2.0/go.mod h1:yfXDCHCao9+ENCvLSE62v9VSji2MKu5jeNfTrofGhJc=
-skywalking.apache.org/repo/goapi v0.0.0-20240227092755-edee3273b361 h1:FCGGU4Tut3LI/zMRXSgJgUL/kmSQ4b7QktFgRBhqaDs=
-skywalking.apache.org/repo/goapi v0.0.0-20240227092755-edee3273b361/go.mod h1:+n8BMuS8eRdzdnGh15ElRGBXPi0eYZSs2TKySBDmRTE=
+skywalking.apache.org/repo/goapi v0.0.0-20241023080050-2514649a8007 h1:MQU9yOZxgbs7fU145wd400/E3ES/HWoxTtTCudaCBoA=
+skywalking.apache.org/repo/goapi v0.0.0-20241023080050-2514649a8007/go.mod h1:+n8BMuS8eRdzdnGh15ElRGBXPi0eYZSs2TKySBDmRTE=

internal/commands/profiling/asyncprofiler/asyncprofiler.go

@@ -0,0 +1,17 @@
+package asyncprofiler
+
+import (
+	"github.com/urfave/cli/v2"
+)
+
+var Command = &cli.Command{
+	Name:      "asyncprofiler",
+	Usage:     "async profiler related sub-command",
+	UsageText: `todo`,
+	Subcommands: []*cli.Command{
+		createCommand,
+		getTaskListCommand,
+		getTaskProgressCommand,
+		analysisCommand,
+	},
+}

internal/commands/profiling/asyncprofiler/create.go

@@ -0,0 +1,76 @@
+package asyncprofiler
+
+import (
+	"github.com/apache/skywalking-cli/internal/commands/interceptor"
+	"github.com/apache/skywalking-cli/internal/flags"
+	"github.com/apache/skywalking-cli/pkg/display"
+	"github.com/apache/skywalking-cli/pkg/display/displayable"
+	"github.com/apache/skywalking-cli/pkg/graphql/profiling"
+	"github.com/urfave/cli/v2"
+	"skywalking.apache.org/repo/goapi/query"
+	"strings"
+)
+
+var createCommand = &cli.Command{
+	Name:    "create",
+	Aliases: []string{"c"},
+	Usage:   "Create a new async profiler task",
+	UsageText: `Create a new async profiler task
+
+Examples:
+1. Create async-profiler task
+$ swctl profiling asyncprofiler create --service-name=someservicename --duration=60 --events=cpu --service-instance-ids=someinstance`,
+	Flags: flags.Flags(
+		flags.ServiceFlags,
+		[]cli.Flag{
+			&cli.StringSliceFlag{
+				Name:     "service-instance-ids",
+				Usage:    "which instances to execute task.",
+				Required: true,
+			},
+			&cli.IntFlag{
+				Name:     "duration",
+				Usage:    "task continuous time(second).",
+				Required: true,
+			},
+			&cli.StringSliceFlag{
+				Name:     "events",
+				Usage:    "which event types this task needs to collect.",
+				Required: true,
+			},
+			&cli.StringFlag{
+				Name:  "exec-args",
+				Usage: "other async-profiler execution options, e.g. alloc=2k,lock=2s.",
+			},
+		},
+	),
+	Before: interceptor.BeforeChain(
+		interceptor.ParseService(false),
+	),
+	Action: func(ctx *cli.Context) error {
+		serviceID := ctx.String("service-id")
+
+		events := ctx.StringSlice("events")
+		eventTypes := make([]query.AsyncProfilerEventType, 0)
+		for _, event := range events {
+			upperCaseEvent := strings.ToUpper(event)
+			eventTypes = append(eventTypes, query.AsyncProfilerEventType(upperCaseEvent))
+		}
+
+		execArgs := ctx.String("exec-args")
+
+		request := &query.AsyncProfilerTaskCreationRequest{
+			ServiceID:          serviceID,
+			ServiceInstanceIds: ctx.StringSlice("service-instance-ids"),
+			Duration:           ctx.Int("duration"),
+			Events:             eventTypes,
+			ExecArgs:           &execArgs,
+		}
+		task, err := profiling.CreateAsyncProfilerTask(ctx, request)
+		if err != nil {
+			return err
+		}
+
+		return display.Display(ctx, &displayable.Displayable{Data: task, Condition: request})
+	},
+}

internal/commands/profiling/asyncprofiler/getAnalyze.go

@@ -0,0 +1,59 @@
+package asyncprofiler
+
+import (
+	"github.com/apache/skywalking-cli/internal/flags"
+	"github.com/apache/skywalking-cli/pkg/display"
+	"github.com/apache/skywalking-cli/pkg/display/displayable"
+	"github.com/apache/skywalking-cli/pkg/graphql/profiling"
+	"github.com/urfave/cli/v2"
+	query "skywalking.apache.org/repo/goapi/query"
+	"strings"
+)
+
+var analysisCommand = &cli.Command{
+	Name:    "analysis",
+	Aliases: []string{"a"},
+	Usage:   "Query async-profiler analysis",
+	UsageText: `Query async-profiler analysis
+
+Examples:
+1. Query the flame graph produced by async-profiler
+$ /swctl-dev-37550c6-darwin-arm64 profiling asyncprofiler analysis  --task-id=task-id --service-instance-ids=instanceIds --event=execution_sample`,
+	Flags: flags.Flags(
+		[]cli.Flag{
+			&cli.StringFlag{
+				Name:     "task-id",
+				Usage:    "async-profiler task id",
+				Required: true,
+			},
+			&cli.StringSliceFlag{
+				Name:     "service-instance-ids",
+				Usage:    "select which service instances' jfr files to analyze",
+				Required: true,
+			},
+			&cli.StringFlag{
+				Name:     "event",
+				Usage:    "which event types this task needs to collect.",
+				Required: true,
+			},
+		},
+	),
+	Action: func(ctx *cli.Context) error {
+		event := ctx.String("event")
+		eventType := query.JFREventType(strings.ToUpper(event))
+
+		request := &query.AsyncProfilerAnalyzationRequest{
+			TaskID:      ctx.String("task-id"),
+			InstanceIds: ctx.StringSlice("service-instance-ids"),
+			EventType:   eventType,
+		}
+
+		analyze, err := profiling.GetAsyncProfilerAnalyze(ctx, request)
+
+		if err != nil {
+			return err
+		}
+
+		return display.Display(ctx, &displayable.Displayable{Data: analyze, Condition: request})
+	},
+}

internal/commands/profiling/asyncprofiler/getTaskList.go

@@ -0,0 +1,62 @@
+package asyncprofiler
+
+import (
+	"github.com/apache/skywalking-cli/internal/commands/interceptor"
+	"github.com/apache/skywalking-cli/internal/flags"
+	"github.com/apache/skywalking-cli/pkg/display"
+	"github.com/apache/skywalking-cli/pkg/display/displayable"
+	"github.com/apache/skywalking-cli/pkg/graphql/profiling"
+	"github.com/urfave/cli/v2"
+	"skywalking.apache.org/repo/goapi/query"
+)
+
+var getTaskListCommand = &cli.Command{
+	Name:    "list",
+	Aliases: []string{"l"},
+	Usage:   "Query async-profiler task list",
+	UsageText: `Query async-profiler task list
+
+Examples:
+1. Query all async-profiler tasks
+$ swctl profiling asyncprofiler list --service-name=TEST_AGENT`,
+	Flags: flags.Flags(
+		flags.ServiceFlags,
+		[]cli.Flag{
+			&cli.Int64Flag{
+				Name:  "start-time",
+				Usage: "The start time (in milliseconds) of the event, measured between the current time and midnight, January 1, 1970 UTC.",
+			},
+			&cli.Int64Flag{
+				Name:  "end-time",
+				Usage: "The end time (in milliseconds) of the event, measured between the current time and midnight, January 1, 1970 UTC.",
+			},
+			&cli.IntFlag{
+				Name:  "limit",
+				Usage: "Limit defines the number of the tasks to be returned.",
+			},
+		},
+	),
+	Before: interceptor.BeforeChain(
+		interceptor.ParseService(true),
+	),
+	Action: func(ctx *cli.Context) error {
+		serviceID := ctx.String("service-id")
+		startTime := ctx.Int64("start-time")
+		endTime := ctx.Int64("end-time")
+		limit := ctx.Int("limit")
+		request := &query.AsyncProfilerTaskListRequest{
+			ServiceID: serviceID,
+			StartTime: &startTime,
+			EndTime:   &endTime,
+			Limit:     &limit,
+		}
+
+		tasks, err := profiling.GetAsyncProfilerTaskList(ctx, request)
+
+		if err != nil {
+			return err
+		}
+
+		return display.Display(ctx, &displayable.Displayable{Data: tasks, Condition: request})
+	},
+}

internal/commands/profiling/asyncprofiler/getTaskProgress.go

@@ -0,0 +1,36 @@
+package asyncprofiler
+
+import (
+	"github.com/apache/skywalking-cli/pkg/display"
+	"github.com/apache/skywalking-cli/pkg/display/displayable"
+	"github.com/apache/skywalking-cli/pkg/graphql/profiling"
+	"github.com/urfave/cli/v2"
+)
+
+var getTaskProgressCommand = &cli.Command{
+	Name:    "progress",
+	Aliases: []string{"logs", "p"},
+	Flags: []cli.Flag{
+		&cli.StringFlag{
+			Name:  "task-id",
+			Usage: "async profiler task id.",
+		},
+	},
+	Usage: "Query async-profiler task progress",
+	UsageText: `Query async-profiler task progress
+
+Examples:
+1. Query task progress, including task logs and successInstances and errorInstances
+$ swctl-dev-37550c6-darwin-arm64 profiling asyncprofiler progress --task-id=task-id`,
+	Action: func(ctx *cli.Context) error {
+		taskID := ctx.String("task-id")
+
+		data, err := profiling.GetAsyncProfilerTaskProgress(ctx, taskID)
+
+		if err != nil {
+			return err
+		}
+
+		return display.Display(ctx, &displayable.Displayable{Data: data, Condition: taskID})
+	},
+}