[ABLD-471] Map external datadog-agent imports with gazelle:resolve_regexp - #54737
Conversation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 3cd460e7ba
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
Files inventory check summaryFile checks results against ancestor c87f5dc1: Results for datadog-agent_7.84.0~devel.git.118.f1b6435.pipeline.130387537-1_amd64.deb:No change detected Results for datadog-iot-agent_7.84.0~devel.git.118.f1b6435.pipeline.130387537-1_amd64.deb:No change detected |
Static quality checks✅ Please find below the results from static quality gates 33 successful checks with minimal change (< 2 KiB)
|
Regression DetectorRegression Detector ResultsMetrics dashboard Baseline: d547014 Optimization Goals: ✅ No significant changes detected
|
| perf | experiment | goal | Δ mean % | Δ mean % CI | trials | links |
|---|---|---|---|---|---|---|
| ➖ | quality_gate_logs | % cpu utilization | +2.74 | [+1.85, +3.62] | 1 | Logs bounds checks dashboard |
| ➖ | quality_gate_metrics_logs | memory utilization | +0.62 | [+0.38, +0.87] | 1 | Logs bounds checks dashboard |
| ➖ | quality_gate_security_idle | memory utilization | +0.58 | [+0.47, +0.69] | 1 | Logs bounds checks dashboard |
| ➖ | quality_gate_private_action_runner | memory utilization | +0.27 | [+0.15, +0.39] | 1 | Logs bounds checks dashboard |
| ➖ | quality_gate_security_mean_fs_load | memory utilization | +0.18 | [+0.11, +0.25] | 1 | Logs bounds checks dashboard |
| ➖ | quality_gate_idle | memory utilization | +0.06 | [-0.07, +0.18] | 1 | Logs bounds checks dashboard |
| ➖ | quality_gate_idle_all_features | memory utilization | -0.23 | [-0.27, -0.19] | 1 | Logs bounds checks dashboard |
| ➖ | quality_gate_security_no_fs_load | memory utilization | -0.29 | [-0.43, -0.14] | 1 | Logs bounds checks dashboard |
Bounds Checks: ❌ Failed
| 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 | 0/10 | 171.01MiB > 154MiB | bounds checks dashboard |
| ✅ | quality_gate_idle | total_bytes_received | 10/10 | 729.23KiB ≤ 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 | 9/10 | 518.12MiB > 512MiB | bounds checks dashboard |
| ✅ | quality_gate_idle_all_features | total_bytes_received | 10/10 | 1.12MiB ≤ 1.25MiB | bounds checks dashboard |
| ✅ | quality_gate_logs | intake_connections | 10/10 | 16 ≤ 40 | bounds checks dashboard |
| ❌ | quality_gate_logs | memory_usage | 1/10 | 201.17MiB > 195MiB | bounds checks dashboard |
| ✅ | quality_gate_logs | missed_bytes | 10/10 | 0B = 0B | bounds checks dashboard |
| ✅ | quality_gate_logs | total_bytes_received | 10/10 | 264.35MiB ≤ 292MiB | bounds checks dashboard |
| ✅ | quality_gate_metrics_logs | cpu_usage | 10/10 | 364.54 ≤ 2000 | bounds checks dashboard |
| ✅ | quality_gate_metrics_logs | intake_connections | 10/10 | 18 ≤ 40 | bounds checks dashboard |
| ✅ | quality_gate_metrics_logs | memory_usage | 10/10 | 390.92MiB ≤ 430MiB | 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.92MiB ≤ 75MiB | bounds checks dashboard |
| ✅ | quality_gate_security_idle | cpu_usage | 10/10 | 26.86 ≤ 100 | bounds checks dashboard |
| ✅ | quality_gate_security_idle | memory_usage | 10/10 | 326.77MiB ≤ 330MiB | bounds checks dashboard |
| ✅ | quality_gate_security_mean_fs_load | cpu_usage | 10/10 | 62.47 ≤ 200 | bounds checks dashboard |
| ✅ | quality_gate_security_mean_fs_load | memory_usage | 10/10 | 303.07MiB ≤ 310MiB | bounds checks dashboard |
| ✅ | quality_gate_security_no_fs_load | cpu_usage | 10/10 | 24.86 ≤ 100 | bounds checks dashboard |
| ✅ | quality_gate_security_no_fs_load | memory_usage | 10/10 | 309.25MiB ≤ 320MiB | 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".
Replicate Execution Details
We run multiple replicates for each experiment/variant. However, we allow replicates to be automatically retried if there are any failures, up to 8 times, at which point the replicate is marked dead and we are unable to run analysis for the entire experiment. We call each of these attempts at running replicates a replicate execution. This section lists all replicate executions that failed due to the target crashing or being oom killed.
Note: In the below tables we bucket failures by experiment, variant, and failure type. For each of these buckets we list out the replicate indexes that failed with an annotation signifying how many times said replicate failed with the given failure mode. In the below example the baseline variant of the experiment named experiment_with_failures had two replicates that failed by oom kills. Replicate 0, which failed 8 executions, and replicate 1 which failed 6 executions, all with the same failure mode.
| Experiment | Variant | Replicates | Failure | Logs | Debug Dashboard |
|---|---|---|---|---|---|
| experiment_with_failures | baseline | 0 (x8) 1 (x6) | Oom killed | Debug Dashboard |
The debug dashboard links will take you to a debugging dashboard specifically designed to investigate replicate execution failures.
❌ Retried Profiling Replicate Execution Failures (ddprof)
Note: Profiling replicas may still be executing. See the debug dashboard for up to date status.
| Experiment | Variant | Replicates | Failure | Debug Dashboard |
|---|---|---|---|---|
| quality_gate_idle | comparison | 10 | Oom killed | Debug Dashboard |
| quality_gate_metrics_logs | baseline | 10 | Oom killed | Debug Dashboard |
| quality_gate_security_no_fs_load | baseline | 10 | Crashed (exit code: 134) | Debug Dashboard |
CI Pass/Fail Decision
❌ Failed. Some Quality Gates were violated.
- quality_gate_security_mean_fs_load, bounds check memory_usage: 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_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_logs, bounds check total_bytes_received: 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 memory_usage: 1/10 replicas passed. Failed 9 which is > 0. Gate FAILED.
- quality_gate_security_no_fs_load, 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_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_idle, bounds check memory_usage: 0/10 replicas passed. Failed 10 which is > 0. Gate FAILED.
- quality_gate_idle_all_features, bounds check total_bytes_received: 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.
- quality_gate_idle_all_features, bounds check intake_connections: 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 memory_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_metrics_logs, bounds check total_bytes_received: 10/10 replicas passed. Gate passed.
3cd460e to
290af3b
Compare
gazelle:resolve_regexp directivegazelle:resolve_regexp directives
gazelle:resolve_regexp directivesdatadog-agent imports through gazelle:resolve_regexp
…_regexp` ### What does this PR do? Replace the 39 individual `gazelle:resolve` lines in `deps/go.MODULE.bazel` with two `gazelle:resolve_regexp` directives: one general rule, and one covering its one naming exception. Together they cover every current and future datadog-agent submodule import from external Go modules. ### Motivation [ABLD-471](https://datadoghq.atlassian.net/browse/ABLD-471): external modules that import a `datadog-agent` submodule end up depending on two copies of the same Go package: - our in-tree `//<path>` target, - a `go_deps`-generated external repo. The Go linker rightfully rejects the duplicate. This happens because `go_deps.gazelle_default_attributes` directives run inside each external module's own, **separate Gazelle invocation**, which never sees our root `BUILD.bazel`'s `prefix = "github.com/DataDog/datadog-agent"`: that prefix only scopes our own `//:gazelle` invocation. Each occurrence had its own `gazelle:resolve` line redirecting the import to the in-tree target, growing by one entry every time a new external importer surfaced. This is exactly the repetition bazel-contrib/bazel-gazelle#817 introduced `resolve_regexp` to avoid. Every entry follows one of two shapes, though: 1. in the general case, the target name is just the last path segment, so Bazel's `//x/y/z` == `//x/y/z:z` shorthand covers it, 2. but, when a package's own directory is a bare major-version suffix, Gazelle then names the `go_library` after the parent directory instead, e.g. `.../installers/v2` gets target `:installers`, not `:v2`. As for any Gazelle override, last encountered matching definition wins: the general case is therefore defined first, and the more specific version-suffix case next. ### Describe how you validated your changes A full `bazel build //...` passes with no `datadog-agent`-related or Gazelle resolution failures, matching the 39 explicit entries this replaces, for both the common and the version-suffix case. ### Additional Notes `gazelle:resolve_regexp` parses its label template as a `label.Label` before substituting capture groups, so the template must already contain a literal `//`.
datadog-agent imports through gazelle:resolve_regexpdatadog-agent imports with gazelle:resolve_regexp
290af3b to
f1b6435
Compare
What does this PR do?
Replace the ~40 individual
gazelle:resolvelines indeps/go.MODULE.bazelwith 2gazelle:resolve_regexpdirectives:Together they cover every current and future datadog-agent submodule import from external Go modules.
Motivation
ABLD-471: external modules that import a
datadog-agentsubmodule end up depending on two copies of the same Go package://<path>target,go_deps-generated external repo.The Go linker rightfully rejects the duplicate.
This is by design:
go_depsGazelle directives run inside each external module's own, separate Gazelle invocation, which never sees the main repository: directives in the rootBUILD.bazel(prefix,resolve, etc.) only scope our own//:gazelleinvocation.Each occurrence had its own
gazelle:resolveline redirecting the import to the in-tree target, growing by one entry every time a new external importer surfaced.This is the kind of repetition bazel-contrib/bazel-gazelle#1542 introduced
resolve_regexpto avoid.Every entry follows one of two shapes, though:
//x/y/z==//x/y/z:zshorthand covers it,go_libraryafter the parent directory instead, e.g..../installers/v2gets target:installers, not:v2.Describe how you validated your changes
A full
bazel build //...passes with nodatadog-agent-related or Gazelle resolution failures.Additional Notes
As for any Gazelle override, last encountered matching definition wins: the general case is therefore defined first, and the more specific version-suffix case next.