Merge pull request #4 from zeno-splunk/fix-metric

[chore]Fix metrics in kafkametricsreceiver (open-telemetry#4327)
chengchuanpeng · Jun 14, 2023 · ab1629e · ab1629e
2 parents d007d69 + fc3172e
commit ab1629e
Show file tree

Hide file tree

Showing 6 changed files with 82 additions and 59 deletions.
diff --git a/.chloggen/fix-kafkametric-receiver-type.yaml → ...oggen/fix-kafkametric-receiver-types.yaml b/.chloggen/fix-kafkametric-receiver-type.yaml → ...oggen/fix-kafkametric-receiver-types.yaml
@@ -17,4 +17,4 @@ issues: [4327]
 # (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: Update the metric type in KafkaMetricsReceiver from "gauge" to "nonmonotonic sum".
+subtext: Update metrics type in KafkaMetricsReceiver from "gauge" to "nonmonotonic sum".
diff --git a/receiver/kafkametricsreceiver/documentation.md b/receiver/kafkametricsreceiver/documentation.md
@@ -55,9 +55,9 @@ Current approximate sum of consumer group lag across all partitions of topic
 
 Count of members in the consumer group
 
-| Unit | Metric Type | Value Type |
-| ---- | ----------- | ---------- |
-| {members} | Gauge | Int |
+| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
+| ---- | ----------- | ---------- | ----------------------- | --------- |
+| {members} | Sum | Int | Delta | false |
 
 #### Attributes
 
@@ -130,9 +130,9 @@ Oldest offset of partition of topic
 
 Number of replicas for partition of topic
 
-| Unit | Metric Type | Value Type |
-| ---- | ----------- | ---------- |
-| {replicas} | Gauge | Int |
+| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
+| ---- | ----------- | ---------- | ----------------------- | --------- |
+| {replicas} | Sum | Int | Delta | false |
 
 #### Attributes
 
@@ -145,9 +145,9 @@ Number of replicas for partition of topic
 
 Number of synchronized replicas of partition
 
-| Unit | Metric Type | Value Type |
-| ---- | ----------- | ---------- |
-| {replicas} | Gauge | Int |
+| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
+| ---- | ----------- | ---------- | ----------------------- | --------- |
+| {replicas} | Sum | Int | Delta | false |
 
 #### Attributes
 
@@ -160,9 +160,9 @@ Number of synchronized replicas of partition
 
 Number of partitions in topic.
 
-| Unit | Metric Type | Value Type |
-| ---- | ----------- | ---------- |
-| {partitions} | Gauge | Int |
+| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
+| ---- | ----------- | ---------- | ----------------------- | --------- |
+| {partitions} | Sum | Int | Delta | false |
 
 #### Attributes
 

diff --git a/receiver/kafkametricsreceiver/internal/metadata/generated_metrics.go b/receiver/kafkametricsreceiver/internal/metadata/generated_metrics.go
diff --git a/receiver/kafkametricsreceiver/internal/metadata/generated_metrics_test.go b/receiver/kafkametricsreceiver/internal/metadata/generated_metrics_test.go
diff --git a/receiver/kafkametricsreceiver/metadata.yaml b/receiver/kafkametricsreceiver/metadata.yaml
@@ -32,8 +32,10 @@ metrics:
     enabled: true
     description: Number of partitions in topic.
     unit: "{partitions}"
-    gauge:
+    sum:
+      monotonic: false
       value_type: int
+      aggregation: delta
     attributes: [topic]
   kafka.partition.current_offset:
     enabled: true
@@ -53,23 +55,29 @@ metrics:
     enabled: true
     description: Number of replicas for partition of topic
     unit: "{replicas}"
-    gauge:
+    sum:
+      monotonic: false
       value_type: int
+      aggregation: delta
     attributes: [topic, partition]
   kafka.partition.replicas_in_sync:
     enabled: true
     description: Number of synchronized replicas of partition
     unit: "{replicas}"
-    gauge:
+    sum:
+      monotonic: false
       value_type: int
+      aggregation: delta
     attributes: [topic, partition]
   #  consumers scraper
   kafka.consumer_group.members:
     enabled: true
     description: Count of members in the consumer group
     unit: "{members}"
-    gauge:
+    sum:
+      monotonic: false
       value_type: int
+      aggregation: delta
     attributes: [group]
   kafka.consumer_group.offset:
     enabled: true

diff --git a/receiver/kafkametricsreceiver/topic_scraper_test.go b/receiver/kafkametricsreceiver/topic_scraper_test.go
@@ -123,18 +123,17 @@ func TestTopicScraper_scrapes(t *testing.T) {
 	ms := md.ResourceMetrics().At(0).ScopeMetrics().At(0).Metrics()
 	for i := 0; i < ms.Len(); i++ {
 		m := ms.At(i)
-		dp := m.Gauge().DataPoints().At(0)
 		switch m.Name() {
 		case "kafka.topic.partitions":
-			assert.Equal(t, dp.IntValue(), int64(len(testPartitions)))
+			assert.Equal(t, m.Sum().DataPoints().At(0).IntValue(), int64(len(testPartitions)))
 		case "kafka.partition.current_offset":
-			assert.Equal(t, dp.IntValue(), testOffset)
+			assert.Equal(t, m.Gauge().DataPoints().At(0).IntValue(), testOffset)
 		case "kafka.partition.oldest_offset":
-			assert.Equal(t, dp.IntValue(), testOffset)
+			assert.Equal(t, m.Gauge().DataPoints().At(0).IntValue(), testOffset)
 		case "kafka.partition.replicas":
-			assert.Equal(t, dp.IntValue(), int64(len(testReplicas)))
+			assert.Equal(t, m.Sum().DataPoints().At(0).IntValue(), int64(len(testReplicas)))
 		case "kafka.partition.replicas_in_sync":
-			assert.Equal(t, dp.IntValue(), int64(len(testReplicas)))
+			assert.Equal(t, m.Sum().DataPoints().At(0).IntValue(), int64(len(testReplicas)))
 		}
 	}
 }