-
Notifications
You must be signed in to change notification settings - Fork 1.4k
sd-agent: bazel: use Cargo for crates versions #45318
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
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: 5ef7a94 ❌ Experiments with retried target crashesThis is a critical error. One or more replicates failed with a non-zero exit code. These replicates may have been retried. See Replicate Execution Details for more information.
Optimization Goals: ✅ No significant changes detected
|
| perf | experiment | goal | Δ mean % | Δ mean % CI | trials | links |
|---|---|---|---|---|---|---|
| ➖ | docker_containers_cpu | % cpu utilization | +0.44 | [-2.46, +3.35] | 1 | Logs |
Fine details of change detection per experiment
| perf | experiment | goal | Δ mean % | Δ mean % CI | trials | links |
|---|---|---|---|---|---|---|
| ➖ | quality_gate_logs | % cpu utilization | +1.71 | [+0.24, +3.18] | 1 | Logs bounds checks dashboard |
| ➖ | quality_gate_metrics_logs | memory utilization | +0.70 | [+0.48, +0.91] | 1 | Logs bounds checks dashboard |
| ➖ | otlp_ingest_logs | memory utilization | +0.59 | [+0.49, +0.69] | 1 | Logs |
| ➖ | ddot_logs | memory utilization | +0.54 | [+0.47, +0.61] | 1 | Logs |
| ➖ | docker_containers_cpu | % cpu utilization | +0.44 | [-2.46, +3.35] | 1 | Logs |
| ➖ | file_tree | memory utilization | +0.30 | [+0.25, +0.36] | 1 | Logs |
| ➖ | quality_gate_idle_all_features | memory utilization | +0.10 | [+0.06, +0.14] | 1 | Logs bounds checks dashboard |
| ➖ | file_to_blackhole_0ms_latency | egress throughput | +0.05 | [-0.47, +0.57] | 1 | Logs |
| ➖ | uds_dogstatsd_to_api_v3 | ingress throughput | +0.01 | [-0.11, +0.14] | 1 | Logs |
| ➖ | uds_dogstatsd_20mb_12k_contexts_20_senders | memory utilization | +0.01 | [-0.05, +0.06] | 1 | Logs |
| ➖ | tcp_dd_logs_filter_exclude | ingress throughput | +0.00 | [-0.09, +0.10] | 1 | Logs |
| ➖ | file_to_blackhole_500ms_latency | egress throughput | -0.01 | [-0.40, +0.38] | 1 | Logs |
| ➖ | file_to_blackhole_100ms_latency | egress throughput | -0.01 | [-0.06, +0.04] | 1 | Logs |
| ➖ | uds_dogstatsd_to_api | ingress throughput | -0.02 | [-0.15, +0.12] | 1 | Logs |
| ➖ | ddot_metrics_sum_cumulative | memory utilization | -0.04 | [-0.21, +0.12] | 1 | Logs |
| ➖ | quality_gate_idle | memory utilization | -0.05 | [-0.09, -0.00] | 1 | Logs bounds checks dashboard |
| ➖ | file_to_blackhole_1000ms_latency | egress throughput | -0.06 | [-0.47, +0.36] | 1 | Logs |
| ➖ | ddot_metrics_sum_delta | memory utilization | -0.20 | [-0.40, -0.01] | 1 | Logs |
| ➖ | ddot_metrics_sum_cumulativetodelta_exporter | memory utilization | -0.21 | [-0.44, +0.02] | 1 | Logs |
| ➖ | docker_containers_memory | memory utilization | -0.22 | [-0.30, -0.14] | 1 | Logs |
| ➖ | otlp_ingest_metrics | memory utilization | -0.54 | [-0.69, -0.39] | 1 | Logs |
| ➖ | ddot_metrics | memory utilization | -0.79 | [-1.00, -0.57] | 1 | Logs |
| ➖ | tcp_syslog_to_blackhole | ingress throughput | -1.76 | [-1.83, -1.68] | 1 | Logs |
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".
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 Normal Replicate Execution Failures (non-profiling)
| Experiment | Variant | Replicates | Failure | Debug Dashboard |
|---|---|---|---|---|
| quality_gate_idle_all_features | comparison | 1 | Oom killed | Debug Dashboard |
❌ Retried Profiling Replicate Execution Failures (target internal profiling)
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_all_features | baseline | 11 (x4) | Oom killed | Debug Dashboard |
| quality_gate_idle_all_features | comparison | 11 (x4) | Oom killed | Debug Dashboard |
CI Pass/Fail Decision
✅ Passed. All Quality Gates passed.
- quality_gate_idle_all_features, 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_logs, bounds check lost_bytes: 10/10 replicas passed. Gate passed.
- quality_gate_logs, 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_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 lost_bytes: 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 cpu_usage: 10/10 replicas passed. Gate passed.
- quality_gate_metrics_logs, bounds check memory_usage: 10/10 replicas passed. Gate passed.
fc261f5 to
41e7ee3
Compare
aiuto
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.
I love where this is going w.r.t. reducing noise in the module file. But I have a meta-thought.
It would somewhat desireable to pin the crates for the entire repo rather than just sdagent. That would allow rust code shared between you, QAgent and ADP to interoperate.
Do you have any strong objection to trying it that way now and onboarding new rust code into the global crate lock?
I am all for unifying and simplifying things when possible, but I have a few concerns: For now, we are the only Rust component whose source code lives in the agent repo. I've not heard of ADP or others components wanting to move their code into it in the short/mid term. We also don't use or depend on any of their code. We do have some common dependencies though, and I can see how it looks desirable to put them in common if they decide to move their code to this repo. One issue I can see is about the tooling we use for licenses compliance:
We would need to rely solely on Bazel's There is however a bigger issue, which is that sd-agent aims to be as lightweight as possible. It is its reason to be and why we chose to use Rust instead of Go. To achieve this we only enable the specific crate features that we require from each dependency. In Bazel's crate repository model, features are specified at the repository level and shared by all consumers. This means if other components need features we don't use, those features get compiled into our binary regardless, even with fat LTO. If we want to avoid this bloat, we will need a separate Bazel crate repo for those crates (8 are concerned right now) to have only the features we require. We could however have all the other crates for which we use default features in a global crate repo that would be shared between other future Rust components. But any crate where we need specific feature requirements will need to be kept separate. |
lovasoa
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 to see the famous crate.from_cargo ! should we update the ci to ensure the cargo and bazel lockfiles don't get out of sync ?
Yep, I am working on a followup PR to add lint jobs for this and for the 3rd party license file generation. :) |
|
Thanks for the explanations. I understand your needs better now. |
What does this PR do?
This PR uses Bazel
rules_rustfrom_cargofeature to get the list of crates dependencies fromCargo.tomlandCargo.lock. This prevents developers from having to manually ensure dependencies and their versions are in sync between Cargo and Bazel.Now with this PR, Bazel's also has it own lockfile for sd-agent's crates. This lockfile is updated when setting the
CARGO_BAZEL_REPIN=1env variable and running a bazel command related to sd-agent. One can typically update the lockfile by running:Motivation
Remove manual syncing of dependencies between Cargo and Bazel.
Describe how you validated your changes
Additional Notes