Add support for scope attributes when translating traces & metrics re…

…quests (#111) ## Which problem is this PR solving? Adds support for recording scope level attributes when translating OTLP traces and metrics requests. - Closes honeycombio/telemetry-team#322 - Unblocks #108 ## Short description of the changes - Adds scope attributes to the resource attributes list when translating trace and metrics requests - Add unit tests to verify the attributes are being recorded correctly.
honeycombio · Aug 16, 2022 · d7fa60f · d7fa60f
1 parent b581d04
commit d7fa60f
Show file tree

Hide file tree

Showing 5 changed files with 52 additions and 0 deletions.
diff --git a/otlp/common.go b/otlp/common.go
@@ -159,6 +159,20 @@ func addAttributesToMap(attrs map[string]interface{}, attributes []*common.KeyVa
 	}
 }
 
+func addScopeToMap(attrs map[string]interface{}, scope *common.InstrumentationScope) {
+	if scope != nil {
+		if scope.Name != "" {
+			attrs["instrumentation_scope.name"] = scope.Name
+		}
+		if scope.Version != "" {
+			attrs["instrumentation_scope.version"] = scope.Version
+		}
+		if scope.Attributes != nil {
+			addAttributesToMap(attrs, scope.Attributes)
+		}
+	}
+}
+
 func getValue(value *common.AnyValue) interface{} {
 	switch value.Value.(type) {
 	case *common.AnyValue_StringValue:

diff --git a/otlp/logs.go b/otlp/logs.go
@@ -56,6 +56,7 @@ func TranslateLogsRequest(request *collectorLogs.ExportLogsServiceRequest, ri Re
 
 		for _, scopeLog := range resourceLog.ScopeLogs {
 			scope := scopeLog.Scope
+			addScopeToMap(resourceAttrs, scope)
 
 			for _, log := range scopeLog.GetLogRecords() {
 				eventAttrs := map[string]interface{}{

diff --git a/otlp/logs_test.go b/otlp/logs_test.go
@@ -42,6 +42,18 @@ func TestTranslateLogsRequest(t *testing.T) {
 				}},
 			},
 			ScopeLogs: []*logs.ScopeLogs{{
+				Scope: &common.InstrumentationScope{
+					Name:    "instr_scope_name",
+					Version: "instr_scope_version",
+					Attributes: []*common.KeyValue{
+						{
+							Key: "scope_attr",
+							Value: &common.AnyValue{
+								Value: &common.AnyValue_StringValue{StringValue: "scope_attr_val"},
+							},
+						},
+					},
+				},
 				LogRecords: []*logs.LogRecord{{
 					TraceId:        traceID,
 					SpanId:         spanID,
@@ -83,6 +95,9 @@ func TestTranslateLogsRequest(t *testing.T) {
 	assert.Equal(t, "my-service", ev.Attributes["service.name"])
 	assert.Equal(t, "span_attr_val", ev.Attributes["span_attr"])
 	assert.Equal(t, "resource_attr_val", ev.Attributes["resource_attr"])
+	assert.Equal(t, "instr_scope_name", ev.Attributes["instrumentation_scope.name"])
+	assert.Equal(t, "instr_scope_version", ev.Attributes["instrumentation_scope.version"])
+	assert.Equal(t, "scope_attr_val", ev.Attributes["scope_attr"])
 }
 
 func TestTranslateClassicLogsRequest(t *testing.T) {

diff --git a/otlp/traces.go b/otlp/traces.go
@@ -65,6 +65,7 @@ func TranslateTraceRequest(request *collectorTrace.ExportTraceServiceRequest, ri
 
 		for _, scopeSpan := range resourceSpan.ScopeSpans {
 			scope := scopeSpan.Scope
+			addScopeToMap(resourceAttrs, scope)
 
 			for _, span := range scopeSpan.GetSpans() {
 				traceID := BytesToTraceID(span.TraceId)

diff --git a/otlp/traces_test.go b/otlp/traces_test.go
@@ -52,6 +52,18 @@ func TestTranslateLegacyGrpcTraceRequest(t *testing.T) {
 				}},
 			},
 			ScopeSpans: []*trace.ScopeSpans{{
+				Scope: &common.InstrumentationScope{
+					Name:    "instr_scope_name",
+					Version: "instr_scope_version",
+					Attributes: []*common.KeyValue{
+						{
+							Key: "scope_attr",
+							Value: &common.AnyValue{
+								Value: &common.AnyValue_StringValue{StringValue: "scope_attr_val"},
+							},
+						},
+					},
+				},
 				Spans: []*trace.Span{{
 					TraceId:           traceID,
 					SpanId:            spanID,
@@ -125,6 +137,9 @@ func TestTranslateLegacyGrpcTraceRequest(t *testing.T) {
 	assert.Equal(t, "resource_attr_val", ev.Attributes["resource_attr"])
 	assert.Equal(t, 1, ev.Attributes["span.num_links"])
 	assert.Equal(t, 1, ev.Attributes["span.num_events"])
+	assert.Equal(t, "instr_scope_name", ev.Attributes["instrumentation_scope.name"])
+	assert.Equal(t, "instr_scope_version", ev.Attributes["instrumentation_scope.version"])
+	assert.Equal(t, "scope_attr_val", ev.Attributes["scope_attr"])
 
 	// event
 	ev = events[1]
@@ -137,6 +152,9 @@ func TestTranslateLegacyGrpcTraceRequest(t *testing.T) {
 	assert.Equal(t, "span_event", ev.Attributes["meta.annotation_type"])
 	assert.Equal(t, "span_event_attr_val", ev.Attributes["span_event_attr"])
 	assert.Equal(t, "resource_attr_val", ev.Attributes["resource_attr"])
+	assert.Equal(t, "instr_scope_name", ev.Attributes["instrumentation_scope.name"])
+	assert.Equal(t, "instr_scope_version", ev.Attributes["instrumentation_scope.version"])
+	assert.Equal(t, "scope_attr_val", ev.Attributes["scope_attr"])
 
 	// link
 	ev = events[2]
@@ -151,6 +169,9 @@ func TestTranslateLegacyGrpcTraceRequest(t *testing.T) {
 	assert.Equal(t, "link", ev.Attributes["meta.annotation_type"])
 	assert.Equal(t, "span_link_attr_val", ev.Attributes["span_link_attr"])
 	assert.Equal(t, "resource_attr_val", ev.Attributes["resource_attr"])
+	assert.Equal(t, "instr_scope_name", ev.Attributes["instrumentation_scope.name"])
+	assert.Equal(t, "instr_scope_version", ev.Attributes["instrumentation_scope.version"])
+	assert.Equal(t, "scope_attr_val", ev.Attributes["scope_attr"])
 }
 
 func TestTranslateGrpcTraceRequest(t *testing.T) {