-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Remove GetLastError usage in Windows code #44708
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
base: main
Are you sure you want to change the base?
Conversation
iglendd
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.
Again, OMG, it looks like it fixed 10 subtle bugs.
Static quality checks✅ Please find below the results from static quality gates Successful checksInfo
|
Regression DetectorRegression Detector ResultsMetrics dashboard Baseline: dae02eb Optimization Goals: ✅ No significant changes detected
|
| perf | experiment | goal | Δ mean % | Δ mean % CI | trials | links |
|---|---|---|---|---|---|---|
| ➖ | docker_containers_cpu | % cpu utilization | +0.27 | [-2.75, +3.29] | 1 | Logs |
Fine details of change detection per experiment
| perf | experiment | goal | Δ mean % | Δ mean % CI | trials | links |
|---|---|---|---|---|---|---|
| ➖ | ddot_metrics | memory utilization | +0.47 | [+0.24, +0.70] | 1 | Logs |
| ➖ | docker_containers_memory | memory utilization | +0.29 | [+0.22, +0.36] | 1 | Logs |
| ➖ | docker_containers_cpu | % cpu utilization | +0.27 | [-2.75, +3.29] | 1 | Logs |
| ➖ | ddot_metrics_sum_cumulativetodelta_exporter | memory utilization | +0.23 | [-0.00, +0.45] | 1 | Logs |
| ➖ | quality_gate_idle | memory utilization | +0.23 | [+0.18, +0.27] | 1 | Logs bounds checks dashboard |
| ➖ | otlp_ingest_metrics | memory utilization | +0.19 | [+0.04, +0.35] | 1 | Logs |
| ➖ | otlp_ingest_logs | memory utilization | +0.19 | [+0.10, +0.28] | 1 | Logs |
| ➖ | uds_dogstatsd_20mb_12k_contexts_20_senders | memory utilization | +0.15 | [+0.09, +0.20] | 1 | Logs |
| ➖ | file_to_blackhole_0ms_latency | egress throughput | +0.10 | [-0.30, +0.49] | 1 | Logs |
| ➖ | file_to_blackhole_100ms_latency | egress throughput | +0.04 | [-0.01, +0.08] | 1 | Logs |
| ➖ | file_tree | memory utilization | +0.02 | [-0.03, +0.08] | 1 | Logs |
| ➖ | uds_dogstatsd_to_api_v3 | ingress throughput | +0.01 | [-0.14, +0.15] | 1 | Logs |
| ➖ | tcp_dd_logs_filter_exclude | ingress throughput | -0.01 | [-0.08, +0.07] | 1 | Logs |
| ➖ | file_to_blackhole_1000ms_latency | egress throughput | -0.01 | [-0.43, +0.41] | 1 | Logs |
| ➖ | uds_dogstatsd_to_api | ingress throughput | -0.01 | [-0.14, +0.11] | 1 | Logs |
| ➖ | file_to_blackhole_500ms_latency | egress throughput | -0.01 | [-0.39, +0.36] | 1 | Logs |
| ➖ | quality_gate_idle_all_features | memory utilization | -0.06 | [-0.10, -0.02] | 1 | Logs bounds checks dashboard |
| ➖ | ddot_metrics_sum_delta | memory utilization | -0.09 | [-0.31, +0.12] | 1 | Logs |
| ➖ | ddot_logs | memory utilization | -0.18 | [-0.25, -0.11] | 1 | Logs |
| ➖ | ddot_metrics_sum_cumulative | memory utilization | -0.52 | [-0.68, -0.36] | 1 | Logs |
| ➖ | quality_gate_metrics_logs | memory utilization | -1.43 | [-1.63, -1.22] | 1 | Logs bounds checks dashboard |
| ➖ | tcp_syslog_to_blackhole | ingress throughput | -1.59 | [-1.69, -1.50] | 1 | Logs |
| ➖ | quality_gate_logs | % cpu utilization | -1.78 | [-3.26, -0.30] | 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_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, 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_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_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_metrics_logs, bounds check memory_usage: 10/10 replicas passed. Gate passed.
chouetz
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.
Small suggestion
.golangci.yml
Outdated
| - name: duplicated-imports | ||
| forbidigo: | ||
| forbid: | ||
| - pattern: ^.*\.GetLastError()$ |
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.
Nit, I don't know how far there is a risk for trailing characters, maybe in a return with 2 outputs?
| - pattern: ^.*\.GetLastError()$ | |
| - pattern: ^.*\.GetLastError().*$ |
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 catch! looks like either way works fine
pkg\util\winutil\getlasterror_test.go:47:9: use of `windows.GetLastError` forbidden because "GetLastError always returns nil in Go because the syscall implementation resets the last error before calling the DLL function (see https://github.com/golang/go/issues/41220). Use the error returned directly from the syscall (third return value) instead." (forbidigo)
return windows.GetLastError(), nil
^
pkg\util\winutil\getlasterror_test.go:51:17: use of `windows.GetLastError` forbidden because "GetLastError always returns nil in Go because the syscall implementation resets the last error before calling the DLL function (see https://github.com/golang/go/issues/41220). Use the error returned directly from the syscall (third return value) instead." (forbidigo)
return []error{windows.GetLastError(), nil}
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.
I'm not sure how this is working because it is technically incorrect.
>>> import re
>>> examples = [
... "return windows.GetLastError(), nil",
... "return []error{windows.GetLastError(), nil}",
... ]
>>> def test(pattern):
... for example in examples:
... print(re.search(pattern, example))
...
>>> test(r"^.*\.GetLastError()$")
None
None
>>> test(r"^.*\.GetLastError().*$")
<re.Match object; span=(0, 34), match='return windows.GetLastError(), nil'>
<re.Match object; span=(0, 43), match='return []error{windows.GetLastError(), nil}'>Also, since parentheses are special characters in regular expressions I think we should escape them as we do for the . character.
| - pattern: ^.*\.GetLastError()$ | |
| - pattern: ^.*\.GetLastError\(\).*$ |
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.
it's not clear to me from the docs what forbidgo matches against, but based on the output "use of windows.GetLastError forbidden" and that forbigdo uses ast.Node, not source lines, I imagine it's matching against the windows.GetLastError identifier/token (without the parentheses).
I think it works as is b/c the parentheses are treated as a match group as you say. forbidgo does not find any matches after escaping the parentheses. regardless of the .* at the end.
I'll remove the parentheses, but without them I don't think we should include the trailing .*, because then it wouldn't be an exact match anymore.
What does this PR do?
This PR removes the incorrect usage of
windows.GetLastError()in Go code. As documented in golang/go#41220,GetLastError()always returns nil in Go because the syscall implementation resets the last error before calling the DLL function.Changes:
GetLastError().Call())comp/etw/implandpkg/util/winutil/winmemto properly capture and return Windows error codesMotivation
https://datadoghq.atlassian.net/browse/WINA-2127
GetLastError()is fundamentally broken in Go and should never be used. This PR ensures we don't use it and properly capture Windows errors.Testing
system.paging.*metrics still show and have path tagcomp/etwhas coverage through security-agent integration/e2e tests