NDM Agent Workload Balancing: gate check execution on group membership - #55064
NDM Agent Workload Balancing: gate check execution on group membership#55064matthewleese wants to merge 2 commits into
Conversation
Add Check.WorkloadBalancingGroupID() to the check interface and thread a workloadbalancing.Component dependency through collector -> runner -> worker so a check assigned to a workload balancing group only runs when that group is active on the local agent. Checks with no group keep the existing HA-leader gating behavior unchanged. Add the SNMP instance-level agent_workload_balancing_group field, including the Copy() fix so subnet-discovery devices derived via CopyWithNewIP retain their group assignment instead of silently losing it. Co-Authored-By: Claude Sonnet 5 <[email protected]>
Go Package Import DifferencesBaseline: 7c903c9
|
|
🎯 Code Coverage (details) 🔗 Commit SHA: 4a70f16 | Docs | View more details | Give us feedback! |
Files inventory check summaryFile checks results against ancestor 7c903c92: Results for datadog-agent_7.84.0~devel.git.245.4a70f16.pipeline.131706469-1_amd64.deb:No change detected Results for datadog-iot-agent_7.84.0~devel.git.245.4a70f16.pipeline.131706469-1_amd64.deb:No change detected |
Regression DetectorRegression Detector ResultsMetrics dashboard Baseline: 7c903c9 Optimization Goals: ✅ No significant changes detected
|
| perf | experiment | goal | Δ mean % | Δ mean % CI | trials | links |
|---|---|---|---|---|---|---|
| ➖ | quality_gate_metrics_logs | memory utilization | +0.72 | [+0.47, +0.97] | 1 | Logs bounds checks dashboard |
| ➖ | quality_gate_idle_all_features | memory utilization | +0.45 | [+0.41, +0.49] | 1 | Logs bounds checks dashboard |
| ➖ | quality_gate_security_idle | memory utilization | +0.25 | [+0.14, +0.35] | 1 | Logs bounds checks dashboard |
| ➖ | quality_gate_security_no_fs_load | memory utilization | +0.21 | [+0.06, +0.35] | 1 | Logs bounds checks dashboard |
| ➖ | quality_gate_security_mean_fs_load | memory utilization | +0.09 | [+0.02, +0.17] | 1 | Logs bounds checks dashboard |
| ➖ | quality_gate_idle | memory utilization | -0.37 | [-0.49, -0.26] | 1 | Logs bounds checks dashboard |
| ➖ | quality_gate_private_action_runner | memory utilization | -0.42 | [-0.54, -0.30] | 1 | Logs bounds checks dashboard |
| ➖ | quality_gate_logs | % cpu utilization | -1.12 | [-2.01, -0.23] | 1 | Logs bounds checks dashboard |
Bounds Checks: ✅ Passed
| perf | experiment | bounds_check_name | replicates_passed | observed_value | links |
|---|---|---|---|---|---|
| ✅ | quality_gate_idle | intake_connections | 10/10 | 4 = 4 | bounds checks dashboard |
| ✅ | quality_gate_idle | memory_usage | 10/10 | 173.27MiB ≤ 178MiB | bounds checks dashboard |
| ✅ | quality_gate_idle | total_bytes_received | 10/10 | 741.47KiB ≤ 819.20KiB | bounds checks dashboard |
| ✅ | quality_gate_idle_all_features | intake_connections | 10/10 | 4 = 4 | bounds checks dashboard |
| ✅ | quality_gate_idle_all_features | memory_usage | 10/10 | 512.29MiB ≤ 538MiB | bounds checks dashboard |
| ✅ | quality_gate_idle_all_features | total_bytes_received | 10/10 | 1.13MiB ≤ 1.25MiB | bounds checks dashboard |
| ✅ | quality_gate_logs | intake_connections | 10/10 | 16 ≤ 40 | bounds checks dashboard |
| ✅ | quality_gate_logs | memory_usage | 10/10 | 203.39MiB ≤ 229MiB | bounds checks dashboard |
| ✅ | quality_gate_logs | missed_bytes | 10/10 | 0B = 0B | bounds checks dashboard |
| ✅ | quality_gate_logs | total_bytes_received | 10/10 | 264.15MiB ≤ 292MiB | bounds checks dashboard |
| ✅ | quality_gate_metrics_logs | cpu_usage | 10/10 | 363.05 ≤ 2000 | bounds checks dashboard |
| ✅ | quality_gate_metrics_logs | intake_connections | 10/10 | 16 ≤ 40 | bounds checks dashboard |
| ✅ | quality_gate_metrics_logs | memory_usage | 10/10 | 394.08MiB ≤ 439MiB | bounds checks dashboard |
| ✅ | quality_gate_metrics_logs | missed_bytes | 10/10 | 0B = 0B | bounds checks dashboard |
| ✅ | quality_gate_metrics_logs | total_bytes_received | 10/10 | 0.94GiB ≤ 1.04GiB | bounds checks dashboard |
| ✅ | quality_gate_private_action_runner | memory_usage | 10/10 | 71.94MiB ≤ 76MiB | bounds checks dashboard |
| ✅ | quality_gate_security_idle | cpu_usage | 10/10 | 27.37 ≤ 100 | bounds checks dashboard |
| ✅ | quality_gate_security_idle | memory_usage | 10/10 | 329.37MiB ≤ 335MiB | bounds checks dashboard |
| ✅ | quality_gate_security_mean_fs_load | cpu_usage | 10/10 | 61.22 ≤ 200 | bounds checks dashboard |
| ✅ | quality_gate_security_mean_fs_load | memory_usage | 10/10 | 302.78MiB ≤ 314MiB | bounds checks dashboard |
| ✅ | quality_gate_security_no_fs_load | cpu_usage | 10/10 | 24.30 ≤ 100 | bounds checks dashboard |
| ✅ | quality_gate_security_no_fs_load | memory_usage | 10/10 | 309.78MiB ≤ 343MiB | 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:
-
Its estimated |Δ mean %| ≥ 5.00%, indicating the change is big enough to merit a closer look.
-
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.
-
Its configuration does not mark it "erratic".
CI Pass/Fail Decision
✅ Passed. All Quality Gates passed.
- quality_gate_metrics_logs, bounds check total_bytes_received: 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 missed_bytes: 10/10 replicas passed. Gate passed.
- quality_gate_security_mean_fs_load, bounds check cpu_usage: 10/10 replicas passed. Gate passed.
- quality_gate_security_mean_fs_load, bounds check memory_usage: 10/10 replicas passed. Gate passed.
- quality_gate_idle, bounds check memory_usage: 10/10 replicas passed. Gate passed.
- quality_gate_idle, bounds check intake_connections: 10/10 replicas passed. Gate passed.
- quality_gate_idle, bounds check total_bytes_received: 10/10 replicas passed. Gate passed.
- quality_gate_security_idle, bounds check cpu_usage: 10/10 replicas passed. Gate passed.
- quality_gate_security_idle, bounds check memory_usage: 10/10 replicas passed. Gate passed.
- quality_gate_private_action_runner, bounds check memory_usage: 10/10 replicas passed. Gate passed.
- quality_gate_security_no_fs_load, bounds check cpu_usage: 10/10 replicas passed. Gate passed.
- quality_gate_security_no_fs_load, bounds check memory_usage: 10/10 replicas passed. Gate passed.
- quality_gate_logs, bounds check intake_connections: 10/10 replicas passed. Gate passed.
- quality_gate_logs, bounds check missed_bytes: 10/10 replicas passed. Gate passed.
- quality_gate_logs, bounds check total_bytes_received: 10/10 replicas passed. Gate passed.
- quality_gate_logs, bounds check memory_usage: 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: 10/10 replicas passed. Gate passed.
- quality_gate_idle_all_features, bounds check total_bytes_received: 10/10 replicas passed. Gate passed.
Static quality checks✅ Please find below the results from static quality gates Successful checksInfo
8 successful checks with minimal change (< 2 KiB)
|
bazel:run-gazelle and every lint_* CI job failed because the new comp/workloadbalancing dep wasn't reflected in BUILD.bazel for the collector, runner, and worker packages. Ran bazel run //:gazelle to regenerate. Co-Authored-By: Claude Sonnet 5 <[email protected]>
Third PR in the NDM Agent Workload Balancing sequence (after #54853 and #54993). Stacked on the
comp/workloadbalancingcomponent skeleton from #54993.What this does
WorkloadBalancingGroupID() stringto theCheckinterface and implements it across every implementer:CheckBase(default""),StubCheck,stats.StatsCheck,PythonCheck, the sharedlibraryCheck,APMCheck,ProcessAgentCheck, andmiddleware.CheckWrapper.agent_workload_balancing_groupfield, including theCopy()fix so devices derived viaCopyWithNewIPin subnet-discovery mode retain their group assignment instead of silently losing it.pkg/collector/worker/worker.go: a check with a non-empty workload balancing group runs only ifworkloadBalancing.IsGroupActive(group); a check with no group keeps the existing HA-leader gating behavior unchanged.workloadbalancing.Componentdependency throughcollector.go->runner.go->worker.go, mirroring the existinghaAgentwiring.Testing
TestWorker_WorkloadBalancingGatinginworker_test.go: group active runs, group inactive skips, no group is unaffected by workload balancing gating.agent_workload_balancing_groupYAML parsing,Copy(), and a discovery-mode case assertingCopyWithNewIPretains the group.go build/go vet/go testunder default,-tags test, and-tags pythonfor every touched package. The-tags pythonpass matters here sincePythonCheckimplementsCheckindependently and a missed method there is exactly what caused a P1 build break on an earlier related PR (feat(ndm): emit a metric per workload balancing group #54656).Deviation from the implementation plan
The plan called for documenting
agent_workload_balancing_groupinpkg/config/schema/yaml/core_schema.yaml, "alongside wherever SNMP's other instance-level keys are documented." I checked and that file only coversdatadog.yaml-level agent config; none of SNMP's existing instance-level keys (community_string,ip_address, etc.) appear there. There's no per-integration-instance schema doc location in this repo to add this field to, so I did not add an entry.