enhancement(common): add opinionated string builder helper#847
Conversation
This stack of pull requests is managed by Graphite. Learn more about stacking. |
Regression Detector (DogStatsD)Regression Detector ResultsRun ID: d912f9fe-9480-4e16-bf1c-b2c5df5699fc Baseline: 7.68.3 Optimization Goals: ✅ No significant changes detected
|
| perf | experiment | goal | Δ mean % | Δ mean % CI | trials | links |
|---|---|---|---|---|---|---|
| ➖ | quality_gates_idle_rss | memory utilization | +0.49 | [+0.43, +0.54] | 1 | |
| ➖ | dsd_uds_1mb_50k_contexts | ingress throughput | +0.00 | [-0.00, +0.00] | 1 | |
| ➖ | dsd_uds_512kb_3k_contexts | ingress throughput | +0.00 | [-0.01, +0.01] | 1 | |
| ➖ | dsd_uds_10mb_3k_contexts | ingress throughput | -0.00 | [-0.00, +0.00] | 1 | |
| ➖ | dsd_uds_100mb_250k_contexts | ingress throughput | -0.00 | [-0.00, +0.00] | 1 | |
| ➖ | dsd_uds_100mb_3k_contexts | ingress throughput | -0.00 | [-0.11, +0.11] | 1 | |
| ➖ | dsd_uds_1mb_50k_contexts_memlimit | ingress throughput | -0.00 | [-0.00, +0.00] | 1 | |
| ➖ | dsd_uds_1mb_3k_contexts | ingress throughput | -0.00 | [-0.00, +0.00] | 1 | |
| ➖ | dsd_uds_1mb_3k_contexts_dualship | ingress throughput | -0.00 | [-0.00, +0.00] | 1 | |
| ➖ | dsd_uds_100mb_3k_contexts_distributions_only | memory utilization | -0.00 | [-0.17, +0.16] | 1 | |
| ➖ | dsd_uds_500mb_3k_contexts | ingress throughput | -1.99 | [-2.07, -1.91] | 1 |
Bounds Checks: ❌ Failed
| perf | experiment | bounds_check_name | replicates_passed | links |
|---|---|---|---|---|
| ❌ | quality_gates_idle_rss | memory_usage | 0/10 |
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".
Regression Detector (Saluki)Regression Detector ResultsRun ID: 5351e85c-7c2d-413b-8c61-e70fbeca74ff Baseline: b5de018 Optimization Goals: ✅ No significant changes detected
|
| perf | experiment | goal | Δ mean % | Δ mean % CI | trials | links |
|---|---|---|---|---|---|---|
| ➖ | quality_gates_idle_rss | memory utilization | +1.63 | [+1.61, +1.65] | 1 | |
| ➖ | dsd_uds_100mb_3k_contexts_distributions_only | memory utilization | +0.60 | [+0.42, +0.78] | 1 | |
| ➖ | dsd_uds_1mb_50k_contexts | ingress throughput | +0.02 | [+0.00, +0.05] | 1 | |
| ➖ | dsd_uds_50mb_10k_contexts_no_inlining | ingress throughput | +0.02 | [-0.10, +0.13] | 1 | |
| ➖ | dsd_uds_1mb_3k_contexts_dualship | ingress throughput | +0.01 | [-0.00, +0.02] | 1 | |
| ➖ | dsd_uds_512kb_3k_contexts | ingress throughput | +0.01 | [-0.01, +0.02] | 1 | |
| ➖ | dsd_uds_100mb_250k_contexts | ingress throughput | +0.00 | [-0.04, +0.04] | 1 | |
| ➖ | dsd_uds_10mb_3k_contexts | ingress throughput | +0.00 | [-0.04, +0.04] | 1 | |
| ➖ | dsd_uds_1mb_50k_contexts_memlimit | ingress throughput | -0.00 | [-0.01, +0.01] | 1 | |
| ➖ | dsd_uds_100mb_3k_contexts | ingress throughput | -0.00 | [-0.06, +0.06] | 1 | |
| ➖ | dsd_uds_1mb_3k_contexts | ingress throughput | -0.00 | [-0.01, +0.00] | 1 | |
| ➖ | dsd_uds_50mb_10k_contexts_no_inlining_no_allocs | ingress throughput | -0.03 | [-0.14, +0.09] | 1 | |
| ➖ | dsd_uds_500mb_3k_contexts | ingress throughput | -1.36 | [-1.48, -1.24] | 1 |
Bounds Checks: ✅ Passed
| perf | experiment | bounds_check_name | replicates_passed | links |
|---|---|---|---|---|
| ✅ | quality_gates_idle_rss | memory_usage | 10/10 |
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".
Regression Detector (ADP && Checks)Regression Detector ResultsRun ID: fb14e184-4220-41b8-8bcc-a6d69a0a1d77 Baseline: b745e4f Optimization Goals: ✅ No significant changes detected
|
| perf | experiment | goal | Δ mean % | Δ mean % CI | trials | links |
|---|---|---|---|---|---|---|
| ➖ | quality_gates_idle_rss | memory utilization | -0.01 | [-0.03, +0.00] | 1 | |
| ➖ | quality_gates_rss | memory utilization | -0.09 | [-0.12, -0.06] | 1 |
Bounds Checks: ❌ Failed
| perf | experiment | bounds_check_name | replicates_passed | links |
|---|---|---|---|---|
| ✅ | quality_gates_idle_rss | memory_usage | 10/10 | |
| ❌ | quality_gates_rss | memory_usage | 0/10 |
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".
Regression Detector LinksADP Experiment Result Links
ADP && Checks Experiment Result Links
|
543d371 to
ac12551
Compare
7d975a1 to
77ebcd4
Compare
ac12551 to
9772eb2
Compare
lib/saluki-common/src/strings.rs
Outdated
| /// Returns `None` if the string exceeds the configured limit or if it cannot be interned. | ||
| pub fn try_intern(&mut self) -> Option<MetaString> { | ||
| let interned = self.interner.try_intern(self.string()); | ||
| self.clear(); |
There was a problem hiding this comment.
Are we okay with clearing even if the interner fails?
There was a problem hiding this comment.
That's a fair question.
We don't automatically do anything along those lines when just calling StringBuilder::string, so having it happen for try_intern is divergent.
My thought process was that if you're bothering to intern at all, you probably only want the resulting string if it can be interned... but admittedly, that might be a bit too restrictive.
I'll change this to avoid clearing the builder at all in try_intern.
9772eb2 to
e14ab72
Compare
e14ab72 to
ee97b83
Compare

Summary
This PR adds
StringBuilder, a classical "string builder" helper type that allows building strings on top of reusable backing storage. It is primarily designed for our common paradigms, which means that it has first-class support for fallibly building strings based on a user-configurable size limit, such that we can do bounded/deterministic memory usage things on top of it. Going further, it also supports being connected to a string interner to allow building strings that then get interned directly.Change Type
How did you test this PR?
New unit tests.
References
AGTMETRICS-233