Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Standardize the name of OTel SDK instrumentation and add ignore items. #138

Merged
merged 5 commits into from
Oct 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
.idea
.vscode

**/go.sum
**/vendor

otel-go-auto-instrumentation
otelbuild
otelbuild-*
*.log
.otel-build
vendor

test/errors-test/errors-test
test/helloworld/helloworld
test/httpclient/httpclient
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,15 @@ var (
SetBaggageContainerToGLS = func(interface{}) {}
)

//go:linkname ot_get_baggage_container_from_gls ot_get_baggage_container_from_gls
var ot_get_baggage_container_from_gls func() interface{}
//go:linkname otel_get_baggage_container_from_gls otel_get_baggage_container_from_gls
var otel_get_baggage_container_from_gls func() interface{}

//go:linkname ot_set_baggage_container_to_gls ot_set_baggage_container_to_gls
var ot_set_baggage_container_to_gls func(interface{})
//go:linkname otel_set_baggage_container_to_gls otel_set_baggage_container_to_gls
var otel_set_baggage_container_to_gls func(interface{})

func init() {
if ot_get_baggage_container_from_gls != nil && ot_set_baggage_container_to_gls != nil {
GetBaggageContainerFromGLS = ot_get_baggage_container_from_gls
SetBaggageContainerToGLS = ot_set_baggage_container_to_gls
if otel_get_baggage_container_from_gls != nil && otel_set_baggage_container_to_gls != nil {
GetBaggageContainerFromGLS = otel_get_baggage_container_from_gls
SetBaggageContainerToGLS = otel_set_baggage_container_to_gls
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -25,21 +25,21 @@ var (
SetBaggageContainerToGLS = func(interface{}) {}
)

//go:linkname ot_get_trace_context_from_gls ot_get_trace_context_from_gls
var ot_get_trace_context_from_gls func() interface{}
//go:linkname otel_get_trace_context_from_gls otel_get_trace_context_from_gls
var otel_get_trace_context_from_gls func() interface{}

//go:linkname ot_set_trace_context_to_gls ot_set_trace_context_to_gls
var ot_set_trace_context_to_gls func(interface{})
//go:linkname otel_set_trace_context_to_gls otel_set_trace_context_to_gls
var otel_set_trace_context_to_gls func(interface{})

//go:linkname ot_set_baggage_container_to_gls ot_set_baggage_container_to_gls
var ot_set_baggage_container_to_gls func(interface{})
//go:linkname otel_set_baggage_container_to_gls otel_set_baggage_container_to_gls
var otel_set_baggage_container_to_gls func(interface{})

func init() {
if ot_get_trace_context_from_gls != nil && ot_set_trace_context_to_gls != nil {
GetTraceContextFromGLS = ot_get_trace_context_from_gls
SetTraceContextToGLS = ot_set_trace_context_to_gls
if otel_get_trace_context_from_gls != nil && otel_set_trace_context_to_gls != nil {
GetTraceContextFromGLS = otel_get_trace_context_from_gls
SetTraceContextToGLS = otel_set_trace_context_to_gls
}
if ot_set_baggage_container_to_gls != nil {
SetBaggageContainerToGLS = ot_set_baggage_container_to_gls
if otel_set_baggage_container_to_gls != nil {
SetBaggageContainerToGLS = otel_set_baggage_container_to_gls
}
}
10 changes: 5 additions & 5 deletions pkg/rules/otsdk/rule.go → pkg/rules/otel-sdk/rule.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,18 @@
// See the License for the specific language governing permissions and
// limitations under the License.

package otsdk
package otel_sdk

import "github.com/alibaba/opentelemetry-go-auto-instrumentation/api"

func init() {
api.NewFileRule("go.opentelemetry.io/otel/sdk/trace", "ot_trace_context_linker.go").Register()
api.NewFileRule("go.opentelemetry.io/otel/sdk/trace", "trace-context/ot_trace_context.go").Register()
api.NewFileRule("go.opentelemetry.io/otel/sdk/trace", "otel_trace_context_linker.go").Register()
api.NewFileRule("go.opentelemetry.io/otel/sdk/trace", "trace-context/otel_trace_context.go").Register()
api.NewFileRule("go.opentelemetry.io/otel/sdk/trace", "trace-context/span.go").WithReplace(true).Register()
api.NewFileRule("go.opentelemetry.io/otel/sdk/trace", "trace-context/tracer.go").WithReplace(true).Register()
api.NewFileRule("go.opentelemetry.io/otel", "trace-context/trace.go").WithReplace(true).Register()
// baggage
api.NewFileRule("go.opentelemetry.io/otel/baggage", "ot_baggage_linker.go").Register()
api.NewFileRule("go.opentelemetry.io/otel/baggage", "ot_baggage_util.go").Register()
api.NewFileRule("go.opentelemetry.io/otel/baggage", "otel_baggage_linker.go").Register()
api.NewFileRule("go.opentelemetry.io/otel/baggage", "otel_baggage_util.go").Register()
api.NewFileRule("go.opentelemetry.io/otel/baggage", "baggage/context.go").WithReplace(true).Register()
}
6 changes: 3 additions & 3 deletions pkg/rules/runtime/rule.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@ import "github.com/alibaba/opentelemetry-go-auto-instrumentation/api"

func init() {
// Add tls field to struct "g" in runtime2.go
api.NewStructRule("runtime", "g", "ot_trace_context", "interface{}").
api.NewStructRule("runtime", "g", "otel_trace_context", "interface{}").
Register()
api.NewStructRule("runtime", "g", "ot_baggage_container", "interface{}").
api.NewStructRule("runtime", "g", "otel_baggage_container", "interface{}").
Register()

// This solely inspired by skywalking-go
// https://github.com/apache/skywalking-go/blob/5d7bd5e8e435ec5ab1a61793cd08e6a403893a55/tools/go-agent/instrument/runtime/instrument.go#L75
api.NewRule("runtime",
"newproc1", "", "defer func(){ retVal0.ot_trace_context = contextPropagate(callergp.ot_trace_context); retVal0.ot_baggage_container = contextPropagate(callergp.ot_baggage_container); }()", "").
"newproc1", "", "defer func(){ retVal0.otel_trace_context = contextPropagate(callergp.otel_trace_context); retVal0.otel_baggage_container = contextPropagate(callergp.otel_baggage_container); }()", "").
WithUseRaw(true).
Register()

Expand Down
32 changes: 16 additions & 16 deletions pkg/rules/runtime/runtime_linker.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,36 +19,36 @@ import (
_ "unsafe"
)

//go:linkname ot_get_trace_context_from_gls ot_get_trace_context_from_gls
var ot_get_trace_context_from_gls = _ot_gls_get_trace_context_impl
//go:linkname otel_get_trace_context_from_gls otel_get_trace_context_from_gls
var otel_get_trace_context_from_gls = _otel_gls_get_trace_context_impl

//go:linkname ot_get_baggage_container_from_gls ot_get_baggage_container_from_gls
var ot_get_baggage_container_from_gls = _ot_gls_get_baggage_container_impl
//go:linkname otel_get_baggage_container_from_gls otel_get_baggage_container_from_gls
var otel_get_baggage_container_from_gls = _otel_gls_get_baggage_container_impl

//go:linkname ot_set_trace_context_to_gls ot_set_trace_context_to_gls
var ot_set_trace_context_to_gls = _ot_gls_set_trace_context_impl
//go:linkname otel_set_trace_context_to_gls otel_set_trace_context_to_gls
var otel_set_trace_context_to_gls = _otel_gls_set_trace_context_impl

//go:linkname ot_set_baggage_container_to_gls ot_set_baggage_container_to_gls
var ot_set_baggage_container_to_gls = _ot_gls_set_baggage_container_impl
//go:linkname otel_set_baggage_container_to_gls otel_set_baggage_container_to_gls
var otel_set_baggage_container_to_gls = _otel_gls_set_baggage_container_impl

//go:nosplit
func _ot_gls_get_trace_context_impl() interface{} {
return getg().m.curg.ot_trace_context
func _otel_gls_get_trace_context_impl() interface{} {
return getg().m.curg.otel_trace_context
}

//go:nosplit
func _ot_gls_get_baggage_container_impl() interface{} {
return getg().m.curg.ot_baggage_container
func _otel_gls_get_baggage_container_impl() interface{} {
return getg().m.curg.otel_baggage_container
}

//go:nosplit
func _ot_gls_set_trace_context_impl(v interface{}) {
getg().m.curg.ot_trace_context = v
func _otel_gls_set_trace_context_impl(v interface{}) {
getg().m.curg.otel_trace_context = v
}

//go:nosplit
func _ot_gls_set_baggage_container_impl(v interface{}) {
getg().m.curg.ot_baggage_container = v
func _otel_gls_set_baggage_container_impl(v interface{}) {
getg().m.curg.otel_baggage_container = v
}

type ContextSnapshoter interface {
Expand Down
2 changes: 1 addition & 1 deletion rule_enabler.go
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ import (
_ "github.com/alibaba/opentelemetry-go-auto-instrumentation/pkg/rules/logrus"
_ "github.com/alibaba/opentelemetry-go-auto-instrumentation/pkg/rules/mongo"
_ "github.com/alibaba/opentelemetry-go-auto-instrumentation/pkg/rules/mux"
_ "github.com/alibaba/opentelemetry-go-auto-instrumentation/pkg/rules/otsdk"
_ "github.com/alibaba/opentelemetry-go-auto-instrumentation/pkg/rules/otel-sdk"
_ "github.com/alibaba/opentelemetry-go-auto-instrumentation/pkg/rules/runtime"
_ "github.com/alibaba/opentelemetry-go-auto-instrumentation/pkg/rules/test"
_ "github.com/alibaba/opentelemetry-go-auto-instrumentation/pkg/rules/zap"
Expand Down
Loading