[prometheusremotewrite] add otel_scope_info metric to prometheus remote write exporter

.chloggen/O11Y-3152.yaml

@@ -0,0 +1,20 @@
+# Use this changelog template to create an entry for release notes.
+# If your change doesn't affect end users, such as a test fix or a tooling change,
+# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
+
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: enhancement
+
+# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
+component: prometheusremotewriteexporter
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Add otel_scope_info metric to prometheus remote write exporter.
+
+# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
+issues: [21091]
+
+# (Optional) One or more lines of additional information to render under the primary note.
+# These lines will be padded with 2 spaces and then inserted directly into the document.
+# Use pipe (|) for multiline entries.
+subtext:

exporter/prometheusremotewriteexporter/README.md

@@ -60,6 +60,8 @@ The following settings can be optionally configured:
   - `enabled` (default = false): If `enabled` is `true`, all the resource attributes will be converted to metric labels by default.
 - `target_info`: customize `target_info` metric
   - `enabled` (default = true): If `enabled` is `true`, a `target_info` metric will be generated for each resource metric (see https://github.com/open-telemetry/opentelemetry-specification/pull/2381).
+- `scope_info`: customize `otel_scope_info` metric
+  - `enabled` (default = false): If `enabled` is `true`, a `otel_scope_info` metric will be generated for each instrumentation scope metric (see https://github.com/open-telemetry/opentelemetry-specification/pull/2703).
 - `export_created_metric`:
   - `enabled` (default = false): If `enabled` is `true`, a `_created` metric is
     exported for Summary, Histogram, and Monotonic Sum metric points if

exporter/prometheusremotewriteexporter/config.go

@@ -40,6 +40,9 @@ type Config struct {
 	// TargetInfo allows customizing the target_info metric
 	TargetInfo *TargetInfo `mapstructure:"target_info,omitempty"`
 
+	// ScopeInfo allows customizing the scope_info metric
+	ScopeInfo *ScopeInfo `mapstructure:"scope_info,omitempty"`
+
 	// CreatedMetric allows customizing creation of _created metrics
 	CreatedMetric *CreatedMetric `mapstructure:"export_created_metric,omitempty"`
 
@@ -57,6 +60,11 @@ type TargetInfo struct {
 	Enabled bool `mapstructure:"enabled"`
 }
 
+type ScopeInfo struct {
+	// Enabled if false the otel_scope_info metric is not generated by the exporter
+	Enabled bool `mapstructure:"enabled"`
+}
+
 // RemoteWriteQueue allows to configure the remote write queue.
 type RemoteWriteQueue struct {
 	// Enabled if false the queue is not enabled, the export requests

exporter/prometheusremotewriteexporter/config_test.go

@@ -76,6 +76,9 @@ func TestLoadConfig(t *testing.T) {
 				TargetInfo: &TargetInfo{
 					Enabled: true,
 				},
+				ScopeInfo: &ScopeInfo{
+					Enabled: false,
+				},
 				CreatedMetric: &CreatedMetric{Enabled: true},
 			},
 		},

exporter/prometheusremotewriteexporter/exporter.go

@@ -72,6 +72,7 @@ func newPRWExporter(cfg *Config, set exporter.CreateSettings) (*prwExporter, err
 			Namespace:           cfg.Namespace,
 			ExternalLabels:      sanitizedLabels,
 			DisableTargetInfo:   !cfg.TargetInfo.Enabled,
+			DisableScopeInfo:    !cfg.ScopeInfo.Enabled,
 			ExportCreatedMetric: cfg.CreatedMetric.Enabled,
 			AddMetricSuffixes:   cfg.AddMetricSuffixes,
 		},

exporter/prometheusremotewriteexporter/exporter_test.go

@@ -41,6 +41,9 @@ func Test_NewPRWExporter(t *testing.T) {
 		TargetInfo: &TargetInfo{
 			Enabled: true,
 		},
+		ScopeInfo: &ScopeInfo{
+			Enabled: false,
+		},
 		CreatedMetric: &CreatedMetric{
 			Enabled: false,
 		},
@@ -136,6 +139,9 @@ func Test_Start(t *testing.T) {
 		TargetInfo: &TargetInfo{
 			Enabled: true,
 		},
+		ScopeInfo: &ScopeInfo{
+			Enabled: false,
+		},
 		CreatedMetric: &CreatedMetric{
 			Enabled: false,
 		},
@@ -679,6 +685,9 @@ func Test_PushMetrics(t *testing.T) {
 						TargetInfo: &TargetInfo{
 							Enabled: true,
 						},
+						ScopeInfo: &ScopeInfo{
+							Enabled: false,
+						},
 						CreatedMetric: &CreatedMetric{
 							Enabled: true,
 						},

exporter/prometheusremotewriteexporter/factory.go

@@ -98,6 +98,9 @@ func createDefaultConfig() component.Config {
 		TargetInfo: &TargetInfo{
 			Enabled: true,
 		},
+		ScopeInfo: &ScopeInfo{
+			Enabled: false,
+		},
 		CreatedMetric: &CreatedMetric{
 			Enabled: false,
 		},

pkg/translator/prometheusremotewrite/helper.go

@@ -44,6 +44,9 @@ const (
 	spanIDKey        = "span_id"
 	infoType         = "info"
 	targetMetricName = "target_info"
+	scopeMetricName  = "otel_scope_info"
+	scopeAttrName    = "otel_scope_name"
+	scopeAttrVersion = "otel_scope_version"
 )
 
 type bucketBoundsData struct {
@@ -155,7 +158,13 @@ func timeSeriesSignature(datatype string, labels *[]prompb.Label) string {
 // createAttributes creates a slice of Cortex Label with OTLP attributes and pairs of string values.
 // Unpaired string value is ignored. String pairs overwrites OTLP labels if collision happens, and the overwrite is
 // logged. Resultant label names are sanitized.
-func createAttributes(resource pcommon.Resource, attributes pcommon.Map, externalLabels map[string]string, extras ...string) []prompb.Label {
+func createAttributes(
+	resource pcommon.Resource,
+	scope pcommon.InstrumentationScope,
+	attributes pcommon.Map,
+	externalLabels map[string]string,
+	extras ...string,
+) []prompb.Label {
 	serviceName, haveServiceName := resource.Attributes().Get(conventions.AttributeServiceName)
 	instance, haveInstanceID := resource.Attributes().Get(conventions.AttributeServiceInstanceID)
 
@@ -212,6 +221,14 @@ func createAttributes(resource pcommon.Resource, attributes pcommon.Map, externa
 		l[key] = value
 	}
 
+	// add scope name/version labels
+	if len(scope.Name()) > 0 {
+		extras = append(extras, scopeAttrName, scope.Name())
+	}
+	if len(scope.Version()) > 0 {
+		extras = append(extras, scopeAttrVersion, scope.Version())
+	}
+
 	for i := 0; i < len(extras); i += 2 {
 		if i+1 >= len(extras) {
 			break
@@ -254,11 +271,18 @@ func isValidAggregationTemporality(metric pmetric.Metric) bool {
 
 // addSingleHistogramDataPoint converts pt to 2 + min(len(ExplicitBounds), len(BucketCount)) + 1 samples. It
 // ignore extra buckets if len(ExplicitBounds) > len(BucketCounts)
-func addSingleHistogramDataPoint(pt pmetric.HistogramDataPoint, resource pcommon.Resource, metric pmetric.Metric, settings Settings, tsMap map[string]*prompb.TimeSeries) {
+func addSingleHistogramDataPoint(
+	pt pmetric.HistogramDataPoint,
+	resource pcommon.Resource,
+	scope pcommon.InstrumentationScope,
+	metric pmetric.Metric,
+	settings Settings,
+	tsMap map[string]*prompb.TimeSeries,
+) {
 	timestamp := convertTimeStamp(pt.Timestamp())
 	// sum, count, and buckets of the histogram should append suffix to baseName
 	baseName := prometheustranslator.BuildCompliantName(metric, settings.Namespace, settings.AddMetricSuffixes)
-	baseLabels := createAttributes(resource, pt.Attributes(), settings.ExternalLabels)
+	baseLabels := createAttributes(resource, scope, pt.Attributes(), settings.ExternalLabels)
 
 	createLabels := func(nameSuffix string, extras ...string) []prompb.Label {
 		extraLabelCount := len(extras) / 2
@@ -288,7 +312,6 @@ func addSingleHistogramDataPoint(pt pmetric.HistogramDataPoint, resource pcommon
 
 		sumlabels := createLabels(sumStr)
 		addSample(tsMap, sum, sumlabels, metric.Type().String())
-
 	}
 
 	// treat count as a sample in an individual TimeSeries
@@ -452,12 +475,18 @@ func maxTimestamp(a, b pcommon.Timestamp) pcommon.Timestamp {
 }
 
 // addSingleSummaryDataPoint converts pt to len(QuantileValues) + 2 samples.
-func addSingleSummaryDataPoint(pt pmetric.SummaryDataPoint, resource pcommon.Resource, metric pmetric.Metric, settings Settings,
-	tsMap map[string]*prompb.TimeSeries) {
+func addSingleSummaryDataPoint(
+	pt pmetric.SummaryDataPoint,
+	resource pcommon.Resource,
+	scope pcommon.InstrumentationScope,
+	metric pmetric.Metric,
+	settings Settings,
+	tsMap map[string]*prompb.TimeSeries,
+) {
 	timestamp := convertTimeStamp(pt.Timestamp())
 	// sum and count of the summary should append suffix to baseName
 	baseName := prometheustranslator.BuildCompliantName(metric, settings.Namespace, settings.AddMetricSuffixes)
-	baseLabels := createAttributes(resource, pt.Attributes(), settings.ExternalLabels)
+	baseLabels := createAttributes(resource, scope, pt.Attributes(), settings.ExternalLabels)
 
 	createLabels := func(name string, extras ...string) []prompb.Label {
 		extraLabelCount := len(extras) / 2
@@ -566,7 +595,7 @@ func addResourceTargetInfo(resource pcommon.Resource, settings Settings, timesta
 	if len(settings.Namespace) > 0 {
 		name = settings.Namespace + "_" + name
 	}
-	labels := createAttributes(resource, attributes, settings.ExternalLabels, nameStr, name)
+	labels := createAttributes(resource, pcommon.NewInstrumentationScope(), attributes, settings.ExternalLabels, nameStr, name)
 	sample := &prompb.Sample{
 		Value: float64(1),
 		// convert ns to ms
@@ -575,6 +604,44 @@ func addResourceTargetInfo(resource pcommon.Resource, settings Settings, timesta
 	addSample(tsMap, sample, labels, infoType)
 }
 
+func addScopeTargetInfo(
+	scope pcommon.InstrumentationScope,
+	resource pcommon.Resource,
+	settings Settings,
+	timestamp pcommon.Timestamp,
+	tsMap map[string]*prompb.TimeSeries,
+) {
+	if settings.DisableScopeInfo {
+		return
+	}
+	if scope.Attributes().Len() == 0 {
+		// If the scope doesn't have additional attributes, then otel_scope_info isn't useful.
+		return
+	}
+
+	// Only add service name and instance id resource attributes
+	resCopy := pcommon.NewResource()
+	serviceName, ok := resource.Attributes().Get(conventions.AttributeServiceName)
+	if ok {
+		serviceName.CopyTo(resCopy.Attributes().PutEmpty(conventions.AttributeServiceName))
+	}
+	serviceInstanceID, ok := resource.Attributes().Get(conventions.AttributeServiceInstanceID)
+	if ok {
+		serviceInstanceID.CopyTo(resCopy.Attributes().PutEmpty(conventions.AttributeServiceInstanceID))
+	}
+
+	name := scopeMetricName
+	if len(settings.Namespace) > 0 {
+		name = settings.Namespace + "_" + name
+	}
+	labels := createAttributes(resource, scope, scope.Attributes(), settings.ExternalLabels, nameStr, name)
+	sample := &prompb.Sample{
+		Value:     float64(1),
+		Timestamp: convertTimeStamp(timestamp),
+	}
+	addSample(tsMap, sample, labels, infoType)
+}
+
 // convertTimeStamp converts OTLP timestamp in ns to timestamp in ms
 func convertTimeStamp(timestamp pcommon.Timestamp) int64 {
 	return timestamp.AsTime().UnixNano() / (int64(time.Millisecond) / int64(time.Nanosecond))