DataDog / saluki

An experimental toolkit for building telemetry data planes in Rust.
Apache License 2.0
12 stars 2 forks source link

chore: start adding more architecture docs, and docs in general #149

Closed tobz closed 1 month ago

tobz commented 1 month ago

Context

The PR title kind of says it all.

We're adding a project-level architecture document, and beefing up the module-level docs for memory-accounting.

pr-commenter[bot] commented 1 month ago

Regression Detector (DogStatsD)

Regression Detector Results

Run ID: e4542b98-cc24-4240-be59-fddbe0a8b222

Baseline: 7.52.0 Comparison: 7.52.1

Performance changes are noted in the perf column of each table:

No significant changes in experiment optimization goals

Confidence level: 90.00% Effect size tolerance: |Δ mean %| ≥ 5.00%

There were no significant changes in experiment optimization goals at this confidence level and effect size tolerance.

Fine details of change detection per experiment

| perf | experiment | goal | Δ mean % | Δ mean % CI | links | |------|----------------------------------------------|--------------------|----------|----------------|-------| | ➖ | dsd_uds_10mb_3k_contexts | ingress throughput | +0.03 | [-0.01, +0.06] | | | ➖ | dsd_uds_1mb_50k_contexts | ingress throughput | +0.02 | [-0.01, +0.04] | | | ➖ | dsd_uds_500mb_3k_contexts | ingress throughput | +0.00 | [-0.01, +0.01] | | | ➖ | dsd_uds_100mb_3k_contexts | ingress throughput | -0.01 | [-0.02, +0.00] | | | ➖ | dsd_uds_100mb_250k_contexts | ingress throughput | -0.01 | [-0.05, +0.03] | | | ➖ | dsd_uds_1mb_50k_contexts_memlimit | ingress throughput | -0.01 | [-0.03, +0.01] | | | ➖ | dsd_uds_512kb_3k_contexts | ingress throughput | -0.03 | [-0.07, +0.01] | | | ➖ | dsd_uds_1mb_3k_contexts | ingress throughput | -0.07 | [-0.14, +0.00] | | | ➖ | dsd_uds_100mb_3k_contexts_distributions_only | memory utilization | -1.36 | [-1.57, -1.15] | |

Explanation

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: 1. Its estimated |Δ mean %| ≥ 5.00%, indicating the change is big enough to merit a closer look. 2. 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. 3. Its configuration does not mark it "erratic".
pr-commenter[bot] commented 1 month ago

Regression Detector (Saluki)

Regression Detector Results

Run ID: 6e765e01-1568-4be6-b741-4bb0e4312ba6

Baseline: e9927147281f7a174208151eeb6fd29dc6c3e023 Comparison: 8b92e67ed3450e477d045bdf4138229b22b2a4dd

Performance changes are noted in the perf column of each table:

No significant changes in experiment optimization goals

Confidence level: 90.00% Effect size tolerance: |Δ mean %| ≥ 5.00%

There were no significant changes in experiment optimization goals at this confidence level and effect size tolerance.

Fine details of change detection per experiment

| perf | experiment | goal | Δ mean % | Δ mean % CI | links | |------|-------------------------------------------------|--------------------|----------|----------------|-------| | ➖ | dsd_uds_1mb_50k_contexts_memlimit | ingress throughput | +0.23 | [-3.01, +3.48] | | | ➖ | dsd_uds_1mb_3k_contexts | ingress throughput | +0.05 | [-0.12, +0.22] | | | ➖ | dsd_uds_500mb_3k_contexts | ingress throughput | +0.03 | [-0.07, +0.12] | | | ➖ | dsd_uds_512kb_3k_contexts | ingress throughput | +0.03 | [-0.09, +0.14] | | | ➖ | dsd_uds_10mb_3k_contexts | ingress throughput | +0.02 | [-0.15, +0.19] | | | ➖ | dsd_uds_50mb_10k_contexts_no_inlining | ingress throughput | -0.00 | [-0.03, +0.03] | | | ➖ | dsd_uds_100mb_3k_contexts | ingress throughput | -0.00 | [-0.02, +0.01] | | | ➖ | dsd_uds_50mb_10k_contexts_no_inlining_no_allocs | ingress throughput | -0.00 | [-0.05, +0.04] | | | ➖ | dsd_uds_1mb_50k_contexts | ingress throughput | -0.01 | [-0.07, +0.04] | | | ➖ | dsd_uds_100mb_250k_contexts | ingress throughput | -0.02 | [-0.30, +0.26] | | | ➖ | dsd_uds_100mb_3k_contexts_distributions_only | memory utilization | -1.23 | [-1.38, -1.09] | |

Explanation

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: 1. Its estimated |Δ mean %| ≥ 5.00%, indicating the change is big enough to merit a closer look. 2. 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. 3. Its configuration does not mark it "erratic".
pr-commenter[bot] commented 1 month ago

Regression Detector Links

Experiment Result Links

experiment link(s)
dsd_uds_100mb_250k_contexts [Profiling (ADP)] [Profiling (DSD)] [SMP Dashboard]
dsd_uds_100mb_3k_contexts [Profiling (ADP)] [Profiling (DSD)] [SMP Dashboard]
dsd_uds_100mb_3k_contexts_distributions_only [Profiling (ADP)] [Profiling (DSD)] [SMP Dashboard]
dsd_uds_10mb_3k_contexts [Profiling (ADP)] [Profiling (DSD)] [SMP Dashboard]
dsd_uds_1mb_3k_contexts [Profiling (ADP)] [Profiling (DSD)] [SMP Dashboard]
dsd_uds_1mb_50k_contexts [Profiling (ADP)] [Profiling (DSD)] [SMP Dashboard]
dsd_uds_1mb_50k_contexts_memlimit [Profiling (ADP)] [Profiling (DSD)] [SMP Dashboard]
dsd_uds_500mb_3k_contexts [Profiling (ADP)] [Profiling (DSD)] [SMP Dashboard]
dsd_uds_512kb_3k_contexts [Profiling (ADP)] [Profiling (DSD)] [SMP Dashboard]
dsd_uds_50mb_10k_contexts_no_inlining (ADP only) [Profiling (ADP)] [SMP Dashboard]
dsd_uds_50mb_10k_contexts_no_inlining_no_allocs (ADP only) [Profiling (ADP)] [SMP Dashboard]