feat(add trace profile for go agent)

agent/core/compile.go

@@ -20,6 +20,7 @@ package core
 import (
 	//go:nolint
 	_ "bytes"
+	_ "context"
 	_ "encoding/base64"
 	_ "fmt"
 	_ "io"
@@ -30,6 +31,7 @@ import (
 	_ "os"
 	_ "path/filepath"
 	_ "reflect"
+	_ "regexp"
 	_ "runtime"
 	_ "runtime/debug"
 	_ "runtime/metrics"
@@ -45,6 +47,7 @@ import (
 	//go:nolint
 	_ "github.com/apache/skywalking-go/agent/core/metrics"
 	_ "github.com/apache/skywalking-go/agent/core/operator"
+	_ "github.com/apache/skywalking-go/agent/core/profile"
 	_ "github.com/apache/skywalking-go/agent/core/tracing"
 	_ "github.com/apache/skywalking-go/agent/reporter"
 	_ "github.com/apache/skywalking-go/log"

agent/core/profile/compile.go

@@ -0,0 +1,41 @@
+// 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.
+
+package profile
+
+import (
+	//go:nolint
+	_ "bytes"
+	_ "context"
+	_ "fmt"
+	_ "runtime/pprof"
+	_ "strconv"
+	_ "strings"
+	_ "sync"
+	_ "sync/atomic"
+	_ "time"
+	_ "unsafe"
+
+	//go:nolint
+	_ "github.com/pkg/errors"
+
+	//go:nolint
+	_ "github.com/apache/skywalking-go/agent/core/operator"
+
+	//go:nolint
+	_ "github.com/apache/skywalking-go/agent/reporter"
+)

agent/reporter/imports.go

@@ -19,22 +19,26 @@ package reporter
 
 import (
 	// imports required packages for gRPC reporter
+	_ "bytes"
 	_ "context"
 	_ "crypto/tls"
 	_ "crypto/x509"
 	_ "fmt"
 	_ "io"
 	_ "os"
+	_ "runtime"
+	_ "runtime/pprof"
 	_ "strconv"
 	_ "strings"
 	_ "sync"
 	_ "time"
 
-	// imports the logs for reporter
+	// imports the logs and profiles for reporter
 	_ "github.com/apache/skywalking-go/agent/core/operator"
 	_ "github.com/apache/skywalking-go/log"
 
 	// imports configuration and starter for gRPC
+	_ "github.com/pkg/errors"
 	_ "google.golang.org/grpc"
 	_ "google.golang.org/grpc/backoff"
 	_ "google.golang.org/grpc/balancer"

go.work

@@ -26,6 +26,7 @@ use (
 	./plugins/rocketmq
 	./plugins/amqp
 	./plugins/pulsar
+	./plugins/pprof
 	./plugins/segmentio-kafka
 	./plugins/go-elasticsearchv8
 	./plugins/goframe
@@ -72,8 +73,10 @@ use (
 	./test/plugins/scenarios/goframe
 	./test/plugins/scenarios/so11y
 	./test/plugins/scenarios/cross-goroutine
+	./test/plugins/scenarios/pprof
 
 	./tools/go-agent
 
 	./toolkit
 )
+

plugins/core/operator/common.go

@@ -25,6 +25,7 @@ var MetricsCollectAppender = func(func()) {}
 type Operator interface {
 	Tracing() interface{}     // to TracingOperator
 	Logger() interface{}      // to LogOperator
+	Profiler() interface{}    // to ProfileOperator
 	Tools() interface{}       // to ToolsOperator
 	DebugStack() []byte       // Getting the stack of the current goroutine, for getting details when plugin broken.
 	Entity() interface{}      // Get the entity of the service

plugins/core/operator/profiler.go

@@ -0,0 +1,23 @@
+// Licensed to the 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.  The 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.
+
+package operator
+
+type ProfileOperator interface {
+	// GetNowLabels get skywalking internal labels from goroutine,avoid covered by user
+	GetNowLabels() interface{}
+}

plugins/core/prof_labels.go

@@ -0,0 +1,221 @@
+// Licensed to the 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.  The 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.
+
+package core
+
+import (
+	"context"
+	"regexp"
+	"runtime"
+	"runtime/pprof"
+	"sort"
+	"strconv"
+	"unsafe"
+)
+
+type label struct {
+	key   string
+	value string
+}
+
+type LabelSet struct {
+	list []label
+}
+
+type labelMap struct {
+	LabelSet
+}
+
+type labelMap19 map[string]string
+
+type labelContextKey struct{}
+
+//go:linkname runtimeGetProfLabel runtime/pprof.runtime_getProfLabel
+func runtimeGetProfLabel() unsafe.Pointer
+
+//go:linkname runtimeSetProfLabel runtime/pprof.runtime_setProfLabel
+func runtimeSetProfLabel(label unsafe.Pointer)
+
+func setGoroutineLabelsInternal(ctx context.Context) {
+	if isGoVersionLMoreThan120(runtime.Version()) {
+		ctxLabels, _ := ctx.Value(labelContextKey{}).(*labelMap)
+		runtimeSetProfLabel(unsafe.Pointer(ctxLabels))
+		return
+	}
+	ctxLabels, _ := ctx.Value(labelContextKey{}).(*labelMap19)
+	runtimeSetProfLabel(unsafe.Pointer(ctxLabels))
+}
+
+func labelValue(ctx context.Context) labelMap19 {
+	labels, _ := ctx.Value(labelContextKey{}).(*labelMap19)
+	if labels == nil {
+		return labelMap19(nil)
+	}
+	return *labels
+}
+
+func WithLabels(ctx context.Context, s LabelSet) context.Context {
+	if isGoVersionLMoreThan120(runtime.Version()) {
+		ctx = context.WithValue(ctx, labelContextKey{}, &labelMap{s})
+		return ctx
+	}
+	return withLabels19(ctx, s)
+}
+
+func withLabels19(ctx context.Context, labels LabelSet) context.Context {
+	childLabels := make(labelMap19)
+	parentLabels := labelValue(ctx)
+	for k, v := range parentLabels {
+		childLabels[k] = v
+	}
+	for _, label := range labels.list {
+		childLabels[label.key] = label.value
+	}
+	return context.WithValue(ctx, labelContextKey{}, &childLabels)
+}
+
+func GetNowLabelSet() LabelSet {
+	pl := LabelSet{
+		list: make([]label, 0),
+	}
+	p := runtimeGetProfLabel()
+	if p != nil {
+		version := runtime.Version()
+		if !isGoVersionLMoreThan120(version) {
+			// Go1.19：map[string]string -> []label
+			m := *(*labelMap19)(p)
+			pl.list = make([]label, 0, len(m))
+			for k, v := range m {
+				pl.list = append(pl.list, label{key: k, value: v})
+			}
+		} else {
+			lm := (*labelMap)(p)
+			pl.list = lm.list
+		}
+	}
+	return pl
+}
+
+// isGoVersionLMoreThan120 parses version strings like "go1.19.8"
+func isGoVersionLMoreThan120(version string) bool {
+	re := regexp.MustCompile(`go(\d+)\.(\d+)`)
+	sub := re.FindStringSubmatch(version)
+	if len(sub) != 3 {
+		return false
+	}
+	major, err1 := strconv.Atoi(sub[1])
+	minor, err2 := strconv.Atoi(sub[2])
+	if err1 != nil || err2 != nil {
+		return false
+	}
+	if major < 1 {
+		return false
+	}
+	if major > 1 {
+		return true
+	}
+	return minor >= 20
+}
+
+func (m *ProfileManager) AddSkyLabels(traceID, segmentID string, spanID int32) interface{} {
+	pl := GetNowLabelSet()
+	re := UpdateTraceLabels(pl, TraceLabel, traceID, SegmentLabel, segmentID, SpanLabel, parseString(spanID))
+	return &re
+}
+
+func (m *ProfileManager) TurnToPprofLabel(l *LabelSet) pprof.LabelSet {
+	li := l.List()
+	if len(li) == 0 {
+		return pprof.LabelSet{}
+	}
+	re := pprof.Labels(li...)
+	return re
+}
+
+func UpdateTraceLabels(s LabelSet, args ...string) LabelSet {
+	if len(args)%2 != 0 {
+		panic("uneven number of arguments to profile.UpdateTraceLabels")
+	}
+
+	// add first
+	for i := 0; i < len(args); i += 2 {
+		s.list = append(s.list, label{key: args[i], value: args[i+1]})
+	}
+
+	// sort
+	sort.SliceStable(s.list, func(i, j int) bool {
+		return s.list[i].key < s.list[j].key
+	})
+
+	// remove duplicates
+	deduped := make([]label, 0, len(s.list))
+	for i, lbl := range s.list {
+		if i == 0 || lbl.key != s.list[i-1].key {
+			deduped = append(deduped, lbl)
+		} else {
+			deduped[len(deduped)-1] = lbl
+		}
+	}
+	s.list = deduped
+
+	return s
+}
+
+func (s *LabelSet) List() []string {
+	var ret []string
+	for _, v := range s.list {
+		ret = append(ret, v.key, v.value)
+	}
+	return ret
+}
+
+func SetGoroutineLabels(s *LabelSet) {
+	if s.IsEmpty() {
+		var c = context.Background()
+		setGoroutineLabelsInternal(c)
+		return
+	}
+	var c = context.Background()
+	l := *s
+	c = WithLabels(c, l)
+	setGoroutineLabelsInternal(c)
+}
+
+func extractSkyInternalLabels(s LabelSet) LabelSet {
+	re := LabelSet{list: make([]label, 0)}
+	for _, l := range s.list {
+		if l.key == SpanLabel || l.key == SegmentLabel || l.key == TraceLabel || l.key == MinDurationLabel {
+			re.list = append(re.list, l)
+		}
+	}
+	return re
+}
+
+// GetNowLabels Expose to operator
+func (m *ProfileManager) GetNowLabels() interface{} {
+	row := GetNowLabelSet()
+	filter := extractSkyInternalLabels(row)
+	re := m.TurnToPprofLabel(&filter)
+	return re
+}
+
+func (s *LabelSet) IsEmpty() bool {
+	if s == nil || s.list == nil {
+		return true
+	}
+	return len(s.list) == 0
+}