Skip to content

Add Battery Check for Windows#43789

Merged
dd-mergequeue[bot] merged 18 commits into
mainfrom
mrafi/battery-check
Dec 12, 2025
Merged

Add Battery Check for Windows#43789
dd-mergequeue[bot] merged 18 commits into
mainfrom
mrafi/battery-check

Conversation

@mrafi97

@mrafi97 mrafi97 commented Dec 3, 2025

Copy link
Copy Markdown
Contributor

What does this PR do?

This PR adds the battery check implementation for Windows. The battery check will collect metrics for the system battery in a Windows host. The check will not run if there is no battery detected in the system.

Motivation

https://datadoghq.atlassian.net/browse/WINA-2033

Describe how you validated your changes

Enable the battery check by setting the following in battery.d/conf.yaml:

init_config:
instances:
  -

Restart the Agent and run a check run command to ensure that metrics are collected:

PS C:\> & "$env:ProgramFiles\Datadog\Datadog Agent\bin\agent.exe" check battery --table -l debug
...
=== Series ===
  METRIC                               TYPE   TIMESTAMP   VALUE  TAGS
  system.battery.charge_rate           gauge  1764878994  855
  system.battery.current_charge        gauge  1764878994  90
  system.battery.cycle_count           gauge  1764878994  0
  system.battery.designed_capacity     gauge  1764878994  5000
  system.battery.maximum_capacity      gauge  1764878994  5000
  system.battery.maximum_capacity_pct  gauge  1764878994  100
  system.battery.power_state           gauge  1764878994  1      power_state:battery_charging, power_state:battery_power_on_line
  system.battery.voltage               gauge  1764878994  5000

Additional Notes

@github-actions github-actions Bot added long review PR is complex, plan time to review it team/agent-runtimes labels Dec 3, 2025
@mrafi97 mrafi97 added the qa/done QA done before merge and regressions are covered by tests label Dec 3, 2025
@agent-platform-auto-pr

agent-platform-auto-pr Bot commented Dec 3, 2025

Copy link
Copy Markdown
Contributor

Go Package Import Differences

Baseline: 791d697
Comparison: 646ed6e

binaryosarchchange
agentlinuxamd64
+1, -0
+github.com/DataDog/datadog-agent/pkg/collector/corechecks/system/battery
agentlinuxarm64
+1, -0
+github.com/DataDog/datadog-agent/pkg/collector/corechecks/system/battery
agentwindowsamd64
+1, -0
+github.com/DataDog/datadog-agent/pkg/collector/corechecks/system/battery
agentdarwinamd64
+1, -0
+github.com/DataDog/datadog-agent/pkg/collector/corechecks/system/battery
agentdarwinarm64
+1, -0
+github.com/DataDog/datadog-agent/pkg/collector/corechecks/system/battery
iot-agentlinuxamd64
+1, -0
+github.com/DataDog/datadog-agent/pkg/collector/corechecks/system/battery
iot-agentlinuxarm64
+1, -0
+github.com/DataDog/datadog-agent/pkg/collector/corechecks/system/battery
heroku-agentlinuxamd64
+1, -0
+github.com/DataDog/datadog-agent/pkg/collector/corechecks/system/battery

@cit-pr-commenter

cit-pr-commenter Bot commented Dec 3, 2025

Copy link
Copy Markdown

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: 73023dd7-57d5-499a-b294-55863005bf45

Baseline: 791d697
Comparison: 646ed6e
Diff

Optimization Goals: ✅ No significant changes detected

Experiments ignored for regressions

Regressions in experiments with settings containing erratic: true are ignored.

perf experiment goal Δ mean % Δ mean % CI trials links
docker_containers_cpu % cpu utilization +1.09 [-1.97, +4.16] 1 Logs

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
docker_containers_cpu % cpu utilization +1.09 [-1.97, +4.16] 1 Logs
ddot_metrics_sum_cumulative memory utilization +0.93 [+0.77, +1.09] 1 Logs
quality_gate_logs % cpu utilization +0.51 [-0.96, +1.99] 1 Logs bounds checks dashboard
docker_containers_memory memory utilization +0.33 [+0.25, +0.41] 1 Logs
quality_gate_metrics_logs memory utilization +0.10 [-0.11, +0.31] 1 Logs bounds checks dashboard
file_to_blackhole_100ms_latency egress throughput +0.08 [+0.03, +0.13] 1 Logs
file_to_blackhole_0ms_latency egress throughput +0.06 [-0.34, +0.45] 1 Logs
file_to_blackhole_1000ms_latency egress throughput +0.01 [-0.40, +0.42] 1 Logs
uds_dogstatsd_to_api_v3 ingress throughput +0.01 [-0.13, +0.14] 1 Logs
quality_gate_idle memory utilization +0.00 [-0.04, +0.05] 1 Logs bounds checks dashboard
tcp_dd_logs_filter_exclude ingress throughput +0.00 [-0.07, +0.07] 1 Logs
uds_dogstatsd_to_api ingress throughput -0.00 [-0.13, +0.13] 1 Logs
quality_gate_idle_all_features memory utilization -0.01 [-0.06, +0.03] 1 Logs bounds checks dashboard
ddot_metrics_sum_delta memory utilization -0.05 [-0.26, +0.15] 1 Logs
file_to_blackhole_500ms_latency egress throughput -0.08 [-0.45, +0.29] 1 Logs
file_tree memory utilization -0.09 [-0.15, -0.03] 1 Logs
otlp_ingest_metrics memory utilization -0.16 [-0.31, -0.02] 1 Logs
ddot_logs memory utilization -0.27 [-0.34, -0.20] 1 Logs
uds_dogstatsd_20mb_12k_contexts_20_senders memory utilization -0.27 [-0.33, -0.22] 1 Logs
otlp_ingest_logs memory utilization -0.50 [-0.60, -0.40] 1 Logs
ddot_metrics memory utilization -0.52 [-0.74, -0.30] 1 Logs
ddot_metrics_sum_cumulativetodelta_exporter memory utilization -0.63 [-0.86, -0.40] 1 Logs
tcp_syslog_to_blackhole ingress throughput -0.83 [-0.89, -0.77] 1 Logs

Bounds Checks: ❌ Failed

perf experiment bounds_check_name replicates_passed links
docker_containers_cpu simple_check_run 10/10
docker_containers_memory memory_usage 10/10
docker_containers_memory simple_check_run 10/10
file_to_blackhole_0ms_latency lost_bytes 10/10
file_to_blackhole_0ms_latency memory_usage 10/10
file_to_blackhole_1000ms_latency lost_bytes 10/10
file_to_blackhole_1000ms_latency memory_usage 10/10
file_to_blackhole_100ms_latency lost_bytes 10/10
file_to_blackhole_100ms_latency memory_usage 10/10
file_to_blackhole_500ms_latency lost_bytes 10/10
file_to_blackhole_500ms_latency memory_usage 10/10
quality_gate_idle intake_connections 10/10 bounds checks dashboard
quality_gate_idle memory_usage 10/10 bounds checks dashboard
quality_gate_idle_all_features intake_connections 10/10 bounds checks dashboard
quality_gate_idle_all_features memory_usage 9/10 bounds checks dashboard
quality_gate_logs intake_connections 10/10 bounds checks dashboard
quality_gate_logs lost_bytes 10/10 bounds checks dashboard
quality_gate_logs memory_usage 10/10 bounds checks dashboard
quality_gate_metrics_logs cpu_usage 10/10 bounds checks dashboard
quality_gate_metrics_logs intake_connections 10/10 bounds checks dashboard
quality_gate_metrics_logs lost_bytes 10/10 bounds checks dashboard
quality_gate_metrics_logs memory_usage 10/10 bounds checks dashboard

Explanation

Confidence level: 90.00%
Effect size tolerance: |Δ mean %| ≥ 5.00%

Performance changes are noted in the perf column of each table:

  • ✅ = significantly better comparison variant performance
  • ❌ = significantly worse comparison variant performance
  • ➖ = no significant change in performance

A regression test is an A/B test of target performance in a repeatable rig, where "performance" is measured as "comparison variant minus baseline variant" for an optimization goal (e.g., ingress throughput). Due to intrinsic variability in measuring that goal, we can only estimate its mean value for each experiment; we report uncertainty in that value as a 90.00% confidence interval denoted "Δ mean % CI".

For each experiment, we decide whether a change in performance is a "regression" -- a change worth investigating further -- if all of the following criteria are true:

  1. Its estimated |Δ mean %| ≥ 5.00%, indicating the change is big enough to merit a closer look.

  2. Its 90.00% confidence interval "Δ mean % CI" does not contain zero, indicating that if our statistical model is accurate, there is at least a 90.00% chance there is a difference in performance between baseline and comparison variants.

  3. Its configuration does not mark it "erratic".

CI Pass/Fail Decision

Failed. Some Quality Gates were violated.

  • quality_gate_logs, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check lost_bytes: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check intake_connections: 10/10 replicas passed. Gate passed.
  • quality_gate_idle, bounds check intake_connections: 10/10 replicas passed. Gate passed.
  • quality_gate_idle, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_metrics_logs, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_metrics_logs, bounds check cpu_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_metrics_logs, bounds check intake_connections: 10/10 replicas passed. Gate passed.
  • quality_gate_metrics_logs, bounds check lost_bytes: 10/10 replicas passed. Gate passed.
  • quality_gate_idle_all_features, bounds check intake_connections: 10/10 replicas passed. Gate passed.
  • quality_gate_idle_all_features, bounds check memory_usage: 9/10 replicas passed. Failed 1 which is > 0. Gate FAILED.

@agent-platform-auto-pr

agent-platform-auto-pr Bot commented Dec 3, 2025

Copy link
Copy Markdown
Contributor

Static quality checks

✅ Please find below the results from static quality gates
Comparison made with ancestor 791d697

Successful checks

Info

Quality gate Delta On disk size (MiB) Delta On wire size (MiB)
agent_deb_amd64 $${+0}$$ $${705.41}$$ < $${706.32}$$ $${+0.04}$$ $${172.87}$$ < $${173.81}$$
agent_deb_amd64_fips $${+0}$$ $${700.74}$$ < $${701.16}$$ $${-0.01}$$ $${171.84}$$ < $${172.71}$$
agent_heroku_amd64 $${+0.01}$$ $${327.22}$$ < $${327.69}$$ $${-0.01}$$ $${87.24}$$ < $${88.19}$$
agent_msi $${+0.1}$$ $${979.93}$$ < $${982.08}$$ $${+0}$$ $${141.73}$$ < $${143.01}$$
agent_rpm_amd64 $${+0}$$ $${705.39}$$ < $${706.31}$$ $${+0.02}$$ $${175.93}$$ < $${176.86}$$
agent_rpm_amd64_fips $${+0}$$ $${700.73}$$ < $${701.15}$$ $${-0.01}$$ $${173.92}$$ < $${174.95}$$
agent_rpm_arm64 $${+0.01}$$ $${691.06}$$ < $${691.67}$$ $${+0.02}$$ $${159.71}$$ < $${160.7}$$
agent_rpm_arm64_fips $${+0}$$ $${687.29}$$ < $${687.54}$$ $${+0}$$ $${159.13}$$ < $${160.1}$$
agent_suse_amd64 $${+0}$$ $${705.39}$$ < $${706.31}$$ $${+0.02}$$ $${175.93}$$ < $${176.86}$$
agent_suse_amd64_fips $${+0}$$ $${700.73}$$ < $${701.15}$$ $${-0.01}$$ $${173.92}$$ < $${174.95}$$
agent_suse_arm64 $${+0.01}$$ $${691.06}$$ < $${691.67}$$ $${+0.02}$$ $${159.71}$$ < $${160.7}$$
agent_suse_arm64_fips $${+0}$$ $${687.29}$$ < $${687.54}$$ $${+0}$$ $${159.13}$$ < $${160.1}$$
docker_agent_amd64 $${+0}$$ $${767.74}$$ < $${768.66}$$ $${-0.01}$$ $${260.6}$$ < $${261.52}$$
docker_agent_arm64 $${+0.01}$$ $${777.68}$$ < $${778.35}$$ $${-0.01}$$ $${250.78}$$ < $${251.72}$$
docker_agent_jmx_amd64 $${+0}$$ $${958.61}$$ < $${959.54}$$ $${+0.01}$$ $${329.25}$$ < $${330.15}$$
docker_agent_jmx_arm64 $${+0.01}$$ $${957.28}$$ < $${957.95}$$ $${-0}$$ $${315.4}$$ < $${316.35}$$
docker_cluster_agent_amd64 $${+0}$$ $${179.09}$$ < $${179.28}$$ $${+0}$$ $${63.24}$$ < $${63.96}$$
docker_cluster_agent_arm64 $${-0}$$ $${196.58}$$ < $${196.79}$$ $${+0}$$ $${59.96}$$ < $${60.69}$$
docker_cws_instrumentation_amd64 $${-0}$$ $${7.07}$$ < $${7.12}$$ $${-0}$$ $${2.95}$$ < $${3.29}$$
docker_cws_instrumentation_arm64 $${+0}$$ $${6.69}$$ < $${6.92}$$ $${+0}$$ $${2.71}$$ < $${3.07}$$
docker_dogstatsd_amd64 $${0}$$ $${38.65}$$ < $${39.3}$$ $${+0}$$ $${14.92}$$ < $${15.76}$$
docker_dogstatsd_arm64 $${0}$$ $${37.3}$$ < $${37.94}$$ $${+0}$$ $${14.38}$$ < $${14.83}$$
dogstatsd_deb_amd64 $${0}$$ $${29.86}$$ < $${30.53}$$ $${-0}$$ $${7.87}$$ < $${8.75}$$
dogstatsd_deb_arm64 $${0}$$ $${28.38}$$ < $${29.11}$$ $${+0}$$ $${6.81}$$ < $${7.71}$$
dogstatsd_rpm_amd64 $${0}$$ $${29.86}$$ < $${30.53}$$ $${-0}$$ $${7.88}$$ < $${8.76}$$
dogstatsd_suse_amd64 $${0}$$ $${29.86}$$ < $${30.53}$$ $${-0}$$ $${7.88}$$ < $${8.76}$$
iot_agent_deb_amd64 $${+0}$$ $${42.6}$$ < $${43.19}$$ $${+0}$$ $${11.12}$$ < $${11.98}$$
iot_agent_deb_arm64 $${+0.01}$$ $${40.34}$$ < $${40.92}$$ $${-0}$$ $${9.58}$$ < $${10.45}$$
iot_agent_deb_armhf $${+0.01}$$ $${40.24}$$ < $${40.86}$$ $${+0}$$ $${9.7}$$ < $${10.56}$$
iot_agent_rpm_amd64 $${+0}$$ $${42.6}$$ < $${43.19}$$ $${-0}$$ $${11.14}$$ < $${12.0}$$
iot_agent_suse_amd64 $${+0}$$ $${42.6}$$ < $${43.19}$$ $${-0}$$ $${11.14}$$ < $${12.0}$$

@mrafi97
mrafi97 marked this pull request as ready for review December 4, 2025 15:54
@mrafi97
mrafi97 requested review from a team as code owners December 4, 2025 15:54
@mrafi97
mrafi97 requested review from nathan-b and s-alad December 4, 2025 15:54
@mrafi97 mrafi97 added the ask-review Ask in slack required teams to review this PR label Dec 4, 2025

@nathan-b nathan-b left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few comments; I don't know if any of them are blockers but PTAL to make sure :)

Comment thread pkg/collector/corechecks/system/battery/battery.go Outdated
Comment thread pkg/collector/corechecks/system/battery/battery_windows.go Outdated
Comment thread pkg/collector/corechecks/system/battery/battery_windows.go Outdated
@mrafi97
mrafi97 requested a review from julien-lebot December 4, 2025 20:16

@nathan-b nathan-b left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for working through the comments!

Comment thread pkg/collector/corechecks/system/battery/battery_windows.go
Comment thread pkg/util/winutil/setupapi.go
Comment thread pkg/collector/corechecks/system/battery/battery_windows.go Outdated
Comment thread pkg/collector/corechecks/system/battery/battery_windows.go Outdated
Comment thread pkg/collector/corechecks/system/battery/battery_windows.go
Comment thread pkg/collector/corechecks/system/battery/battery_windows.go Outdated
Comment thread pkg/collector/corechecks/system/battery/battery_windows.go Outdated
Comment thread pkg/util/winutil/setupapi.go Outdated
Comment thread pkg/util/winutil/setupapi.go Outdated
@mrafi97
mrafi97 requested a review from iglendd December 8, 2025 21:59
Comment thread pkg/collector/corechecks/system/battery/battery_windows.go
Comment thread pkg/collector/corechecks/system/battery/battery_windows.go Outdated
Comment thread pkg/collector/corechecks/system/battery/battery_windows.go Outdated
Comment thread pkg/collector/corechecks/system/battery/battery_windows.go Outdated
Comment thread pkg/collector/corechecks/system/battery/battery_windows.go Outdated
Comment thread pkg/collector/corechecks/system/battery/battery_windows.go Outdated
@mrafi97
mrafi97 requested a review from lrbhatia December 9, 2025 17:14
Comment thread pkg/collector/corechecks/system/battery/battery_windows.go Outdated
Comment thread pkg/collector/corechecks/system/battery/battery_windows.go Outdated
@mrafi97
mrafi97 requested a review from lrbhatia December 10, 2025 16:25
Comment thread pkg/collector/corechecks/system/battery/battery_windows.go Outdated
Comment thread pkg/collector/corechecks/system/battery/battery_windows.go
Comment thread pkg/collector/corechecks/system/battery/battery_windows.go
@mrafi97

mrafi97 commented Dec 12, 2025

Copy link
Copy Markdown
Contributor Author

/merge

@dd-devflow-routing-codex

dd-devflow-routing-codex Bot commented Dec 12, 2025

Copy link
Copy Markdown

View all feedbacks in Devflow UI.

2025-12-12 17:29:32 UTC ℹ️ Start processing command /merge


2025-12-12 17:29:37 UTC ℹ️ MergeQueue: pull request added to the queue

The expected merge time in main is approximately 43m (p90).


2025-12-12 17:56:28 UTC ℹ️ MergeQueue: This merge request was merged

@dd-mergequeue
dd-mergequeue Bot merged commit c0ad497 into main Dec 12, 2025
306 checks passed
@dd-mergequeue
dd-mergequeue Bot deleted the mrafi/battery-check branch December 12, 2025 17:56
@github-actions github-actions Bot added this to the 7.75.0 milestone Dec 12, 2025
dd-mergequeue Bot pushed a commit that referenced this pull request Dec 17, 2025
### What does this PR do?
This PR is a continuation of #43789 but this time to collect battery metrics on MacOS devices.

### Motivation
https://datadoghq.atlassian.net/browse/WINA-2068

### Describe how you validated your changes
- Standalone project on work mac laptop + unit tests
- Built the agent
```
dda inv agent.build --build-exclude=systemd
cp /Users/brian.tu/go/src/github.com/DataDog/datadog-agent/bin/agent/dist/conf.d/battery.d/conf.yaml.example /Users/brian.tu/go/src/github.com/DataDog/datadog-agent/bin/agent/dist/conf.d/battery.d/conf.yaml
./bin/agent/agent check battery
```

### Additional Notes


Co-authored-by: mrafi97 <[email protected]>
Co-authored-by: brian.tu <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ask-review Ask in slack required teams to review this PR long review PR is complex, plan time to review it qa/done QA done before merge and regressions are covered by tests team/agent-runtimes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants