feat: toolkit span add event impl

CHANGES.md

@@ -6,6 +6,8 @@ Release Notes.
 ------------------
 #### Features
 
+* support attaching events to span in the toolkit.
+
 #### Plugins
 
 #### Bug Fixes

plugins/trace-activation/instrument.go

@@ -95,6 +95,14 @@ func (i *Instrument) Points() []*instrument.Point {
 			PackagePath: "trace", At: instrument.NewMethodEnhance("*SpanRef", "AddLog"),
 			Interceptor: "AsyncLogInterceptor",
 		},
+		{
+			PackagePath: "trace", At: instrument.NewMethodEnhance("*SpanRef", "AddEvent"),
+			Interceptor: "AsyncAddEventInterceptor",
+		},
+		{
+			PackagePath: "trace", At: instrument.NewStaticMethodEnhance("AddEvent"),
+			Interceptor: "AddEventInterceptor",
+		},
 		{
 			PackagePath: "trace", At: instrument.NewStaticMethodEnhance("AddLog"),
 			Interceptor: "AddLogInterceptor",

plugins/trace-activation/trace/add_event_intercepter.go

@@ -0,0 +1,44 @@
+// 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 traceactivation
+
+import (
+	"github.com/apache/skywalking-go/plugins/core/operator"
+	"github.com/apache/skywalking-go/plugins/core/tracing"
+	"github.com/apache/skywalking-go/toolkit/trace"
+)
+
+type AddEventInterceptor struct {
+}
+
+func (h *AddEventInterceptor) BeforeInvoke(invocation operator.Invocation) error {
+	span := tracing.ActiveSpan()
+	if span != nil {
+		et := invocation.Args()[0].(trace.EventType)
+		event := invocation.Args()[1].(string)
+		if event == "" {
+			event = defaultEventMsg
+		}
+		span.Log(string(et), event)
+	}
+	return nil
+}
+
+func (h *AddEventInterceptor) AfterInvoke(_ operator.Invocation, _ ...interface{}) error {
+	return nil
+}

plugins/trace-activation/trace/async_add_event_intercepter.go

@@ -0,0 +1,47 @@
+// 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 traceactivation
+
+import (
+	"github.com/apache/skywalking-go/plugins/core/operator"
+	"github.com/apache/skywalking-go/plugins/core/tracing"
+	"github.com/apache/skywalking-go/toolkit/trace"
+)
+
+type AsyncAddEventInterceptor struct {
+}
+
+func (h *AsyncAddEventInterceptor) BeforeInvoke(_ operator.Invocation) error {
+	return nil
+}
+
+func (h *AsyncAddEventInterceptor) AfterInvoke(invocation operator.Invocation, _ ...interface{}) error {
+	enhanced, ok := invocation.CallerInstance().(operator.EnhancedInstance)
+	if !ok {
+		return nil
+	}
+	s := enhanced.GetSkyWalkingDynamicField().(tracing.Span)
+	et := invocation.Args()[0].(trace.EventType)
+	event := invocation.Args()[1].(string)
+	if event == "" {
+		event = defaultEventMsg
+	}
+	s.Log(string(et), event)
+	enhanced.SetSkyWalkingDynamicField(s)
+	return nil
+}

plugins/trace-activation/trace/consts.go

@@ -0,0 +1,22 @@
+// 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 traceactivation
+
+const (
+	defaultEventMsg = "unsetEvent"
+)

test/plugins/scenarios/trace-activation/config/excepted.yml

@@ -201,6 +201,22 @@ segmentItems:
             logs:
               - logEvent:
                   - { key: testAsyncLog, value: success }
+              - logEvent:
+                  - { key: warn, value: bar }
+          - operationName: testAddEvent
+            parentSpanId: 8
+            spanId: 14
+            spanLayer: Unknown
+            startTime: nq 0
+            endTime: nq 0
+            componentId: 0
+            isError: false
+            spanType: Local
+            peer: ''
+            skipAnalysis: false
+            logs:
+              - logEvent:
+                  - { key: debug, value: foo }
           - operationName: GET:/consumer
             parentSpanId: -1
             spanId: 0

test/plugins/scenarios/trace-activation/main.go

@@ -42,6 +42,7 @@ func consumerHandler(w http.ResponseWriter, r *http.Request) {
 	testContextCarrier()
 	testComponent()
 	testAsyncInCrossGoroutine()
+	testEvent()
 }
 
 func main() {

test/plugins/scenarios/trace-activation/test_service.go

@@ -30,6 +30,12 @@ func testTag() {
 	trace.StopSpan()
 }
 
+func testEvent() {
+	trace.CreateLocalSpan("testAddEvent")
+	trace.AddEvent(trace.DebugEventType, "foo")
+	trace.StopSpan()
+}
+
 func testLog() {
 	trace.CreateLocalSpan("testAddLog")
 	trace.AddLog("AddLog", "success")
@@ -112,6 +118,7 @@ func testAsyncInCrossGoroutine() {
 	go func() {
 		s.SetTag("testAsyncTag", "success")
 		s.AddLog("testAsyncLog", "success")
+		s.AddEvent(trace.WarnEventType, "bar")
 		s.AsyncFinish()
 		ch <- ""
 	}()

toolkit/trace/api.go

@@ -72,6 +72,10 @@ func SetTag(key string, value string) {
 func AddLog(...string) {
 }
 
+func AddEvent(et EventType, event string) {
+
+}
+
 func GetCorrelation(key string) string {
 	return ""
 }

toolkit/trace/span.go

@@ -17,6 +17,7 @@
 
 package trace
 
+// EventType Defines the type of Span event
 type EventType string
 
 const (

tools/go-agent/instrument/plugins/rewrite/rewrite.go

@@ -131,7 +131,7 @@ func (c *Context) rewriteTopLevelNames(files map[*FileInfo]*dst.File) {
 			case *dst.ImportSpec:
 			case *dst.TypeSpec:
 			case *dst.GenDecl:
-				if n.Tok == token.VAR && cursor.Parent() == f {
+				if (n.Tok == token.VAR || n.Tok == token.CONST) && cursor.Parent() == f {
 					for _, spec := range n.Specs {
 						if valueSpec, ok := spec.(*dst.ValueSpec); ok {
 							c.Var(valueSpec, true)