feat: refactor log serialization to match docs (#1169)

Author: giortzisg

interfaces.go

@@ -80,7 +80,7 @@ func (b *Breadcrumb) MarshalJSON() ([]byte, error) {
 
 	if b.Timestamp.IsZero() {
 		return json.Marshal(struct {
-			// Embed all of the fields of Breadcrumb.
+			// Embed all the fields of Breadcrumb.
 			*breadcrumb
 			// Timestamp shadows the original Timestamp field and is meant to
 			// remain nil, triggering the omitempty behavior.
@@ -723,45 +723,18 @@ type EventHint struct {
 }
 
 type Log struct {
-	Timestamp  time.Time            `json:"timestamp,omitempty"`
-	TraceID    TraceID              `json:"trace_id,omitempty"`
+	Timestamp  time.Time            `json:"timestamp"`
+	TraceID    TraceID              `json:"trace_id"`
+	SpanID     SpanID               `json:"span_id,omitempty"`
 	Level      LogLevel             `json:"level"`
 	Severity   int                  `json:"severity_number,omitempty"`
-	Body       string               `json:"body,omitempty"`
+	Body       string               `json:"body"`
 	Attributes map[string]Attribute `json:"attributes,omitempty"`
 }
 
 // ToEnvelopeItem converts the Log to a Sentry envelope item for batching.
 func (l *Log) ToEnvelopeItem() (*protocol.EnvelopeItem, error) {
-	type logJSON struct {
-		Timestamp  *float64                         `json:"timestamp,omitempty"`
-		TraceID    string                           `json:"trace_id,omitempty"`
-		Level      string                           `json:"level"`
-		Severity   int                              `json:"severity_number,omitempty"`
-		Body       string                           `json:"body,omitempty"`
-		Attributes map[string]protocol.LogAttribute `json:"attributes,omitempty"`
-	}
-
-	// Convert time.Time to seconds float if set
-	var ts *float64
-	if !l.Timestamp.IsZero() {
-		sec := float64(l.Timestamp.UnixNano()) / 1e9
-		ts = &sec
-	}
-
-	attrs := make(map[string]protocol.LogAttribute, len(l.Attributes))
-	for k, v := range l.Attributes {
-		attrs[k] = protocol.LogAttribute{Value: v.Value, Type: string(v.Type)}
-	}
-
-	logData, err := json.Marshal(logJSON{
-		Timestamp:  ts,
-		TraceID:    l.TraceID.String(),
-		Level:      string(l.Level),
-		Severity:   l.Severity,
-		Body:       l.Body,
-		Attributes: attrs,
-	})
+	logData, err := json.Marshal(l)
 	if err != nil {
 		return nil, err
 	}
@@ -808,3 +781,32 @@ type Attribute struct {
 	Value any      `json:"value"`
 	Type  AttrType `json:"type"`
 }
+
+// MarshalJSON is a custom implementation that skips SpanID and timestamp when empty.
+func (l *Log) MarshalJSON() ([]byte, error) {
+	type log Log
+
+	var spanID string
+	if l.SpanID != zeroSpanID {
+		spanID = l.SpanID.String()
+	}
+
+	var ts json.RawMessage
+	if !l.Timestamp.IsZero() {
+		b, err := l.Timestamp.MarshalJSON()
+		if err != nil {
+			return nil, err
+		}
+		ts = b
+	}
+
+	return json.Marshal(struct {
+		*log
+		SpanID    string          `json:"span_id,omitempty"`
+		Timestamp json.RawMessage `json:"timestamp,omitempty"`
+	}{
+		log:       (*log)(l),
+		SpanID:    spanID,
+		Timestamp: ts,
+	})
+}

interfaces_test.go

@@ -985,7 +985,7 @@ func TestLog_ToEnvelopeItem_And_Getters(t *testing.T) {
 	}
 
 	var payload struct {
-		Timestamp  *float64                         `json:"timestamp,omitempty"`
+		Timestamp  string                           `json:"timestamp,omitempty"`
 		TraceID    string                           `json:"trace_id,omitempty"`
 		Level      string                           `json:"level"`
 		Severity   int                              `json:"severity_number,omitempty"`
@@ -996,11 +996,11 @@ func TestLog_ToEnvelopeItem_And_Getters(t *testing.T) {
 		t.Fatalf("failed to unmarshal payload: %v", err)
 	}
 
-	if payload.Timestamp == nil {
+	if payload.Timestamp == "" {
 		t.Fatal("expected timestamp to be set")
 	}
-	if *payload.Timestamp < 1.7e9 || *payload.Timestamp > 1.700000001e9 {
-		t.Fatalf("unexpected timestamp: %v", *payload.Timestamp)
+	if _, err := time.Parse(time.RFC3339, payload.Timestamp); err != nil {
+		t.Fatalf("invalid timestamp format: %v", err)
 	}
 	if payload.TraceID != trace.String() {
 		t.Fatalf("unexpected trace id: %q", payload.TraceID)

log.go

@@ -167,9 +167,6 @@ func (l *sentryLogger) log(ctx context.Context, level LogLevel, severity int, me
 			attrs["user.email"] = Attribute{Value: user.Email, Type: AttributeString}
 		}
 	}
-	if span != nil {
-		attrs["sentry.trace.parent_span_id"] = Attribute{Value: spanID.String(), Type: AttributeString}
-	}
 	if sdkIdentifier := l.client.sdkIdentifier; sdkIdentifier != "" {
 		attrs["sentry.sdk.name"] = Attribute{Value: sdkIdentifier, Type: AttributeString}
 	}
@@ -180,6 +177,7 @@ func (l *sentryLogger) log(ctx context.Context, level LogLevel, severity int, me
 	log := &Log{
 		Timestamp:  time.Now(),
 		TraceID:    traceID,
+		SpanID:     spanID,
 		Level:      level,
 		Severity:   severity,
 		Body:       fmt.Sprintf(message, args...),

log_test.go

@@ -664,10 +664,8 @@ func Test_sentryLogger_TracePropagationWithTransaction(t *testing.T) {
 	if log.TraceID != expectedTraceID {
 		t.Errorf("unexpected TraceID: got %s, want %s", log.TraceID.String(), expectedTraceID.String())
 	}
-	if val, ok := log.Attributes["sentry.trace.parent_span_id"]; !ok {
-		t.Errorf("missing sentry.trace.parent_span_id attribute")
-	} else if val.Value != expectedSpanID.String() {
-		t.Errorf("unexpected SpanID: got %s, want %s", val.Value, expectedSpanID.String())
+	if log.SpanID != expectedSpanID {
+		t.Errorf("unexpected SpanID: got %s, want %s", log.SpanID.String(), expectedSpanID.String())
 	}
 }
 

transport_test.go

@@ -292,7 +292,7 @@ func TestEnvelopeFromLogEvent(t *testing.T) {
 	got := b.String()
 	want := `{"event_id":"b81c5be4d31e48959103a1f878a1efcb","sent_at":"1970-01-01T00:00:00Z","dsn":"http://public@example.com/sentry/1","sdk":{"name":"sentry.go","version":"0.0.1"}}
 {"type":"log","item_count":1,"content_type":"application/vnd.sentry.items.log+json"}
-{"event_id":"b81c5be4d31e48959103a1f878a1efcb","sdk":{"name":"sentry.go","version":"0.0.1"},"user":{},"items":[{"timestamp":"0001-01-01T00:00:00Z","trace_id":"d49d9bf66f13450b81f65bc51cf49c03","level":"info","severity_number":9,"body":"test log message","attributes":{"key.bool":{"value":true,"type":"boolean"},"key.float":{"value":42.2,"type":"double"},"key.int":{"value":42,"type":"integer"},"key.string":{"value":"str","type":"string"},"sentry.environment":{"value":"testing","type":"string"},"sentry.release":{"value":"v1.2.3","type":"string"},"sentry.sdk.name":{"value":"sentry.go","type":"string"},"sentry.sdk.version":{"value":"0.0.1","type":"string"},"sentry.server.address":{"value":"test-server","type":"string"}}}]}
+{"event_id":"b81c5be4d31e48959103a1f878a1efcb","sdk":{"name":"sentry.go","version":"0.0.1"},"user":{},"items":[{"trace_id":"d49d9bf66f13450b81f65bc51cf49c03","level":"info","severity_number":9,"body":"test log message","attributes":{"key.bool":{"value":true,"type":"boolean"},"key.float":{"value":42.2,"type":"double"},"key.int":{"value":42,"type":"integer"},"key.string":{"value":"str","type":"string"},"sentry.environment":{"value":"testing","type":"string"},"sentry.release":{"value":"v1.2.3","type":"string"},"sentry.sdk.name":{"value":"sentry.go","type":"string"},"sentry.sdk.version":{"value":"0.0.1","type":"string"},"sentry.server.address":{"value":"test-server","type":"string"}}}]}
 `
 	if diff := cmp.Diff(want, got); diff != "" {
 		t.Errorf("Envelope mismatch (-want +got):\n%s", diff)