[bugfix][apachesparkreceiver] Correct inaccurate metric units (#29104)

**Description:** Replacing inaccurate units for the spark.job.stage.active and spark.job.stage.result metrics for the Apache Spark receiver. **Link to tracking Issue:** [29104](#29104) **Testing:** N/A **Documentation:** Documentation for the metadata.yaml file was updated accordingly.
open-telemetry · Nov 14, 2023 · bf6edaf · bf6edaf
1 parent 546340d
commit bf6edaf
Show file tree

Hide file tree

Showing 7 changed files with 39 additions and 12 deletions.
diff --git a/.chloggen/fix-spark-custom-unit.yaml b/.chloggen/fix-spark-custom-unit.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: 'bug_fix'
+
+# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
+component: apachesparkreceiver
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Replacing inaccurate units for the spark.job.stage.active and spark.job.stage.result metrics for the Apache Spark receiver.
+
+# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
+issues: [29104]
+
+# (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]
diff --git a/receiver/apachesparkreceiver/documentation.md b/receiver/apachesparkreceiver/documentation.md
@@ -406,15 +406,15 @@ Number of active stages in this job.
 
 | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
 | ---- | ----------- | ---------- | ----------------------- | --------- |
-| { task } | Sum | Int | Cumulative | false |
+| { stage } | Sum | Int | Cumulative | false |
 
 ### spark.job.stage.result
 
 Number of stages with a specific result in this job.
 
 | Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
 | ---- | ----------- | ---------- | ----------------------- | --------- |
-| { task } | Sum | Int | Cumulative | true |
+| { stage } | Sum | Int | Cumulative | true |
 
 #### Attributes
 

diff --git a/receiver/apachesparkreceiver/internal/metadata/generated_metrics.go b/receiver/apachesparkreceiver/internal/metadata/generated_metrics.go
diff --git a/receiver/apachesparkreceiver/internal/metadata/generated_metrics_test.go b/receiver/apachesparkreceiver/internal/metadata/generated_metrics_test.go
diff --git a/receiver/apachesparkreceiver/metadata.yaml b/receiver/apachesparkreceiver/metadata.yaml
@@ -416,7 +416,7 @@ metrics:
       aggregation_temporality: cumulative
       monotonic: false
       value_type: int
-    unit: "{ task }"
+    unit: "{ stage }"
     attributes: []
   spark.job.stage.result:
     description: Number of stages with a specific result in this job.
@@ -425,7 +425,7 @@ metrics:
       aggregation_temporality: cumulative
       monotonic: true
       value_type: int
-    unit: "{ task }"
+    unit: "{ stage }"
     attributes: [job_result]
   # metrics
   spark.driver.block_manager.disk.usage:

diff --git a/receiver/apachesparkreceiver/testdata/expected_metrics/metrics_golden.yaml b/receiver/apachesparkreceiver/testdata/expected_metrics/metrics_golden.yaml
@@ -598,7 +598,7 @@ resourceMetrics:
                 - asInt: "0"
                   startTimeUnixNano: "1000000"
                   timeUnixNano: "2000000"
-            unit: '{ task }'
+            unit: '{ stage }'
           - description: Number of stages with a specific result in this job.
             name: spark.job.stage.result
             sum:
@@ -626,7 +626,7 @@ resourceMetrics:
                   startTimeUnixNano: "1000000"
                   timeUnixNano: "2000000"
               isMonotonic: true
-            unit: '{ task }'
+            unit: '{ stage }'
           - description: Number of active tasks in this job.
             name: spark.job.task.active
             sum:

diff --git a/receiver/apachesparkreceiver/testdata/integration/expected.yaml b/receiver/apachesparkreceiver/testdata/integration/expected.yaml
@@ -1178,7 +1178,7 @@ resourceMetrics:
                 - asInt: "1"
                   startTimeUnixNano: "1684786599036141000"
                   timeUnixNano: "1684786605037452000"
-            unit: '{ task }'
+            unit: '{ stage }'
           - description: Number of stages with a specific result in this job.
             name: spark.job.stage.result
             sum:
@@ -1206,7 +1206,7 @@ resourceMetrics:
                   startTimeUnixNano: "1684786599036141000"
                   timeUnixNano: "1684786605037452000"
               isMonotonic: true
-            unit: '{ task }'
+            unit: '{ stage }'
           - description: Number of active tasks in this job.
             name: spark.job.task.active
             sum: