signaltometricsconnector: Add sum.monotonic property for improved counter handling

.chloggen/signaltometrics-sum-monotonic.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. receiver/filelog)
+component: connector/signal_to_metrics
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Add `sum.monotonic` property for improved counter handling
+
+# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
+issues: [45865]
+
+# (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: ['user']

connector/signaltometricsconnector/README.md

@@ -44,21 +44,25 @@ signal_to_metrics:
       description: Count of spans
       sum:
         value: Int(AdjustedCount()) # Count of total spans represented by each span
+        monotonic: true
   datapoints:
     - name: datapoint.count
       description: Count of datapoints
       sum:
         value: "1" # increment by 1 for each datapoint
+        monotonic: true
   logs:
     - name: logrecord.count
       description: Count of log records
       sum:
         value: "1" # increment by 1 for each log record
+        monotonic: true
   profiles:
     - name: profile.count
       description: Count of profiles
       sum:
         value: "1" # increment by 1 for each profile
+        monotonic: true
 ```
 
 ### Error Handling
@@ -104,13 +108,15 @@ Sum metrics have the following configurations:
 ```yaml
 sum:
   value: <ottl_value_expression>
+  monotonic: <bool>
 ```
 
 - [**Required**] `value` represents an OTTL expression to extract a value from the
   incoming data. Only OTTL expressions that return a value are accepted. The
   returned value determines the value type of the `sum` metric (`int` or `double`).
   [OTTL converters](https://pkg.go.dev/github.com/open-telemetry/opentelemetry-collector-contrib/pkg/ottl/ottlfuncs#readme-converters)
   can be used to transform the data.
+- [**Optional**] `monotonic` whether the generated metric is monotonic. It defaults to `false`.
 
 #### Gauge
 

connector/signaltometricsconnector/config/config.go

@@ -192,7 +192,8 @@ type ExponentialHistogram struct {
 }
 
 type Sum struct {
-	Value string `mapstructure:"value"`
+	Value       string `mapstructure:"value"`
+	IsMonotonic bool   `mapstructure:"monotonic"`
 	// prevent unkeyed literal initialization
 	_ struct{}
 }

connector/signaltometricsconnector/config/config.schema.yaml

@@ -98,5 +98,7 @@ $defs:
   sum:
     type: object
     properties:
+      monotonic:
+        type: boolean
       value:
         type: string

connector/signaltometricsconnector/config/config_test.go

@@ -182,7 +182,8 @@ func TestConfig(t *testing.T) {
 							`IsDouble(attributes["some.optional.1"])`,
 						},
 						Sum: configoptional.Some(Sum{
-							Value: `attributes["some.optional.1"]`,
+							Value:       `attributes["some.optional.1"]`,
+							IsMonotonic: false,
 						}),
 					},
 				},
@@ -200,7 +201,8 @@ func TestConfig(t *testing.T) {
 							`attributes["some.optional.1"] != nil`,
 						},
 						Sum: configoptional.Some(Sum{
-							Value: "1",
+							Value:       "1",
+							IsMonotonic: true,
 						}),
 					},
 				},
@@ -218,7 +220,8 @@ func TestConfig(t *testing.T) {
 							`duration_unix_nano > 0`,
 						},
 						Sum: configoptional.Some(Sum{
-							Value: "1",
+							Value:       "1",
+							IsMonotonic: true,
 						}),
 					},
 				},

connector/signaltometricsconnector/internal/aggregator/aggregator.go

@@ -195,6 +195,7 @@ func (a *Aggregator[K]) Finalize(mds []model.MetricDef[K]) {
 			destMetric.SetDescription(md.Key.Description)
 			destCounter := destMetric.SetEmptySum()
 			destCounter.SetAggregationTemporality(pmetric.AggregationTemporalityDelta)
+			destCounter.SetIsMonotonic(md.Sum.IsMonotonic)
 			destCounter.DataPoints().EnsureCapacity(len(dpMap))
 			for _, dp := range dpMap {
 				dp.Copy(a.timestamp, destCounter.DataPoints().AppendEmpty())

connector/signaltometricsconnector/internal/model/model.go

@@ -87,7 +87,8 @@ func (h *ExponentialHistogram[K]) fromConfig(
 }
 
 type Sum[K any] struct {
-	Value *ottl.ValueExpression[K]
+	Value       *ottl.ValueExpression[K]
+	IsMonotonic bool
 }
 
 func (s *Sum[K]) fromConfig(
@@ -103,6 +104,7 @@ func (s *Sum[K]) fromConfig(
 	if err != nil {
 		return fmt.Errorf("failed to parse value OTTL expression for sum: %w", err)
 	}
+	s.IsMonotonic = mi.IsMonotonic
 	return nil
 }
 

connector/signaltometricsconnector/testdata/configs/valid_full.yaml

@@ -53,6 +53,7 @@ signal_to_metrics:
         - IsDouble(attributes["some.optional.1"])
       sum:
         value: attributes["some.optional.1"]
+        monotonic: false
   logs:
     - name: log.sum
       description: Sum
@@ -69,6 +70,7 @@ signal_to_metrics:
         - attributes["some.optional.1"] != nil
       sum:
         value: "1"
+        monotonic: true
   profiles:
     - name: profile.sum
       description: Sum
@@ -85,3 +87,4 @@ signal_to_metrics:
         - duration_unix_nano > 0
       sum:
         value: "1"
+        monotonic: true

connector/signaltometricsconnector/testdata/logs/sum/config.yaml

@@ -4,18 +4,21 @@ signal_to_metrics:
       description: Count total number of log records
       sum:
         value: "1"
+        monotonic: true
     - name: total.logrecords.resource.foo.sum
       description: Count total number of log records with resource attribute foo
       include_resource_attributes:
         - key: resource.foo
       sum:
         value: "1"
+        monotonic: true
     - name: log.foo.sum
       description: Count total number of log records as per log.foo attribute
       attributes:
         - key: log.foo
       sum:
         value: "1"
+        monotonic: true
     - name: log.bar.sum
       description: Count total number of log records as per log.bar attribute
       conditions: # Will evaluate to true
@@ -25,6 +28,7 @@ signal_to_metrics:
         - key: log.bar
       sum:
         value: "1"
+        monotonic: true
     - name: ignored.sum
       description: Will be ignored due to conditions evaluating to false
       conditions: # Will evaluate to false
@@ -33,3 +37,4 @@ signal_to_metrics:
         - key: log.bar
       sum:
         value: "2"
+        monotonic: true

connector/signaltometricsconnector/testdata/logs/sum/output.yaml

@@ -19,6 +19,7 @@ resourceMetrics:
               dataPoints:
                 - asInt: "4"
                   timeUnixNano: "1000000"
+              isMonotonic: true
           - description: Count total number of log records as per log.foo attribute
             name: log.foo.sum
             sum:
@@ -36,6 +37,7 @@ resourceMetrics:
                       value:
                         stringValue: notfoo
                   timeUnixNano: "1000000"
+              isMonotonic: true
           - description: Count total number of log records as per log.bar attribute
             name: log.bar.sum
             sum:
@@ -53,6 +55,7 @@ resourceMetrics:
                       value:
                         stringValue: notbar
                   timeUnixNano: "1000000"
+              isMonotonic: true
         scope:
           name: github.com/open-telemetry/opentelemetry-collector-contrib/connector/signaltometricsconnector
   - resource:
@@ -72,5 +75,6 @@ resourceMetrics:
               dataPoints:
                 - asInt: "4"
                   timeUnixNano: "1000000"
+              isMonotonic: true
         scope:
           name: github.com/open-telemetry/opentelemetry-collector-contrib/connector/signaltometricsconnector

connector/signaltometricsconnector/testdata/metrics/metrics.yaml

@@ -77,7 +77,7 @@ resourceMetrics:
                   timeUnixNano: "1581452773000000789"
             name: gauge-double
             unit: "1"
-          - name: counter-int
+          - name: sum-int
             sum:
               aggregationTemporality: 2
               dataPoints:
@@ -91,7 +91,7 @@ resourceMetrics:
                         stringValue: bar
                   startTimeUnixNano: "1581452772000000321"
                   timeUnixNano: "1581452773000000789"
-                - asInt: "456"
+                - asInt: "-456"
                   attributes:
                     - key: datapoint.foo
                       value:
@@ -111,7 +111,7 @@ resourceMetrics:
                 - asInt: "0"
                   startTimeUnixNano: "1581452772000000321"
                   timeUnixNano: "1581452773000000789"
-              isMonotonic: true
+              isMonotonic: false
             unit: "1"
           - name: counter-double
             sum:

connector/signaltometricsconnector/testdata/metrics/sum/config.yaml

@@ -4,12 +4,14 @@ signal_to_metrics:
       description: Count total number of datapoints
       sum:
         value: "1"
+        monotonic: true
     - name: datapoint.foo.sum
       description: Count total number of datapoints as per datapoint.foo attribute
       attributes:
         - key: datapoint.foo
       sum:
         value: "1"
+        monotonic: true
     - name: datapoint.bar.sum
       description: Count total number of datapoints as per datapoint.bar attribute
       conditions: # Will evaluate to true
@@ -19,6 +21,7 @@ signal_to_metrics:
         - key: datapoint.bar
       sum:
         value: "1"
+        monotonic: true
     - name: ignored.sum
       description: Will be ignored due to conditions evaluating to false
       conditions: # Will evaluate to false
@@ -27,3 +30,11 @@ signal_to_metrics:
         - key: datapoint.bar
       sum:
         value: "2"
+        monotonic: true
+    - name: non.monotonic.sum
+      description: A non-monotonic sum
+      conditions:
+        - metric.name == "sum-int"
+      sum:
+        value: datapoint.value_int
+        # monotonic: false by default

connector/signaltometricsconnector/testdata/metrics/sum/output.yaml

@@ -19,6 +19,7 @@ resourceMetrics:
               dataPoints:
                 - asInt: "24"
                   timeUnixNano: "1000000"
+              isMonotonic: true
           - description: Count total number of datapoints as per datapoint.foo attribute
             name: datapoint.foo.sum
             sum:
@@ -36,6 +37,7 @@ resourceMetrics:
                       value:
                         stringValue: notfoo
                   timeUnixNano: "1000000"
+              isMonotonic: true
           - description: Count total number of datapoints as per datapoint.bar attribute
             name: datapoint.bar.sum
             sum:
@@ -53,5 +55,14 @@ resourceMetrics:
                       value:
                         stringValue: notbar
                   timeUnixNano: "1000000"
+              isMonotonic: true
+          - description: A non-monotonic sum
+            name: non.monotonic.sum
+            sum:
+              aggregationTemporality: 1
+              dataPoints:
+                - asInt: "456"
+                  timeUnixNano: "1000000"
+              isMonotonic: false
         scope:
           name: github.com/open-telemetry/opentelemetry-collector-contrib/connector/signaltometricsconnector

connector/signaltometricsconnector/testdata/profiles/sum/config.yaml

@@ -4,18 +4,21 @@ signal_to_metrics:
       description: Count total number of profiles
       sum:
         value: "1"
+        monotonic: true
     - name: total.profiles.resource.foo.sum
       description: Count total number of profiles with resource attribute foo
       include_resource_attributes:
         - key: resource.foo
       sum:
         value: "1"
+        monotonic: true
     - name: profiles.foo.sum
       description: Count total number of profiles as per profile.foo attribute
       attributes:
         - key: profile.foo
       sum:
         value: "1"
+        monotonic: true
     - name: profiles.bar.sum
       description: Count total number of profiles as per profiles.bar attribute
       conditions: # Will evaluate to true
@@ -25,6 +28,7 @@ signal_to_metrics:
         - key: profiles.bar
       sum:
         value: "1"
+        monotonic: true
     - name: ignored.sum
       description: Will be ignored due to conditions evaluating to false
       conditions: # Will evaluate to false
@@ -33,3 +37,4 @@ signal_to_metrics:
         - key: profiles.bar
       sum:
         value: "2"
+        monotonic: true

connector/signaltometricsconnector/testdata/profiles/sum/output.yaml

@@ -19,6 +19,7 @@ resourceMetrics:
               dataPoints:
                 - asInt: "3"
                   timeUnixNano: "1000000"
+              isMonotonic: true
           - description: Count total number of profiles as per profile.foo attribute
             name: profiles.foo.sum
             sum:
@@ -30,6 +31,7 @@ resourceMetrics:
                       value:
                         stringValue: foo
                   timeUnixNano: "1000000"
+              isMonotonic: true
         scope:
           name: github.com/open-telemetry/opentelemetry-collector-contrib/connector/signaltometricsconnector
   - resource:
@@ -49,5 +51,6 @@ resourceMetrics:
               dataPoints:
                 - asInt: "3"
                   timeUnixNano: "1000000"
+              isMonotonic: true
         scope:
           name: github.com/open-telemetry/opentelemetry-collector-contrib/connector/signaltometricsconnector