change name to aggregation_temporality, to match the data_model

Signed-off-by: Nikos Angelopoulos <[email protected]>

Author: NickAnge

.chloggen/nickange_telemetrygen_metrics_support-delta-temporality.yaml

@@ -7,7 +7,7 @@ change_type: enhancement
 component: telemetrygen
 
 # A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
-note: "Add support for `temporalityType` flag in telemetrygen.  Supported values (delta or cumulative)"
+note: "Add support for `aggregation-temporality` flag in telemetrygen.  Supported values (delta or cumulative)"
 
 # Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
 issues: [38073]

cmd/telemetrygen/pkg/metrics/aggregation_temporality.go

@@ -0,0 +1,35 @@
+package metrics
+
+import (
+	"fmt"
+
+	"go.opentelemetry.io/otel/sdk/metric/metricdata"
+)
+
+type AggregationTemporality metricdata.Temporality
+
+func (t *AggregationTemporality) Set(v string) error {
+	switch v {
+	case "delta":
+		*t = AggregationTemporality(metricdata.DeltaTemporality)
+		return nil
+	case "cumulative":
+		*t = AggregationTemporality(metricdata.CumulativeTemporality)
+		return nil
+	default:
+		return fmt.Errorf(`temporality must be one of "delta" or "cumulative"`)
+	}
+}
+
+func (t *AggregationTemporality) String() string {
+	return string(metricdata.Temporality(*t))
+}
+
+func (t *AggregationTemporality) Type() string {
+	return "temporality"
+}
+
+// AsTemporality converts the AggregationTemporality to metricdata.Temporality
+func (t AggregationTemporality) AsTemporality() metricdata.Temporality {
+	return metricdata.Temporality(t)
+}

cmd/telemetrygen/pkg/metrics/config.go

@@ -15,12 +15,12 @@ import (
 // Config describes the test scenario.
 type Config struct {
 	common.Config
-	NumMetrics      int
-	MetricName      string
-	MetricType      MetricType
-	TemporalityType TemporalityType
-	SpanID          string
-	TraceID         string
+	NumMetrics             int
+	MetricName             string
+	MetricType             MetricType
+	AggregationTemporality AggregationTemporality
+	SpanID                 string
+	TraceID                string
 }
 
 // NewConfig creates a new Config with default values.
@@ -42,7 +42,7 @@ func (c *Config) Flags(fs *pflag.FlagSet) {
 	fs.StringVar(&c.SpanID, "span-id", c.SpanID, "SpanID to use as exemplar")
 
 	fs.Var(&c.MetricType, "metric-type", "Metric type enum. must be one of 'Gauge' or 'Sum'")
-	fs.Var(&c.TemporalityType, "temporality-type", "Temporality for Sum and Histogram metrics. Must be one of 'delta' or 'cumulative'")
+	fs.Var(&c.AggregationTemporality, "aggregation-temporality", "aggregation-temporality for metrics. Must be one of 'delta' or 'cumulative'")
 }
 
 // SetDefaults sets the default values for the configuration
@@ -57,7 +57,7 @@ func (c *Config) SetDefaults() {
 	// Use Gauge as default metric type.
 	c.MetricType = MetricTypeGauge
 	// Use cumulative temporality as default.
-	c.TemporalityType = TemporalityType(metricdata.CumulativeTemporality)
+	c.AggregationTemporality = AggregationTemporality(metricdata.CumulativeTemporality)
 
 	c.TraceID = ""
 	c.SpanID = ""

cmd/telemetrygen/pkg/metrics/metrics.go

@@ -66,17 +66,17 @@ func run(c *Config, expF exporterFunc, logger *zap.Logger) error {
 	for i := 0; i < c.WorkerCount; i++ {
 		wg.Add(1)
 		w := worker{
-			numMetrics:      c.NumMetrics,
-			metricName:      c.MetricName,
-			metricType:      c.MetricType,
-			temporalityType: c.TemporalityType,
-			exemplars:       exemplarsFromConfig(c),
-			limitPerSecond:  limit,
-			totalDuration:   c.TotalDuration,
-			running:         running,
-			wg:              &wg,
-			logger:          logger.With(zap.Int("worker", i)),
-			index:           i,
+			numMetrics:             c.NumMetrics,
+			metricName:             c.MetricName,
+			metricType:             c.MetricType,
+			aggregationTemporality: c.AggregationTemporality,
+			exemplars:              exemplarsFromConfig(c),
+			limitPerSecond:         limit,
+			totalDuration:          c.TotalDuration,
+			running:                running,
+			wg:                     &wg,
+			logger:                 logger.With(zap.Int("worker", i)),
+			index:                  i,
 		}
 		exp, err := expF()
 		if err != nil {

cmd/telemetrygen/pkg/metrics/temporality_type.go

@@ -18,17 +18,17 @@ import (
 )
 
 type worker struct {
-	running         *atomic.Bool                 // pointer to shared flag that indicates it's time to stop the test
-	metricName      string                       // name of metric to generate
-	metricType      MetricType                   // type of metric to generate
-	temporalityType TemporalityType              // Temporality type to use
-	exemplars       []metricdata.Exemplar[int64] // exemplars to attach to the metric
-	numMetrics      int                          // how many metrics the worker has to generate (only when duration==0)
-	totalDuration   time.Duration                // how long to run the test for (overrides `numMetrics`)
-	limitPerSecond  rate.Limit                   // how many metrics per second to generate
-	wg              *sync.WaitGroup              // notify when done
-	logger          *zap.Logger                  // logger
-	index           int                          // worker index
+	running                *atomic.Bool                 // pointer to shared flag that indicates it's time to stop the test
+	metricName             string                       // name of metric to generate
+	metricType             MetricType                   // type of metric to generate
+	aggregationTemporality AggregationTemporality       // Temporality type to use
+	exemplars              []metricdata.Exemplar[int64] // exemplars to attach to the metric
+	numMetrics             int                          // how many metrics the worker has to generate (only when duration==0)
+	totalDuration          time.Duration                // how long to run the test for (overrides `numMetrics`)
+	limitPerSecond         rate.Limit                   // how many metrics per second to generate
+	wg                     *sync.WaitGroup              // notify when done
+	logger                 *zap.Logger                  // logger
+	index                  int                          // worker index
 }
 
 var histogramBucketSamples = []struct {
@@ -104,7 +104,7 @@ func (w worker) simulateMetrics(res *resource.Resource, exporter sdkmetric.Expor
 				Name: w.metricName,
 				Data: metricdata.Sum[int64]{
 					IsMonotonic: true,
-					Temporality: w.temporalityType.AsTemporality(),
+					Temporality: w.aggregationTemporality.AsTemporality(),
 					DataPoints: []metricdata.DataPoint[int64]{
 						{
 							StartTime:  time.Now().Add(-1 * time.Second),
@@ -123,7 +123,7 @@ func (w worker) simulateMetrics(res *resource.Resource, exporter sdkmetric.Expor
 			metrics = append(metrics, metricdata.Metrics{
 				Name: w.metricName,
 				Data: metricdata.Histogram[int64]{
-					Temporality: w.temporalityType.AsTemporality(),
+					Temporality: w.aggregationTemporality.AsTemporality(),
 					DataPoints: []metricdata.HistogramDataPoint[int64]{
 						{
 							StartTime:  time.Now().Add(-1 * time.Second),

cmd/telemetrygen/pkg/metrics/worker.go

@@ -50,16 +50,16 @@ func (m *mockExporter) Shutdown(_ context.Context) error {
 	return nil
 }
 
-func checkMetricTemporality(t *testing.T, ms metricdata.Metrics, metricType MetricType, expectedTemporality metricdata.Temporality) {
+func checkMetricTemporality(t *testing.T, ms metricdata.Metrics, metricType MetricType, expectedAggregationTemporality metricdata.Temporality) {
 	switch metricType {
 	case MetricTypeSum:
 		sumData, ok := ms.Data.(metricdata.Sum[int64])
 		require.True(t, ok, "expected Sum data type")
-		assert.Equal(t, expectedTemporality, sumData.Temporality)
+		assert.Equal(t, expectedAggregationTemporality, sumData.Temporality)
 	case MetricTypeHistogram:
 		histogramData, ok := ms.Data.(metricdata.Histogram[int64])
 		require.True(t, ok, "expected Histogram data type")
-		assert.Equal(t, expectedTemporality, histogramData.Temporality)
+		assert.Equal(t, expectedAggregationTemporality, histogramData.Temporality)
 	default:
 		t.Fatalf("unsupported metric type: %v", metricType)
 	}
@@ -115,34 +115,34 @@ func TestRateOfMetrics(t *testing.T) {
 
 func TestMetricsWithTemporality(t *testing.T) {
 	tests := []struct {
-		name                string
-		metricType          MetricType
-		temporalityType     TemporalityType
-		expectedTemporality metricdata.Temporality
+		name                           string
+		metricType                     MetricType
+		aggregationTemporality         AggregationTemporality
+		expectedAggregationTemporality metricdata.Temporality
 	}{
 		{
-			name:                "Sum: delta temporality",
-			metricType:          MetricTypeSum,
-			temporalityType:     TemporalityType(metricdata.DeltaTemporality),
-			expectedTemporality: metricdata.DeltaTemporality,
+			name:                           "Sum: delta temporality",
+			metricType:                     MetricTypeSum,
+			aggregationTemporality:         AggregationTemporality(metricdata.DeltaTemporality),
+			expectedAggregationTemporality: metricdata.DeltaTemporality,
 		},
 		{
-			name:                "Sum: cumulative temporality",
-			metricType:          MetricTypeSum,
-			temporalityType:     TemporalityType(metricdata.CumulativeTemporality),
-			expectedTemporality: metricdata.CumulativeTemporality,
+			name:                           "Sum: cumulative temporality",
+			metricType:                     MetricTypeSum,
+			aggregationTemporality:         AggregationTemporality(metricdata.CumulativeTemporality),
+			expectedAggregationTemporality: metricdata.CumulativeTemporality,
 		},
 		{
-			name:                "Histogram: delta temporality",
-			metricType:          MetricTypeHistogram,
-			temporalityType:     TemporalityType(metricdata.DeltaTemporality),
-			expectedTemporality: metricdata.DeltaTemporality,
+			name:                           "Histogram: delta temporality",
+			metricType:                     MetricTypeHistogram,
+			aggregationTemporality:         AggregationTemporality(metricdata.DeltaTemporality),
+			expectedAggregationTemporality: metricdata.DeltaTemporality,
 		},
 		{
-			name:                "Histogram: cumulative temporality",
-			metricType:          MetricTypeHistogram,
-			temporalityType:     TemporalityType(metricdata.CumulativeTemporality),
-			expectedTemporality: metricdata.CumulativeTemporality,
+			name:                           "Histogram: cumulative temporality",
+			metricType:                     MetricTypeHistogram,
+			aggregationTemporality:         AggregationTemporality(metricdata.CumulativeTemporality),
+			expectedAggregationTemporality: metricdata.CumulativeTemporality,
 		},
 	}
 
@@ -153,10 +153,10 @@ func TestMetricsWithTemporality(t *testing.T) {
 				Config: common.Config{
 					WorkerCount: 1,
 				},
-				NumMetrics:      1,
-				MetricName:      "test",
-				MetricType:      tt.metricType,
-				TemporalityType: tt.temporalityType,
+				NumMetrics:             1,
+				MetricName:             "test",
+				MetricType:             tt.metricType,
+				AggregationTemporality: tt.aggregationTemporality,
 			}
 			m := &mockExporter{}
 			expFunc := func() (sdkmetric.Exporter, error) {
@@ -174,7 +174,7 @@ func TestMetricsWithTemporality(t *testing.T) {
 			ms := m.rms[0].ScopeMetrics[0].Metrics[0]
 			assert.Equal(t, "test", ms.Name)
 
-			checkMetricTemporality(t, ms, tt.metricType, tt.expectedTemporality)
+			checkMetricTemporality(t, ms, tt.metricType, tt.expectedAggregationTemporality)
 		})
 	}
 }