[pkg/pdatatest] introduce IgnoreExemplars, IgnoreExemplarSlice and ChangeDatapointAttributeValue to CompareMetricsOption (#39005)

<!-- Issue number (e.g. #1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
Fixes #39004

---------

Signed-off-by: odubajDT <[email protected]>

Author: odubajDT

.chloggen/exemplars-mask.yaml

@@ -0,0 +1,27 @@
+# Use this changelog template to create an entry for release notes.
+
+# 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: pkg/pdatatest
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: "Introduce IgnoreExemplars, IgnoreExemplarSlice and ChangeDatapointAttributeValue to CompareMetricsOption"
+
+# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
+issues: [39004]
+
+# (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:
+
+# If your change doesn't affect end users or the exported elements of any package,
+# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
+# Optional: The change log or logs in which this entry should be included.
+# e.g. '[user]' or '[user, api]'
+# Include 'user' if the change is relevant to end users.
+# Include 'api' if there is a change to a library API.
+# Default: '[user]'
+change_logs: [api]

pkg/pdatatest/pmetrictest/options.go

@@ -159,6 +159,96 @@ func roundDataPointSliceValues(dataPoints pmetric.NumberDataPointSlice, precisio
 	}
 }
 
+// IgnoreExemplars is a CompareMetricsOption that clears exemplar fields on all data points.
+func IgnoreExemplars() CompareMetricsOption {
+	return compareMetricsOptionFunc(func(expected, actual pmetric.Metrics) {
+		maskExemplars(expected)
+		maskExemplars(actual)
+	})
+}
+
+func maskExemplars(metrics pmetric.Metrics) {
+	emptyExemplar := pmetric.NewExemplar()
+	for i := 0; i < metrics.ResourceMetrics().Len(); i++ {
+		for j := 0; j < metrics.ResourceMetrics().At(i).ScopeMetrics().Len(); j++ {
+			for g := 0; g < metrics.ResourceMetrics().At(i).ScopeMetrics().At(j).Metrics().Len(); g++ {
+				m := metrics.ResourceMetrics().At(i).ScopeMetrics().At(j).Metrics().At(g)
+				switch m.Type() {
+				case pmetric.MetricTypeGauge:
+					datapoints := m.Gauge().DataPoints()
+					for k := 0; k < datapoints.Len(); k++ {
+						for f := 0; f < datapoints.At(k).Exemplars().Len(); f++ {
+							emptyExemplar.CopyTo(datapoints.At(k).Exemplars().At(f))
+						}
+					}
+				case pmetric.MetricTypeSum:
+					datapoints := m.Sum().DataPoints()
+					for k := 0; k < datapoints.Len(); k++ {
+						for f := 0; f < datapoints.At(k).Exemplars().Len(); f++ {
+							emptyExemplar.CopyTo(datapoints.At(k).Exemplars().At(f))
+						}
+					}
+				case pmetric.MetricTypeHistogram:
+					datapoints := m.Histogram().DataPoints()
+					for k := 0; k < datapoints.Len(); k++ {
+						for f := 0; f < datapoints.At(k).Exemplars().Len(); f++ {
+							emptyExemplar.CopyTo(datapoints.At(k).Exemplars().At(f))
+						}
+					}
+				case pmetric.MetricTypeExponentialHistogram:
+					datapoints := m.ExponentialHistogram().DataPoints()
+					for k := 0; k < datapoints.Len(); k++ {
+						for f := 0; f < datapoints.At(k).Exemplars().Len(); f++ {
+							emptyExemplar.CopyTo(datapoints.At(k).Exemplars().At(f))
+						}
+					}
+				}
+			}
+		}
+	}
+}
+
+// IgnoreExemplarSlice is a CompareMetricsOption that clears exemplars slice on all data points.
+func IgnoreExemplarSlice() CompareMetricsOption {
+	return compareMetricsOptionFunc(func(expected, actual pmetric.Metrics) {
+		maskExemplarSlice(expected)
+		maskExemplarSlice(actual)
+	})
+}
+
+func maskExemplarSlice(metrics pmetric.Metrics) {
+	emptyExemplarSlice := pmetric.NewExemplarSlice()
+	for i := 0; i < metrics.ResourceMetrics().Len(); i++ {
+		for j := 0; j < metrics.ResourceMetrics().At(i).ScopeMetrics().Len(); j++ {
+			for g := 0; g < metrics.ResourceMetrics().At(i).ScopeMetrics().At(j).Metrics().Len(); g++ {
+				m := metrics.ResourceMetrics().At(i).ScopeMetrics().At(j).Metrics().At(g)
+				switch m.Type() {
+				case pmetric.MetricTypeGauge:
+					datapoints := m.Gauge().DataPoints()
+					for k := 0; k < datapoints.Len(); k++ {
+						emptyExemplarSlice.CopyTo(datapoints.At(k).Exemplars())
+					}
+				case pmetric.MetricTypeSum:
+					datapoints := m.Sum().DataPoints()
+					for k := 0; k < datapoints.Len(); k++ {
+						emptyExemplarSlice.CopyTo(datapoints.At(k).Exemplars())
+					}
+				case pmetric.MetricTypeHistogram:
+					datapoints := m.Histogram().DataPoints()
+					for k := 0; k < datapoints.Len(); k++ {
+						emptyExemplarSlice.CopyTo(datapoints.At(k).Exemplars())
+					}
+				case pmetric.MetricTypeExponentialHistogram:
+					datapoints := m.ExponentialHistogram().DataPoints()
+					for k := 0; k < datapoints.Len(); k++ {
+						emptyExemplarSlice.CopyTo(datapoints.At(k).Exemplars())
+					}
+				}
+			}
+		}
+	}
+}
+
 // IgnoreTimestamp is a CompareMetricsOption that clears Timestamp fields on all the data points.
 func IgnoreTimestamp() CompareMetricsOption {
 	return compareMetricsOptionFunc(func(expected, actual pmetric.Metrics) {
@@ -571,6 +661,59 @@ func changeMetricsResourceAttributeValue(metrics pmetric.Metrics, attributeName
 	}
 }
 
+// ChangeDatapointAttributeValue changes the metric datapoint value with the specified key
+func ChangeDatapointAttributeValue(attributeName string, changeFn func(string) string) CompareMetricsOption {
+	return compareMetricsOptionFunc(func(expected, actual pmetric.Metrics) {
+		changeMetricsDatapointAttributeValue(expected, attributeName, changeFn)
+		changeMetricsDatapointAttributeValue(actual, attributeName, changeFn)
+	})
+}
+
+func changeMetricsDatapointAttributeValue(metrics pmetric.Metrics, attributeName string, changeFn func(string) string) {
+	rms := metrics.ResourceMetrics()
+	for i := 0; i < rms.Len(); i++ {
+		internal.ChangeResourceAttributeValue(rms.At(i).Resource(), attributeName, changeFn)
+	}
+
+	for i := 0; i < metrics.ResourceMetrics().Len(); i++ {
+		for j := 0; j < metrics.ResourceMetrics().At(i).ScopeMetrics().Len(); j++ {
+			for g := 0; g < metrics.ResourceMetrics().At(i).ScopeMetrics().At(j).Metrics().Len(); g++ {
+				m := metrics.ResourceMetrics().At(i).ScopeMetrics().At(j).Metrics().At(g)
+				switch m.Type() {
+				case pmetric.MetricTypeGauge:
+					datapoints := m.Gauge().DataPoints()
+					for k := 0; k < datapoints.Len(); k++ {
+						if v, ok := datapoints.At(k).Attributes().Get(attributeName); ok {
+							datapoints.At(k).Attributes().PutStr(attributeName, changeFn(v.Str()))
+						}
+					}
+				case pmetric.MetricTypeSum:
+					datapoints := m.Sum().DataPoints()
+					for k := 0; k < datapoints.Len(); k++ {
+						if v, ok := datapoints.At(k).Attributes().Get(attributeName); ok {
+							datapoints.At(k).Attributes().PutStr(attributeName, changeFn(v.Str()))
+						}
+					}
+				case pmetric.MetricTypeHistogram:
+					datapoints := m.Histogram().DataPoints()
+					for k := 0; k < datapoints.Len(); k++ {
+						if v, ok := datapoints.At(k).Attributes().Get(attributeName); ok {
+							datapoints.At(k).Attributes().PutStr(attributeName, changeFn(v.Str()))
+						}
+					}
+				case pmetric.MetricTypeExponentialHistogram:
+					datapoints := m.ExponentialHistogram().DataPoints()
+					for k := 0; k < datapoints.Len(); k++ {
+						if v, ok := datapoints.At(k).Attributes().Get(attributeName); ok {
+							datapoints.At(k).Attributes().PutStr(attributeName, changeFn(v.Str()))
+						}
+					}
+				}
+			}
+		}
+	}
+}
+
 // IgnoreSubsequentDataPoints is a CompareMetricsOption that ignores data points after the first.
 func IgnoreSubsequentDataPoints(metricNames ...string) CompareMetricsOption {
 	return compareMetricsOptionFunc(func(expected, actual pmetric.Metrics) {