[exporter/awsemfexporter] Add user agent string when EBS metrics exist

exporter/awsemfexporter/emf_exporter.go

@@ -21,8 +21,8 @@ import (
 	"go.opentelemetry.io/collector/pdata/pmetric"
 	"go.uber.org/zap"
 
-	"github.com/open-telemetry/opentelemetry-collector-contrib/exporter/awsemfexporter/internal/appsignals"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/exporter/awsemfexporter/internal/metadata"
+	"github.com/open-telemetry/opentelemetry-collector-contrib/exporter/awsemfexporter/internal/useragent"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/internal/aws/awsutil"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/internal/aws/cwlogs"
 )
@@ -52,6 +52,7 @@ type emfExporter struct {
 	collectorID   string
 
 	processResourceLabels func(map[string]string)
+	processMetrics        func(pmetric.Metrics)
 }
 
 // newEmfExporter creates a new exporter using exporterhelper
@@ -75,11 +76,7 @@ func newEmfExporter(config *Config, set exporter.Settings) (*emfExporter, error)
 		collectorID:           collectorIdentifier.String(),
 		pusherMap:             map[cwlogs.StreamKey]cwlogs.Pusher{},
 		processResourceLabels: func(map[string]string) {},
-	}
-
-	if config.IsAppSignalsEnabled() {
-		userAgent := appsignals.NewUserAgent()
-		emfExporter.processResourceLabels = userAgent.Process
+		processMetrics:        func(pmetric.Metrics) {},
 	}
 
 	config.logger.Warn("the default value for DimensionRollupOption will be changing to NoDimensionRollup" +
@@ -104,6 +101,7 @@ func (emf *emfExporter) pushMetricsData(_ context.Context, md pmetric.Metrics) e
 	}
 	emf.config.logger.Debug("Start processing resource metrics", zap.Any("labels", labels))
 	emf.processResourceLabels(labels)
+	emf.processMetrics(md)
 
 	groupedMetrics := make(map[any]*groupedMetric)
 	defaultLogStream := fmt.Sprintf("otel-stream-%s", emf.collectorID)
@@ -232,6 +230,21 @@ func (emf *emfExporter) start(_ context.Context, host component.Host) error {
 		awsmiddleware.TryConfigure(emf.config.logger, host, *emf.config.MiddlewareID, awsmiddleware.SDKv1(svcStructuredLog.Handlers()))
 	}
 
+	// Below are optimizatons to minimize amoount of
+	// metrics processing. We have two scearios
+	// 1. AppSignal - Only run Process function for AppSignal related useragent
+	// 2. Enhanced Container Insights - Only run ProcessMetrics function for CI EBS related useragent
+	if emf.config.IsAppSignalsEnabled() || emf.config.IsEnhancedContainerInsights() {
+		userAgent := useragent.NewUserAgent()
+		emf.svcStructuredLog.Handlers().Build.PushFrontNamed(userAgent.Handler())
+		if emf.config.IsAppSignalsEnabled() {
+			emf.processResourceLabels = userAgent.Process
+		}
+		if emf.config.IsEnhancedContainerInsights() {
+			emf.processMetrics = userAgent.ProcessMetrics
+		}
+	}
+
 	return nil
 }
 

exporter/awsemfexporter/internal/appsignals/useragent.go → exporter/awsemfexporter/internal/useragent/useragent.go

@@ -1,7 +1,7 @@
 // Copyright The OpenTelemetry Authors
 // SPDX-License-Identifier: Apache-2.0
 
-package appsignals // import "github.com/open-telemetry/opentelemetry-collector-contrib/exporter/awsemfexporter/internal/appsignals"
+package useragent // import "github.com/open-telemetry/opentelemetry-collector-contrib/exporter/awsemfexporter/internal/appsignals"
 
 import (
 	"context"
@@ -13,6 +13,7 @@ import (
 
 	"github.com/aws/aws-sdk-go/aws/request"
 	"github.com/jellydator/ttlcache/v3"
+	"go.opentelemetry.io/collector/pdata/pmetric"
 	semconv "go.opentelemetry.io/collector/semconv/v1.18.0"
 )
 
@@ -27,12 +28,16 @@ const (
 
 	// TODO: Available in semconv/v1.21.0+. Replace after collector dependency is v0.91.0+.
 	attributeTelemetryDistroVersion = "telemetry.distro.version"
+
+	attributeEBS    = "ci_ebs"
+	ebsMetricPrefix = "node_diskio_ebs"
 )
 
 type UserAgent struct {
 	mu          sync.RWMutex
 	prebuiltStr string
 	cache       *ttlcache.Cache[string, string]
+	featureList map[string]struct{}
 }
 
 func NewUserAgent() *UserAgent {
@@ -45,6 +50,7 @@ func newUserAgent(ttl time.Duration) *UserAgent {
 			ttlcache.WithTTL[string, string](ttl),
 			ttlcache.WithCapacity[string, string](cacheSize),
 		),
+		featureList: make(map[string]struct{}),
 	}
 	ua.cache.OnEviction(func(context.Context, ttlcache.EvictionReason, *ttlcache.Item[string, string]) {
 		ua.build()
@@ -87,6 +93,30 @@ func (ua *UserAgent) Process(labels map[string]string) {
 	}
 }
 
+// ProcessMetrics checks metric names for specific patterns and updates user agent accordingly
+func (ua *UserAgent) ProcessMetrics(metrics pmetric.Metrics) {
+	// Check if we've already detected NVME
+	if _, exists := ua.featureList[attributeEBS]; exists {
+		return
+	}
+
+	rms := metrics.ResourceMetrics()
+	for i := 0; i < rms.Len(); i++ {
+		ilms := rms.At(i).ScopeMetrics()
+		for j := 0; j < ilms.Len(); j++ {
+			ms := ilms.At(j).Metrics()
+			for k := 0; k < ms.Len(); k++ {
+				metric := ms.At(k)
+				if strings.HasPrefix(metric.Name(), ebsMetricPrefix) {
+					ua.featureList[attributeEBS] = struct{}{}
+					ua.build()
+					return
+				}
+			}
+		}
+	}
+}
+
 // build the user agent string from the items in the cache. Format is telemetry-sdk (<lang1>/<ver1>;<lang2>/<ver2>).
 func (ua *UserAgent) build() {
 	ua.mu.Lock()
@@ -100,6 +130,18 @@ func (ua *UserAgent) build() {
 		sort.Strings(items)
 		ua.prebuiltStr = fmt.Sprintf("telemetry-sdk (%s)", strings.Join(items, ";"))
 	}
+
+	if len(ua.featureList) > 0 {
+		if ua.prebuiltStr != "" {
+			ua.prebuiltStr += " "
+		}
+		var metricTypes []string
+		for metricType := range ua.featureList {
+			metricTypes = append(metricTypes, metricType)
+		}
+		sort.Strings(metricTypes)
+		ua.prebuiltStr += fmt.Sprintf("feature:(%s)", strings.Join(metricTypes, " "))
+	}
 }
 
 // formatStr formats the telemetry SDK language and version into the user agent format.

exporter/awsemfexporter/internal/appsignals/useragent_test.go → exporter/awsemfexporter/internal/useragent/useragent_test.go

@@ -1,7 +1,7 @@
 // Copyright The OpenTelemetry Authors
 // SPDX-License-Identifier: Apache-2.0
 
-package appsignals
+package useragent
 
 import (
 	"net/http"
@@ -10,12 +10,14 @@ import (
 
 	"github.com/aws/aws-sdk-go/aws/request"
 	"github.com/stretchr/testify/assert"
+	"go.opentelemetry.io/collector/pdata/pmetric"
 	semconv "go.opentelemetry.io/collector/semconv/v1.18.0"
 )
 
 func TestUserAgent(t *testing.T) {
 	testCases := map[string]struct {
 		labelSets []map[string]string
+		metrics   []string // Add metric names to test
 		want      string
 	}{
 		"WithEmpty": {},
@@ -69,13 +71,41 @@ func TestUserAgent(t *testing.T) {
 			},
 			want: "telemetry-sdk (incrediblyverboselan/notsemanticversionin)",
 		},
+		"WithEBSMetrics": {
+			metrics: []string{"node_diskio_ebs_something"},
+			want:    "feature:(ci_ebs)",
+		},
+		"WithBothTelemetryAndEBS": {
+			labelSets: []map[string]string{
+				{
+					semconv.AttributeTelemetrySDKLanguage: "test",
+					attributeTelemetryDistroVersion:       "1.0",
+				},
+			},
+			metrics: []string{"node_diskio_ebs_something"},
+			want:    "telemetry-sdk (test/1.0) feature:(ci_ebs)",
+		},
+		"WithNonEBSMetrics": {
+			metrics: []string{"some_other_metric"},
+			want:    "",
+		},
+		"WithMultipleFeatures": {
+			metrics: []string{"node_diskio_ebs_something", "node_diskio_ebs_something_else"},
+			want:    "feature:(ci_ebs)",
+		},
 	}
 	for name, testCase := range testCases {
 		t.Run(name, func(t *testing.T) {
 			userAgent := NewUserAgent()
 			for _, labelSet := range testCase.labelSets {
 				userAgent.Process(labelSet)
 			}
+
+			if len(testCase.metrics) > 0 {
+				metrics := createTestMetrics(testCase.metrics)
+				userAgent.ProcessMetrics(metrics)
+			}
+
 			req := &request.Request{
 				HTTPRequest: &http.Request{
 					Header: http.Header{},
@@ -109,3 +139,16 @@ func TestUserAgentExpiration(t *testing.T) {
 	userAgent.handle(req)
 	assert.Empty(t, req.HTTPRequest.Header.Get("User-Agent"))
 }
+
+func createTestMetrics(metricNames []string) pmetric.Metrics {
+	metrics := pmetric.NewMetrics()
+	rm := metrics.ResourceMetrics().AppendEmpty()
+	ilm := rm.ScopeMetrics().AppendEmpty()
+
+	for _, name := range metricNames {
+		metric := ilm.Metrics().AppendEmpty()
+		metric.SetName(name)
+	}
+
+	return metrics
+}