Fix X-Ray metadata unmarshaling (open-telemetry#36)

exporter/awsxrayexporter/internal/translator/segment.go

@@ -17,6 +17,7 @@ package translator // import "github.com/open-telemetry/opentelemetry-collector-
 import (
 	"encoding/binary"
 	"encoding/hex"
+	"encoding/json"
 	"fmt"
 	"math/rand"
 	"net/url"
@@ -57,6 +58,8 @@ var (
 )
 
 const (
+	// defaultMetadataNamespace is used for non-namespaced non-indexed attributes.
+	defaultMetadataNamespace = "default"
 	// defaultSpanName will be used if there are no valid xray characters in the span name
 	defaultSegmentName = "span"
 	// maxSegmentNameLength the maximum length of a Segment name
@@ -429,13 +432,29 @@ func makeXRayAttributes(attributes map[string]pcommon.Value, resource pcommon.Re
 		}
 	} else {
 		for key, value := range attributes {
-			if indexedKeys[key] {
+			switch {
+			case indexedKeys[key]:
 				key = fixAnnotationKey(key)
 				annoVal := annotationValue(value)
 				if annoVal != nil {
 					annotations[key] = annoVal
 				}
-			} else {
+			case strings.HasPrefix(key, awsxray.AWSXraySegmentMetadataAttributePrefix) && value.Type() == pcommon.ValueTypeStr:
+				namespace := strings.TrimPrefix(key, awsxray.AWSXraySegmentMetadataAttributePrefix)
+				var metaVal map[string]interface{}
+				err := json.Unmarshal([]byte(value.Str()), &metaVal)
+				switch {
+				case err != nil:
+					// if unable to unmarshal, keep the original key/value
+					defaultMetadata[key] = value.Str()
+				case strings.EqualFold(namespace, defaultMetadataNamespace):
+					for k, v := range metaVal {
+						defaultMetadata[k] = v
+					}
+				default:
+					metadata[namespace] = metaVal
+				}
+			default:
 				metaVal := value.AsRaw()
 				if metaVal != nil {
 					defaultMetadata[key] = metaVal
@@ -445,7 +464,7 @@ func makeXRayAttributes(attributes map[string]pcommon.Value, resource pcommon.Re
 	}
 
 	if len(defaultMetadata) > 0 {
-		metadata["default"] = defaultMetadata
+		metadata[defaultMetadataNamespace] = defaultMetadata
 	}
 
 	return user, annotations, metadata

exporter/awsxrayexporter/internal/translator/segment_test.go

@@ -499,6 +499,33 @@ func TestSpanWithAttributesAllIndexed(t *testing.T) {
 	assert.Equal(t, "val2", segment.Annotations["attr2_2"])
 }
 
+func TestSpanWithAttributesSegmentMetadata(t *testing.T) {
+	spanName := "/api/locations"
+	parentSpanID := newSegmentID()
+	attributes := make(map[string]interface{})
+	attributes["attr1@1"] = "val1"
+	attributes[awsxray.AWSXraySegmentMetadataAttributePrefix+"default"] = "{\"custom_key\": \"custom_value\"}"
+	attributes[awsxray.AWSXraySegmentMetadataAttributePrefix+"http"] = "{\"connection\":{\"reused\":false,\"was_idle\":false}}"
+	attributes[awsxray.AWSXraySegmentMetadataAttributePrefix+"non-xray-sdk"] = "retain-value"
+	resource := constructDefaultResource()
+	span := constructServerSpan(parentSpanID, spanName, ptrace.StatusCodeError, "OK", attributes)
+
+	segment, _ := MakeSegment(span, resource, nil, false, nil)
+
+	assert.NotNil(t, segment)
+	assert.Equal(t, 0, len(segment.Annotations))
+	assert.Equal(t, 2, len(segment.Metadata))
+	assert.Equal(t, "val1", segment.Metadata["default"]["attr1@1"])
+	assert.Equal(t, "custom_value", segment.Metadata["default"]["custom_key"])
+	assert.Equal(t, "retain-value", segment.Metadata["default"][awsxray.AWSXraySegmentMetadataAttributePrefix+"non-xray-sdk"])
+	assert.Nil(t, segment.Metadata["default"][awsxray.AWSXraySegmentMetadataAttributePrefix+"default"])
+	assert.Nil(t, segment.Metadata["default"][awsxray.AWSXraySegmentMetadataAttributePrefix+"http"])
+	assert.Equal(t, map[string]interface{}{
+		"reused":   false,
+		"was_idle": false,
+	}, segment.Metadata["http"]["connection"])
+}
+
 func TestResourceAttributesCanBeIndexed(t *testing.T) {
 	spanName := "/api/locations"
 	parentSpanID := newSegmentID()