-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Replace custom golangci-lint build with depguard rule
#45521
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.
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
Replace custom golangci-lint build with depguard rule
#45521
Conversation
629de78 to
a4cd9d5
Compare
golangci-lint build with depguard rulegolangci-lint build with depguard rule
pgimalac
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice !
Static quality checks✅ Please find below the results from static quality gates 31 successful checks with minimal change (< 2 KiB)
On-wire sizes (compressed)
|
Regression DetectorRegression Detector ResultsMetrics dashboard Baseline: 8766844 Optimization Goals: ✅ No significant changes detected
|
| perf | experiment | goal | Δ mean % | Δ mean % CI | trials | links |
|---|---|---|---|---|---|---|
| ➖ | docker_containers_cpu | % cpu utilization | +1.64 | [-1.47, +4.75] | 1 | Logs |
Fine details of change detection per experiment
| perf | experiment | goal | Δ mean % | Δ mean % CI | trials | links |
|---|---|---|---|---|---|---|
| ➖ | tcp_syslog_to_blackhole | ingress throughput | +2.21 | [+2.12, +2.30] | 1 | Logs |
| ➖ | docker_containers_cpu | % cpu utilization | +1.64 | [-1.47, +4.75] | 1 | Logs |
| ➖ | quality_gate_metrics_logs | memory utilization | +1.47 | [+1.24, +1.70] | 1 | Logs bounds checks dashboard |
| ➖ | uds_dogstatsd_20mb_12k_contexts_20_senders | memory utilization | +0.41 | [+0.35, +0.46] | 1 | Logs |
| ➖ | file_tree | memory utilization | +0.28 | [+0.23, +0.33] | 1 | Logs |
| ➖ | ddot_metrics_sum_delta | memory utilization | +0.25 | [+0.05, +0.44] | 1 | Logs |
| ➖ | file_to_blackhole_1000ms_latency | egress throughput | +0.06 | [-0.37, +0.48] | 1 | Logs |
| ➖ | file_to_blackhole_0ms_latency | egress throughput | +0.03 | [-0.45, +0.51] | 1 | Logs |
| ➖ | file_to_blackhole_100ms_latency | egress throughput | +0.01 | [-0.04, +0.06] | 1 | Logs |
| ➖ | uds_dogstatsd_to_api_v3 | ingress throughput | +0.01 | [-0.11, +0.13] | 1 | Logs |
| ➖ | tcp_dd_logs_filter_exclude | ingress throughput | +0.01 | [-0.09, +0.10] | 1 | Logs |
| ➖ | uds_dogstatsd_to_api | ingress throughput | -0.00 | [-0.13, +0.13] | 1 | Logs |
| ➖ | otlp_ingest_metrics | memory utilization | -0.02 | [-0.17, +0.13] | 1 | Logs |
| ➖ | quality_gate_idle | memory utilization | -0.05 | [-0.10, +0.00] | 1 | Logs bounds checks dashboard |
| ➖ | docker_containers_memory | memory utilization | -0.05 | [-0.12, +0.03] | 1 | Logs |
| ➖ | ddot_logs | memory utilization | -0.06 | [-0.12, -0.01] | 1 | Logs |
| ➖ | ddot_metrics_sum_cumulativetodelta_exporter | memory utilization | -0.12 | [-0.35, +0.11] | 1 | Logs |
| ➖ | ddot_metrics | memory utilization | -0.14 | [-0.35, +0.08] | 1 | Logs |
| ➖ | file_to_blackhole_500ms_latency | egress throughput | -0.14 | [-0.52, +0.24] | 1 | Logs |
| ➖ | ddot_metrics_sum_cumulative | memory utilization | -0.19 | [-0.35, -0.03] | 1 | Logs |
| ➖ | otlp_ingest_logs | memory utilization | -0.21 | [-0.31, -0.11] | 1 | Logs |
| ➖ | quality_gate_idle_all_features | memory utilization | -0.41 | [-0.44, -0.37] | 1 | Logs bounds checks dashboard |
| ➖ | quality_gate_logs | % cpu utilization | -0.41 | [-1.89, +1.07] | 1 | Logs bounds checks dashboard |
Bounds Checks: ✅ Passed
| 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 | 10/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:
-
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 memory_usage: 10/10 replicas passed. Gate passed.
- quality_gate_metrics_logs, bounds check lost_bytes: 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_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_logs, 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 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.
a4cd9d5 to
e6a5303
Compare
e6a5303 to
23b40b6
Compare
### What does this PR do? Migrate the custom `pkgconfigusage` plugin for `golangci-lint` to an equivalent `depguard` rule, eliminating the need for rebuilding `golangci-lint` from downloaded sources. Changes: - migration of `pkgconfigusage` itself, from a `golangci-lint` plugin (see #28382 & #39367) to a rule for the depguard (v2) plugin, while preserving its name for traceability, - move file exclusions to that rule configuration, while removing those that no longer exist or are no longer violating the rule: - `comp/aggregator/demultiplexer/demultiplexerimpl/test_agent_demultiplexer.go`, - `comp/core/agenttelemetry/impl/config.go`, - `comp/core/config/config_mock.go`, - `comp/core/workloadfilter/def/utils.go`, - `comp/core/workloadmeta/collectors/internal/process/process_collector.go`, - `comp/core/workloadmeta/collectors/util/process_util_linux.go`, - `comp/dogstatsd/listeners/udp.go`, - `comp/remote-config/rcservice/rcserviceimpl/rcservice.go`, - `comp/remote-config/rcservicemrf/rcservicemrfimpl/rcservicemrf.go`, - update `pkgconfigusage_test` to validate the effectiveness of the rule configuration defined in `.golangci.yml`, - remove custom `golangci-lint` build infrastructure. ### Motivation This change kills several birds with one stone: 1. preparation step for the Go build migration to Bazel: while looking for an isolated component with minimal dependencies to introduce the first Go toolchain as part of the ongoing Bazel migration, the custom `golangci-lint` build initially seemed to be a good candidate, but it turns out we can spare time by removing the said build at all, 2. standardization: the `golangci-lint` v2 upgrade in #43501 introduced `depguard` v2 support with file-based import restrictions using `glob` patterns, enabling the same architectural enforcement without a custom plugin, 3. reliability: the custom plugin build process obviously takes time and occasionally failed in CI and locally with: ``` Error: build process: clone golangci-lint: git clone --branch v2.7.0 --single-branch --depth 1 -c advice.detachedHead=false -q https://github.com/golangci/golangci-lint.git: exit status 128 ``` (https://gitlab.ddbuild.io/DataDog/datadog-agent/-/jobs/1369979128#L98) ### Describe how you validated your changes `pkgconfigusage_test` validates the actual rule configuration defined in `.golangci.yml` by parsing it and running the `depguard` analyzer based on the existing `analysistest.Run()` tool with `// want` comments in the test go file. ### Additional Notes Build isolation from #43773 is preserved in the test to prevent macOS CI timeouts caused by concurrent `go build` operations (golang/go#59657).
23b40b6 to
4978078
Compare
Ishirui
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Woot !
|
/merge |
|
View all feedbacks in Devflow UI.
The expected merge time in
|
What does this PR do?
Migrate the custom
pkgconfigusageplugin forgolangci-lintto an equivalentdepguardrule, eliminating the need for rebuildinggolangci-lintfrom downloaded sources.Changes:
pkgconfigusageitself, from agolangci-lintplugin ([ASCII-2155] add custom go linter to check usage of pkgconfig inside component folder #28382, [AGENTRUN-600] update pkgconfigusage linter to use pkg/config/setup package #39367) to a rule for the depguard (v2) plugin, while preserving its name for traceability,comp/aggregator/demultiplexer/demultiplexerimpl/test_agent_demultiplexer.go,comp/core/agenttelemetry/impl/config.go,comp/core/config/config_mock.go,comp/core/workloadfilter/def/utils.go,comp/core/workloadmeta/collectors/internal/process/process_collector.go,comp/core/workloadmeta/collectors/util/process_util_linux.go,comp/dogstatsd/listeners/udp.go,comp/remote-config/rcservice/rcserviceimpl/rcservice.go,comp/remote-config/rcservicemrf/rcservicemrfimpl/rcservicemrf.go,// nolint:pkgconfigusageto file exclusions:comp/core/config/params.go,comp/core/workloadfilter/baseimpl/filter_utils.go,comp/core/workloadfilter/catalog/filter_config.go,updatepkgconfigusage_testto validate the effectiveness of the rule configuration defined in.golangci.yml,golangci-lintbuild infrastructure.Motivation
This change kills several birds with one stone:
golangci-lintbuild initially seemed to be a good candidate, but it turns out we can spare time by removing the said build at all,golangci-lintv2 upgrade (Upgrade golangci-lint from v1.60.3 to v2.6.2 #43501) introduceddepguardv2 support with file-based import restrictions usingglobpatterns, enabling the same architectural enforcement without a custom plugin,Describe how you validated your changes
First commit had
pkgconfigusage_testvalidating the actual rule configuration defined in.golangci.ymlby parsing it and running thedepguardanalyzer based on the existinganalysistest.Run()tool with// wantcomments in sample files:datadog-agent/pkg/linters/testdata/src/comp/a.go
Line 9 in ed57377
The second commit removed this test as per review comments. It however remains possible to verify the
pkgconfigusagerule works as expected by simply removing a file from the exclusions and the linter will spot it.