Switch SpanEvent times to use time.Time

Use `time.Time`, a timestamp, to identify the start and end time of the `SpanEvent` instead of representing them as nanoseconds since boot time in a built-in `int64`. This is motivate by the need to support things that report timestamps for start/end times directly. Things like the custom SDK (see #1045). To support the conversion for probes, the `utils.BootOffsetToTime` function is added. This converts between the measured nanoseconds since boot-time that an eBPF program measures, and a timestamp.
open-telemetry · Sep 12, 2024 · 3b14c98 · 3b14c98
1 parent 8f33bc4
commit 3b14c98
Show file tree

Hide file tree

Showing 21 changed files with 140 additions and 87 deletions.
diff --git a/internal/pkg/instrumentation/bpf/database/sql/probe.go b/internal/pkg/instrumentation/bpf/database/sql/probe.go
@@ -15,6 +15,7 @@ import (
 
 	"go.opentelemetry.io/auto/internal/pkg/instrumentation/context"
 	"go.opentelemetry.io/auto/internal/pkg/instrumentation/probe"
+	"go.opentelemetry.io/auto/internal/pkg/instrumentation/utils"
 )
 
 //go:generate go run github.com/cilium/ebpf/cmd/bpf2go -target amd64,arm64 -cc clang -cflags $CFLAGS bpf ./bpf/probe.bpf.c
@@ -96,8 +97,8 @@ func convertEvent(e *event) []*probe.SpanEvent {
 	return []*probe.SpanEvent{
 		{
 			SpanName:    "DB",
-			StartTime:   int64(e.StartTime),
-			EndTime:     int64(e.EndTime),
+			StartTime:   utils.BootOffsetToTime(e.StartTime),
+			EndTime:     utils.BootOffsetToTime(e.EndTime),
 			SpanContext: &sc,
 			Attributes: []attribute.KeyValue{
 				semconv.DBQueryText(query),

diff --git a/internal/pkg/instrumentation/bpf/database/sql/probe_test.go b/internal/pkg/instrumentation/bpf/database/sql/probe_test.go
@@ -41,8 +41,8 @@ func TestProbeConvertEvent(t *testing.T) {
 	})
 	want := &probe.SpanEvent{
 		SpanName:    "DB",
-		StartTime:   int64(start.UnixNano()),
-		EndTime:     int64(end.UnixNano()),
+		StartTime:   start,
+		EndTime:     end,
 		SpanContext: &sc,
 		Attributes: []attribute.KeyValue{
 			semconv.DBQueryText("SELECT * FROM foo"),

diff --git a/internal/pkg/instrumentation/bpf/github.com/segmentio/kafka-go/consumer/probe.go b/internal/pkg/instrumentation/bpf/github.com/segmentio/kafka-go/consumer/probe.go
@@ -15,6 +15,7 @@ import (
 
 	"go.opentelemetry.io/auto/internal/pkg/instrumentation/context"
 	"go.opentelemetry.io/auto/internal/pkg/instrumentation/probe"
+	"go.opentelemetry.io/auto/internal/pkg/instrumentation/utils"
 	"go.opentelemetry.io/auto/internal/pkg/structfield"
 )
 
@@ -122,8 +123,8 @@ func convertEvent(e *event) []*probe.SpanEvent {
 	return []*probe.SpanEvent{
 		{
 			SpanName:          kafkaConsumerSpanName(topic),
-			StartTime:         int64(e.StartTime),
-			EndTime:           int64(e.EndTime),
+			StartTime:         utils.BootOffsetToTime(e.StartTime),
+			EndTime:           utils.BootOffsetToTime(e.EndTime),
 			SpanContext:       &sc,
 			ParentSpanContext: pscPtr,
 			Attributes:        attributes,

diff --git a/internal/pkg/instrumentation/bpf/github.com/segmentio/kafka-go/consumer/probe_test.go b/internal/pkg/instrumentation/bpf/github.com/segmentio/kafka-go/consumer/probe_test.go
@@ -47,8 +47,8 @@ func TestProbeConvertEvent(t *testing.T) {
 	})
 	want := &probe.SpanEvent{
 		SpanName:    kafkaConsumerSpanName("topic1"),
-		StartTime:   int64(start.UnixNano()),
-		EndTime:     int64(end.UnixNano()),
+		StartTime:   start,
+		EndTime:     end,
 		SpanContext: &sc,
 		Attributes: []attribute.KeyValue{
 			semconv.MessagingSystemKafka,

diff --git a/internal/pkg/instrumentation/bpf/github.com/segmentio/kafka-go/producer/probe.go b/internal/pkg/instrumentation/bpf/github.com/segmentio/kafka-go/producer/probe.go
@@ -14,6 +14,7 @@ import (
 
 	"go.opentelemetry.io/auto/internal/pkg/instrumentation/context"
 	"go.opentelemetry.io/auto/internal/pkg/instrumentation/probe"
+	"go.opentelemetry.io/auto/internal/pkg/instrumentation/utils"
 	"go.opentelemetry.io/auto/internal/pkg/structfield"
 )
 
@@ -138,8 +139,8 @@ func convertEvent(e *event) []*probe.SpanEvent {
 
 		res = append(res, &probe.SpanEvent{
 			SpanName:          kafkaProducerSpanName(msgTopic),
-			StartTime:         int64(e.StartTime),
-			EndTime:           int64(e.EndTime),
+			StartTime:         utils.BootOffsetToTime(e.StartTime),
+			EndTime:           utils.BootOffsetToTime(e.EndTime),
 			SpanContext:       &sc,
 			Attributes:        msgAttrs,
 			ParentSpanContext: pscPtr,

diff --git a/internal/pkg/instrumentation/bpf/github.com/segmentio/kafka-go/producer/probe_test.go b/internal/pkg/instrumentation/bpf/github.com/segmentio/kafka-go/producer/probe_test.go
@@ -63,8 +63,8 @@ func TestProbeConvertEvent(t *testing.T) {
 	})
 	want1 := &probe.SpanEvent{
 		SpanName:    kafkaProducerSpanName("topic1"),
-		StartTime:   int64(start.UnixNano()),
-		EndTime:     int64(end.UnixNano()),
+		StartTime:   start,
+		EndTime:     end,
 		SpanContext: &sc1,
 		Attributes: []attribute.KeyValue{
 			semconv.MessagingKafkaMessageKey("key1"),
@@ -78,8 +78,8 @@ func TestProbeConvertEvent(t *testing.T) {
 
 	want2 := &probe.SpanEvent{
 		SpanName:    kafkaProducerSpanName("topic2"),
-		StartTime:   int64(start.UnixNano()),
-		EndTime:     int64(end.UnixNano()),
+		StartTime:   start,
+		EndTime:     end,
 		SpanContext: &sc2,
 		Attributes: []attribute.KeyValue{
 			semconv.MessagingKafkaMessageKey("key2"),

diff --git a/internal/pkg/instrumentation/bpf/go.opentelemetry.io/otel/traceglobal/probe.go b/internal/pkg/instrumentation/bpf/go.opentelemetry.io/otel/traceglobal/probe.go
@@ -10,6 +10,7 @@ import (
 
 	"go.opentelemetry.io/auto/internal/pkg/inject"
 	"go.opentelemetry.io/auto/internal/pkg/instrumentation/probe"
+	"go.opentelemetry.io/auto/internal/pkg/instrumentation/utils"
 	"go.opentelemetry.io/auto/internal/pkg/process"
 	"go.opentelemetry.io/auto/internal/pkg/structfield"
 
@@ -207,8 +208,8 @@ func convertEvent(e *event) []*probe.SpanEvent {
 	return []*probe.SpanEvent{
 		{
 			SpanName:          spanName,
-			StartTime:         int64(e.StartTime),
-			EndTime:           int64(e.EndTime),
+			StartTime:         utils.BootOffsetToTime(e.StartTime),
+			EndTime:           utils.BootOffsetToTime(e.EndTime),
 			Attributes:        convertAttributes(e.Attributes),
 			SpanContext:       &sc,
 			ParentSpanContext: pscPtr,

diff --git a/internal/pkg/instrumentation/bpf/go.opentelemetry.io/otel/traceglobal/probe_test.go b/internal/pkg/instrumentation/bpf/go.opentelemetry.io/otel/traceglobal/probe_test.go
@@ -104,8 +104,8 @@ func TestProbeConvertEvent(t *testing.T) {
 	})
 	want := &probe.SpanEvent{
 		SpanName:    "Foo",
-		StartTime:   int64(start.UnixNano()),
-		EndTime:     int64(end.UnixNano()),
+		StartTime:   start,
+		EndTime:     end,
 		SpanContext: &sc,
 		Attributes: []attribute.KeyValue{
 			attribute.Bool("bool_key", true),

diff --git a/internal/pkg/instrumentation/bpf/google.golang.org/grpc/client/probe.go b/internal/pkg/instrumentation/bpf/google.golang.org/grpc/client/probe.go
@@ -147,8 +147,8 @@ func convertEvent(e *event) []*probe.SpanEvent {
 
 	event := &probe.SpanEvent{
 		SpanName:          method,
-		StartTime:         int64(e.StartTime),
-		EndTime:           int64(e.EndTime),
+		StartTime:         utils.BootOffsetToTime(e.StartTime),
+		EndTime:           utils.BootOffsetToTime(e.EndTime),
 		Attributes:        attrs,
 		SpanContext:       &sc,
 		ParentSpanContext: pscPtr,

diff --git a/internal/pkg/instrumentation/bpf/google.golang.org/grpc/server/probe.go b/internal/pkg/instrumentation/bpf/google.golang.org/grpc/server/probe.go
@@ -16,6 +16,7 @@ import (
 	"go.opentelemetry.io/auto/internal/pkg/inject"
 	"go.opentelemetry.io/auto/internal/pkg/instrumentation/context"
 	"go.opentelemetry.io/auto/internal/pkg/instrumentation/probe"
+	"go.opentelemetry.io/auto/internal/pkg/instrumentation/utils"
 	"go.opentelemetry.io/auto/internal/pkg/process"
 	"go.opentelemetry.io/auto/internal/pkg/structfield"
 )
@@ -127,8 +128,8 @@ func convertEvent(e *event) []*probe.SpanEvent {
 	return []*probe.SpanEvent{
 		{
 			SpanName:  method,
-			StartTime: int64(e.StartTime),
-			EndTime:   int64(e.EndTime),
+			StartTime: utils.BootOffsetToTime(e.StartTime),
+			EndTime:   utils.BootOffsetToTime(e.EndTime),
 			Attributes: []attribute.KeyValue{
 				semconv.RPCSystemKey.String("grpc"),
 				semconv.RPCServiceKey.String(method),

diff --git a/internal/pkg/instrumentation/bpf/net/http/client/probe.go b/internal/pkg/instrumentation/bpf/net/http/client/probe.go
@@ -274,8 +274,8 @@ func convertEvent(e *event) []*probe.SpanEvent {
 
 	spanEvent := &probe.SpanEvent{
 		SpanName:          method,
-		StartTime:         int64(e.StartTime),
-		EndTime:           int64(e.EndTime),
+		StartTime:         utils.BootOffsetToTime(e.StartTime),
+		EndTime:           utils.BootOffsetToTime(e.EndTime),
 		SpanContext:       &sc,
 		Attributes:        attrs,
 		ParentSpanContext: pscPtr,

diff --git a/internal/pkg/instrumentation/bpf/net/http/client/probe_test.go b/internal/pkg/instrumentation/bpf/net/http/client/probe_test.go
@@ -96,8 +96,8 @@ func TestConvertEvent(t *testing.T) {
 				{
 					SpanName:    methodString,
 					SpanContext: &spanContext,
-					StartTime:   startTime.Unix(),
-					EndTime:     endTime.Unix(),
+					StartTime:   startTime,
+					EndTime:     endTime,
 					Attributes: []attribute.KeyValue{
 						semconv.HTTPRequestMethodKey.String(methodString),
 						semconv.HTTPResponseStatusCodeKey.Int(200),
@@ -129,8 +129,8 @@ func TestConvertEvent(t *testing.T) {
 				{
 					SpanName:    methodString,
 					SpanContext: &spanContext,
-					StartTime:   startTime.Unix(),
-					EndTime:     endTime.Unix(),
+					StartTime:   startTime,
+					EndTime:     endTime,
 					Attributes: []attribute.KeyValue{
 						semconv.HTTPRequestMethodKey.String(methodString),
 						semconv.HTTPResponseStatusCodeKey.Int(400),
@@ -163,8 +163,8 @@ func TestConvertEvent(t *testing.T) {
 				{
 					SpanName:    methodString,
 					SpanContext: &spanContext,
-					StartTime:   startTime.Unix(),
-					EndTime:     endTime.Unix(),
+					StartTime:   startTime,
+					EndTime:     endTime,
 					Attributes: []attribute.KeyValue{
 						semconv.HTTPRequestMethodKey.String(methodString),
 						semconv.HTTPResponseStatusCodeKey.Int(500),
@@ -197,8 +197,8 @@ func TestConvertEvent(t *testing.T) {
 				{
 					SpanName:    methodString,
 					SpanContext: &spanContext,
-					StartTime:   startTime.Unix(),
-					EndTime:     endTime.Unix(),
+					StartTime:   startTime,
+					EndTime:     endTime,
 					Attributes: []attribute.KeyValue{
 						semconv.HTTPRequestMethodKey.String(methodString),
 						semconv.HTTPResponseStatusCodeKey.Int(200),
@@ -234,8 +234,8 @@ func TestConvertEvent(t *testing.T) {
 				{
 					SpanName:    methodString,
 					SpanContext: &spanContext,
-					StartTime:   startTime.Unix(),
-					EndTime:     endTime.Unix(),
+					StartTime:   startTime,
+					EndTime:     endTime,
 					Attributes: []attribute.KeyValue{
 						semconv.HTTPRequestMethodKey.String(methodString),
 						semconv.HTTPResponseStatusCodeKey.Int(200),
@@ -271,8 +271,8 @@ func TestConvertEvent(t *testing.T) {
 				{
 					SpanName:    methodString,
 					SpanContext: &spanContext,
-					StartTime:   startTime.Unix(),
-					EndTime:     endTime.Unix(),
+					StartTime:   startTime,
+					EndTime:     endTime,
 					Attributes: []attribute.KeyValue{
 						semconv.HTTPRequestMethodKey.String(methodString),
 						semconv.HTTPResponseStatusCodeKey.Int(200),

diff --git a/internal/pkg/instrumentation/bpf/net/http/server/probe.go b/internal/pkg/instrumentation/bpf/net/http/server/probe.go
@@ -18,6 +18,7 @@ import (
 	"go.opentelemetry.io/auto/internal/pkg/instrumentation/bpf/net/http"
 	"go.opentelemetry.io/auto/internal/pkg/instrumentation/context"
 	"go.opentelemetry.io/auto/internal/pkg/instrumentation/probe"
+	"go.opentelemetry.io/auto/internal/pkg/instrumentation/utils"
 	"go.opentelemetry.io/auto/internal/pkg/process"
 	"go.opentelemetry.io/auto/internal/pkg/structfield"
 )
@@ -211,8 +212,8 @@ func convertEvent(e *event) []*probe.SpanEvent {
 
 	spanEvent := &probe.SpanEvent{
 		SpanName:          spanName,
-		StartTime:         int64(e.StartTime),
-		EndTime:           int64(e.EndTime),
+		StartTime:         utils.BootOffsetToTime(e.StartTime),
+		EndTime:           utils.BootOffsetToTime(e.EndTime),
 		SpanContext:       &sc,
 		ParentSpanContext: pscPtr,
 		Attributes:        attributes,

diff --git a/internal/pkg/instrumentation/bpf/net/http/server/probe_test.go b/internal/pkg/instrumentation/bpf/net/http/server/probe_test.go
@@ -16,10 +16,11 @@ import (
 
 	"go.opentelemetry.io/auto/internal/pkg/instrumentation/context"
 	"go.opentelemetry.io/auto/internal/pkg/instrumentation/probe"
+	"go.opentelemetry.io/auto/internal/pkg/instrumentation/utils"
 )
 
 func TestProbeConvertEvent(t *testing.T) {
-	start := time.Now()
+	start := time.Unix(0, 1)
 	end := start.Add(1 * time.Second)
 
 	traceID := trace.TraceID{1}
@@ -58,8 +59,8 @@ func TestProbeConvertEvent(t *testing.T) {
 			expected: []*probe.SpanEvent{
 				{
 					SpanName:    "GET",
-					StartTime:   int64(start.UnixNano()),
-					EndTime:     int64(end.UnixNano()),
+					StartTime:   start,
+					EndTime:     end,
 					SpanContext: &sc,
 					Attributes: []attribute.KeyValue{
 						semconv.HTTPRequestMethodKey.String("GET"),
@@ -98,8 +99,8 @@ func TestProbeConvertEvent(t *testing.T) {
 			expected: []*probe.SpanEvent{
 				{
 					SpanName:    "GET",
-					StartTime:   int64(start.UnixNano()),
-					EndTime:     int64(end.UnixNano()),
+					StartTime:   start,
+					EndTime:     end,
 					SpanContext: &sc,
 					Attributes: []attribute.KeyValue{
 						semconv.HTTPRequestMethodKey.String("GET"),
@@ -139,8 +140,8 @@ func TestProbeConvertEvent(t *testing.T) {
 			expected: []*probe.SpanEvent{
 				{
 					SpanName:    "GET",
-					StartTime:   int64(start.UnixNano()),
-					EndTime:     int64(end.UnixNano()),
+					StartTime:   start,
+					EndTime:     end,
 					SpanContext: &sc,
 					Attributes: []attribute.KeyValue{
 						semconv.HTTPRequestMethodKey.String("GET"),
@@ -160,8 +161,8 @@ func TestProbeConvertEvent(t *testing.T) {
 			name: "server statuscode 500 sets span.Status",
 			event: &event{
 				BaseSpanProperties: context.BaseSpanProperties{
-					StartTime:   uint64(start.UnixNano()),
-					EndTime:     uint64(end.UnixNano()),
+					StartTime:   utils.TimeToBootOffset(start),
+					EndTime:     utils.TimeToBootOffset(end),
 					SpanContext: context.EBPFSpanContext{TraceID: traceID, SpanID: spanID},
 				},
 				StatusCode: 500,
@@ -179,8 +180,8 @@ func TestProbeConvertEvent(t *testing.T) {
 			expected: []*probe.SpanEvent{
 				{
 					SpanName:    "GET",
-					StartTime:   int64(start.UnixNano()),
-					EndTime:     int64(end.UnixNano()),
+					StartTime:   start,
+					EndTime:     end,
 					SpanContext: &sc,
 					Attributes: []attribute.KeyValue{
 						semconv.HTTPRequestMethodKey.String("GET"),

diff --git a/internal/pkg/instrumentation/probe/event.go b/internal/pkg/instrumentation/probe/event.go
@@ -4,6 +4,8 @@
 package probe
 
 import (
+	"time"
+
 	"go.opentelemetry.io/otel/attribute"
 	"go.opentelemetry.io/otel/codes"
 	"go.opentelemetry.io/otel/trace"
@@ -24,8 +26,8 @@ type Status struct {
 type SpanEvent struct {
 	SpanName          string
 	Attributes        []attribute.KeyValue
-	StartTime         int64
-	EndTime           int64
+	StartTime         time.Time
+	EndTime           time.Time
 	SpanContext       *trace.SpanContext
 	ParentSpanContext *trace.SpanContext
 	Status            Status

diff --git a/internal/pkg/instrumentation/utils/kernel.go b/internal/pkg/instrumentation/utils/kernel.go
@@ -0,0 +1,36 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package utils
+
+import (
+	"math"
+	"time"
+)
+
+var bootTimeOffset = func() int64 {
+	o, err := estimateBootTimeOffset()
+	if err != nil {
+		panic(err)
+	}
+	return o
+}()
+
+// BootOffsetToTime returns the timestamp that is nsec number of nanoseconds
+// after the estimated boot time of the process.
+func BootOffsetToTime(nsec uint64) time.Time {
+	if nsec > math.MaxInt64 {
+		nsec = math.MaxInt64
+	}
+	return time.Unix(0, bootTimeOffset+int64(nsec))
+}
+
+// TimeToBootOffset returns the number of nanoseconds after the estimated boot
+// time of the process that the timestamp represent.
+func TimeToBootOffset(timestamp time.Time) uint64 {
+	nsec := timestamp.UnixNano() - bootTimeOffset
+	if nsec < 0 {
+		return 0
+	}
+	return uint64(nsec)
+}
diff --git a/internal/pkg/instrumentation/utils/kernel_linux.go b/internal/pkg/instrumentation/utils/kernel_linux.go
@@ -178,7 +178,7 @@ func GetCPUCount() (int, error) {
 	return 0, err
 }
 
-func EstimateBootTimeOffset() (bootTimeOffset int64, err error) {
+func estimateBootTimeOffset() (bootTimeOffset int64, err error) {
 	// The datapath is currently using ktime_get_boot_ns for the pcap timestamp,
 	// which corresponds to CLOCK_BOOTTIME. To be able to convert the the
 	// CLOCK_BOOTTIME to CLOCK_REALTIME (i.e. a unix timestamp).

diff --git a/internal/pkg/instrumentation/utils/kernel_other.go b/internal/pkg/instrumentation/utils/kernel_other.go
@@ -30,6 +30,6 @@ func GetCPUCount() (int, error) {
 	return 0, nil
 }
 
-func EstimateBootTimeOffset() (bootTimeOffset int64, err error) {
+func estimateBootTimeOffset() (bootTimeOffset int64, err error) {
 	return 0, nil
 }