[receiver/dockerstats] Disable container.cpu.usage.system by default,…

… and expand description (open-telemetry#14558)
shalper2 · Dec 6, 2022 · 1fa9ee6 · 1fa9ee6
1 parent a7a3891
commit 1fa9ee6
Show file tree

Hide file tree

Showing 6 changed files with 14 additions and 8 deletions.
diff --git a/receiver/dockerstatsreceiver/documentation.md b/receiver/dockerstatsreceiver/documentation.md
@@ -22,7 +22,7 @@ These are the metrics available for this scraper.
 | container.cpu.throttling_data.throttled_time | Aggregate time the container was throttled. | ns | Sum(Int) | <ul> </ul> |
 | **container.cpu.usage.kernelmode** | Time spent by tasks of the cgroup in kernel mode (Linux).  Time spent by all container processes in kernel mode (Windows). | ns | Sum(Int) | <ul> </ul> |
 | container.cpu.usage.percpu | Per-core CPU usage by the container. | ns | Sum(Int) | <ul> <li>core</li> </ul> |
-| **container.cpu.usage.system** | System CPU usage. | ns | Sum(Int) | <ul> </ul> |
+| container.cpu.usage.system | System CPU usage, as reported by docker. Note this is the usage for the system, not the container. | ns | Sum(Int) | <ul> </ul> |
 | **container.cpu.usage.total** | Total CPU time consumed. | ns | Sum(Int) | <ul> </ul> |
 | **container.cpu.usage.usermode** | Time spent by tasks of the cgroup in user mode (Linux).  Time spent by all container processes in user mode (Windows). | ns | Sum(Int) | <ul> </ul> |
 | container.memory.active_anon | The amount of anonymous memory that has been identified as active by the kernel. | By | Sum(Int) | <ul> </ul> |

diff --git a/receiver/dockerstatsreceiver/internal/metadata/generated_metrics.go b/receiver/dockerstatsreceiver/internal/metadata/generated_metrics.go
diff --git a/receiver/dockerstatsreceiver/metadata.yaml b/receiver/dockerstatsreceiver/metadata.yaml
@@ -40,8 +40,9 @@ attributes:
 metrics:
   # CPU
   container.cpu.usage.system:
-    enabled: true
-    description: "System CPU usage."
+    enabled: false
+    description: "System CPU usage, as reported by docker."
+    extended_documentation: "Note this is the usage for the system, not the container."
     unit: ns
     sum:
       value_type: int

diff --git a/receiver/dockerstatsreceiver/testdata/mock/single_container/expected_metrics.json b/receiver/dockerstatsreceiver/testdata/mock/single_container/expected_metrics.json
@@ -374,7 +374,7 @@
               "unit": "{operations}"
             },
             {
-              "description": "System CPU usage.",
+              "description": "System CPU usage, as reported by docker.",
               "name": "container.cpu.usage.system",
               "sum": {
                 "aggregationTemporality": "AGGREGATION_TEMPORALITY_CUMULATIVE",

diff --git a/receiver/dockerstatsreceiver/testdata/mock/two_containers/expected_metrics.json b/receiver/dockerstatsreceiver/testdata/mock/two_containers/expected_metrics.json
@@ -374,7 +374,7 @@
               "unit": "{operations}"
             },
             {
-              "description": "System CPU usage.",
+              "description": "System CPU usage, as reported by docker.",
               "name": "container.cpu.usage.system",
               "sum": {
                 "aggregationTemporality": "AGGREGATION_TEMPORALITY_CUMULATIVE",
@@ -1591,7 +1591,7 @@
               "unit": "{operations}"
             },
             {
-              "description": "System CPU usage.",
+              "description": "System CPU usage, as reported by docker.",
               "name": "container.cpu.usage.system",
               "sum": {
                 "aggregationTemporality": "AGGREGATION_TEMPORALITY_CUMULATIVE",

diff --git a/unreleased/system-usage-tweak.yaml b/unreleased/system-usage-tweak.yaml
@@ -0,0 +1,5 @@
+change_type: breaking
+component: dockerstatsreceiver
+note: "`container.cpu.usage.system` is no longer a default metric. Added more description for the metric."
+issues: [9794, 14558]
+subtext: "Change is not breaking unless you are have enabled the featuregate `receiver.dockerstats.useScraperV2` and are using the specified metric."