Allign database/sql instrumentation to the latest changes from main branch

Author: RonFed

CHANGELOG.md

@@ -8,6 +8,9 @@ OpenTelemetry Go Automatic Instrumentation adheres to [Semantic Versioning](http
 
 ## [Unreleased]
 
+### Added
+- Add database/sql instrumentation ([#240](https://github.com/open-telemetry/opentelemetry-go-instrumentation/pull/240))
+
 ### Changed
 
 - The function signature of `"go.opentelemetry.io/auto/offsets-tracker/downloader".DownloadBinary` has changed.
@@ -64,7 +67,6 @@ OpenTelemetry Go Automatic Instrumentation adheres to [Semantic Versioning](http
 - Add ARM64 support. ([#82](https://github.com/open-telemetry/opentelemetry-go-instrumentation/pull/82))
 - Add `OTEL_GO_AUTO_SHOW_VERIFIER_LOG` environment variable to control whether
   the verifier log is shown. ([#128](https://github.com/open-telemetry/opentelemetry-go-instrumentation/pull/128))
-- Add database/sql instrumentation ([#240](https://github.com/open-telemetry/opentelemetry-go-instrumentation/pull/240))
 
 ### Changed
 

pkg/instrumentors/bpf/database/sql/bpf/probe.bpf.c

@@ -1,19 +1,31 @@
+// Copyright The OpenTelemetry Authors
+//
+// Licensed 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.
+
 #include "arguments.h"
 #include "span_context.h"
 #include "go_context.h"
 #include "go_types.h"
+#include "uprobe.h"
 
 char __license[] SEC("license") = "Dual MIT/GPL";
 
 #define MAX_QUERY_SIZE 100
 #define MAX_CONCURRENT 50
 
 struct sql_request_t {
-    u64 start_time;
-    u64 end_time;
+    BASE_SPAN_PROPERTIES
     char query[MAX_QUERY_SIZE];
-    struct span_context sc;
-    struct span_context psc;
 };
 
 struct {
@@ -74,22 +86,4 @@ int uprobe_queryDC(struct pt_regs *ctx) {
 
 // This instrumentation attaches uprobe to the following function:
 // func (db *DB) queryDC(ctx, txctx context.Context, dc *driverConn, releaseConn func(error), query string, args []any)
-SEC("uprobe/queryDC")
-int uprobe_queryDC_Returns(struct pt_regs *ctx) {
-    u64 context_ptr_pos = 3;
-    // Find the corresponding sql event we return from
-    void *context_ptr = get_argument(ctx, context_ptr_pos);
-    void *key = get_consistent_key(ctx, context_ptr);
-    void *sqlReq_ptr = bpf_map_lookup_elem(&sql_events, &key);
-
-    struct sql_request_t sqlReq = {0};
-    bpf_probe_read(&sqlReq, sizeof(sqlReq), sqlReq_ptr);
-    sqlReq.end_time = bpf_ktime_get_ns();
-
-    // Send event
-    bpf_perf_event_output(ctx, &events, BPF_F_CURRENT_CPU, &sqlReq, sizeof(sqlReq));
-    // Clean the sql event
-    bpf_map_delete_elem(&sql_events, &key);
-    stop_tracking_span(&sqlReq.sc);
-    return 0;
-}
+UPROBE_RETURN(queryDC, struct sql_request_t, 3, 0, sql_events, events)

pkg/instrumentors/bpf/database/sql/bpf_bpfel_arm64.go

@@ -40,14 +40,13 @@ import (
 
 //go:generate go run github.com/cilium/ebpf/cmd/bpf2go -target amd64,arm64 -cc clang -cflags $CFLAGS bpf ./bpf/probe.bpf.c
 
+const instrumentedPkg = "database/sql"
+
 // Event represents an event in an SQL database
 // request-response.
 type Event struct {
-	StartTime         uint64
-	EndTime           uint64
-	Query             [100]byte
-	SpanContext       context.EBPFSpanContext
-	ParentSpanContext context.EBPFSpanContext
+	context.BaseSpanProperties
+	Query [100]byte
 }
 
 // Instrumentor is the database/sql instrumentor.
@@ -68,7 +67,7 @@ func New() *Instrumentor {
 
 // LibraryName returns the database/sql/ package name.
 func (h *Instrumentor) LibraryName() string {
-	return "database/sql"
+	return instrumentedPkg
 }
 
 // FuncNames returns the function names from "database/sql" that are instrumented.

pkg/instrumentors/bpf/database/sql/bpf_bpfel_x86.go

@@ -0,0 +1,65 @@
+// Copyright The OpenTelemetry Authors
+//
+// Licensed 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 sql
+
+import (
+	"testing"
+	"time"
+
+	"github.com/stretchr/testify/assert"
+
+	"go.opentelemetry.io/auto/pkg/instrumentors/context"
+	"go.opentelemetry.io/auto/pkg/instrumentors/events"
+	"go.opentelemetry.io/otel/attribute"
+	semconv "go.opentelemetry.io/otel/semconv/v1.7.0"
+	"go.opentelemetry.io/otel/trace"
+)
+
+func TestInstrumentorConvertEvent(t *testing.T) {
+	start := time.Now()
+	end := start.Add(1 * time.Second)
+
+	traceID := trace.TraceID{1}
+	spanID := trace.SpanID{1}
+
+	i := New()
+	got := i.convertEvent(&Event{
+		BaseSpanProperties: context.BaseSpanProperties{
+			StartTime:   uint64(start.UnixNano()),
+			EndTime:     uint64(end.UnixNano()),
+			SpanContext: context.EBPFSpanContext{TraceID: traceID, SpanID: spanID},
+		},
+		// "SELECT * FROM foo"
+		Query: [100]byte{0x53, 0x45, 0x4c, 0x45, 0x43, 0x54, 0x20, 0x2a, 0x20, 0x46, 0x52, 0x4f, 0x4d, 0x20, 0x66, 0x6f, 0x6f},
+	})
+
+	sc := trace.NewSpanContext(trace.SpanContextConfig{
+		TraceID:    traceID,
+		SpanID:     spanID,
+		TraceFlags: trace.FlagsSampled,
+	})
+	want := &events.Event{
+		Library:     instrumentedPkg,
+		Name:        "DB",
+		Kind:        trace.SpanKindClient,
+		StartTime:   int64(start.UnixNano()),
+		EndTime:     int64(end.UnixNano()),
+		SpanContext: &sc,
+		Attributes: []attribute.KeyValue{
+			semconv.DBStatementKey.String("SELECT * FROM foo"),
+		},
+	}
+	assert.Equal(t, want, got)
+}