chore: add release docs + general docs cleanup and polish #491
Conversation
tobz
added
the
type/chore
Regression Detector (DogStatsD)Regression Detector ResultsRun ID: cfaa05c1-3c57-4e08-b264-654be8f888e3 Baseline: 7.63.0-rc.2 Optimization Goals: ✅ No significant changes detected
|
| perf | experiment | goal | Δ mean % | Δ mean % CI | trials | links |
|---|---|---|---|---|---|---|
| ➖ | dsd_uds_500mb_3k_contexts | ingress throughput | +3.57 | [+3.39, +3.74] | 1 | |
| ➖ | dsd_uds_100mb_3k_contexts | ingress throughput | +0.01 | [-0.03, +0.05] | 1 | |
| ➖ | dsd_uds_1mb_50k_contexts_memlimit | 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_1mb_50k_contexts | 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_512kb_3k_contexts | ingress throughput | -0.00 | [-0.01, +0.01] | 1 | |
| ➖ | dsd_uds_1mb_3k_contexts_dualship | ingress throughput | -0.00 | [-0.00, +0.00] | 1 | |
| ➖ | dsd_uds_40mb_12k_contexts_40_senders | ingress throughput | -0.00 | [-0.00, +0.00] | 1 | |
| ➖ | dsd_uds_10mb_3k_contexts | ingress throughput | -0.01 | [-0.02, +0.00] | 1 | |
| ➖ | quality_gates_idle_rss | memory utilization | -0.07 | [-0.17, +0.03] | 1 | |
| ➖ | dsd_uds_100mb_3k_contexts_distributions_only | memory utilization | -1.10 | [-1.25, -0.95] | 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: 56def7aa-a47a-4e58-9f85-5d27f93425f0 Baseline: ba9c3a5 Optimization Goals: ✅ No significant changes detected
|
| perf | experiment | goal | Δ mean % | Δ mean % CI | trials | links |
|---|---|---|---|---|---|---|
| ➖ | dsd_uds_100mb_3k_contexts_distributions_only | memory utilization | +1.17 | [+1.06, +1.29] | 1 | |
| ➖ | dsd_uds_500mb_3k_contexts | ingress throughput | +0.92 | [+0.79, +1.04] | 1 | |
| ➖ | dsd_uds_1mb_50k_contexts_memlimit | ingress throughput | +0.14 | [-0.10, +0.39] | 1 | |
| ➖ | dsd_uds_40mb_12k_contexts_40_senders | ingress throughput | +0.01 | [-0.02, +0.04] | 1 | |
| ➖ | dsd_uds_50mb_10k_contexts_no_inlining_no_allocs | ingress throughput | +0.01 | [-0.04, +0.07] | 1 | |
| ➖ | dsd_uds_50mb_10k_contexts_no_inlining | ingress throughput | +0.00 | [-0.08, +0.08] | 1 | |
| ➖ | dsd_uds_100mb_250k_contexts | ingress throughput | -0.00 | [-0.04, +0.04] | 1 | |
| ➖ | dsd_uds_1mb_3k_contexts_dualship | ingress throughput | -0.00 | [-0.01, +0.00] | 1 | |
| ➖ | dsd_uds_100mb_3k_contexts | ingress throughput | -0.00 | [-0.05, +0.05] | 1 | |
| ➖ | dsd_uds_1mb_3k_contexts | ingress throughput | -0.00 | [-0.01, +0.00] | 1 | |
| ➖ | dsd_uds_1mb_50k_contexts | ingress throughput | -0.01 | [-0.02, +0.01] | 1 | |
| ➖ | dsd_uds_512kb_3k_contexts | ingress throughput | -0.01 | [-0.03, +0.00] | 1 | |
| ➖ | dsd_uds_10mb_3k_contexts | ingress throughput | -0.02 | [-0.05, +0.02] | 1 | |
| ➖ | quality_gates_idle_rss | memory utilization | -0.15 | [-0.18, -0.11] | 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 LinksExperiment Result Links
|
| When deciding what version to use, we follow the [Semantic Versioning](https://semver.org/) specification. This means, | ||
| in a nutshell: | ||
|
|
||
| - prior to v1.0.0: | ||
| * breaking changes are indicated by incrementing the minor version | ||
| * new features and bug fixes are generally indicated by incrementing the patch version | ||
| * if there are enough new features/bug fixes, we may instead opt to increment the minor version just for simplicity | ||
| - after v1.0.0: | ||
| * breaking changes are indicated by incrementing the major version (this should generally never happen after v1) | ||
| * new features are indicated by incrementing the minor version | ||
| * bug fixes are indicated by incrementing the patch version |
There was a problem hiding this comment.
Some projects put this in VERSIONING.md so people may expect to find it there. You could create that doc and just point to here or vice versa.
Example: https://github.com/open-telemetry/opentelemetry-go/blob/main/VERSIONING.md
There was a problem hiding this comment.
I'll definitely consider that as a follow-up improvement.
Summary
Started out intending to add documentation around doing ADP releases, but spiraled out in some general documentation cleanup as well.
Change Type
How did you test this PR?
N/A
References
N/A