Skip to content

[receiver/dockerstats] Disable container.cpu.usage.system by default, and expand description #14558

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dmitryax merged 2 commits into from
Oct 15, 2022
Merged

[receiver/dockerstats] Disable container.cpu.usage.system by default, and expand description #14558

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8d37266
expand description for container.cpu.usage.system
jamesmoessis Sep 28, 2022
f9e2bcb
add changelog
jamesmoessis Sep 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion receiver/dockerstatsreceiver/documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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> |
Expand Down
4 changes: 2 additions & 2 deletions receiver/dockerstatsreceiver/internal/metadata/generated_metrics.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 3 additions & 2 deletions receiver/dockerstatsreceiver/metadata.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,9 @@ attributes:
metrics:
# CPU
container.cpu.usage.system:
Comment thread
bogdandrutu marked this conversation as resolved.
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
Expand Down
2 changes: 1 addition & 1 deletion receiver/dockerstatsreceiver/testdata/mock/single_container/expected_metrics.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
4 changes: 2 additions & 2 deletions receiver/dockerstatsreceiver/testdata/mock/two_containers/expected_metrics.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down
5 changes: 5 additions & 0 deletions unreleased/system-usage-tweak.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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."