Andrei/symdb upload fields#50398
Conversation
The SymDB upload pipeline previously held each batch in memory three times
over: as a []Scope slice, as a marshalled JSON []byte, and as a gzipped
[]byte. Batches were flushed by buffered function count (default 10000),
which let the in-memory []Scope grow large before any compression.
Replace UploadBatch([]Scope) with a streaming BatchEncoder that owns the
gzip writer and a json.Encoder wrapping it. Scopes are encoded straight
into the gzip stream as they arrive, the caller no longer accumulates a
slice, and flushes are triggered when the compressed buffer reaches a
threshold (DefaultFlushThresholdBytes = 2 MiB). The envelope is written
inside the gzip stream as {service,version,language,upload_id,batch_num,
scopes:[...],final}, with final written at flush time.
Threshold is soft: gzip's internal window means the flushed payload may
overshoot by up to ~32 KiB. A threshold <= 0 forces per-scope flushing,
preserving the cancel-between-flushes test behaviour previously achieved
with maxBufferFuncs=1.
ErrUpload is exposed as a sentinel so callers can distinguish HTTP-side
failures (retryable) from local encoder errors via errors.Is.
https://datadoghq.atlassian.net/browse/DEBUG-5553
... explaining the structure of the upload.
By duplicating some metadata out of the SymDB attachment body into the EvP event body, we can avoid having to download the attachment in the backend when we receive the upload.
ajwerner
left a comment
There was a problem hiding this comment.
Give the PR a better title before you merge as that's what gets checked in.
| meta := []byte(`{ | ||
| "ddsource": "dd_debugger", | ||
| "service": "` + s.service + `", | ||
| "version": "` + s.version + `", | ||
| "runtimeId": "` + s.runtimeID + `", | ||
| "debugger": { | ||
| "type": "symdb" | ||
| "type": "symdb", | ||
| "upload_id": "` + uploadID.String() + `", | ||
| "batch_num": ` + strconv.Itoa(batchNum) + `, | ||
| "final": ` + strconv.FormatBool(final) + `, | ||
| "attachment_size": ` + strconv.Itoa(len(compressedData)) + ` | ||
| } | ||
| }`) |
There was a problem hiding this comment.
nit: looking at this again, I'd prefer you actually did use the Marshal code -- version and service aren't sanitized anywhere. I don't have any reason to believe anything bad is going happen but it doesn't seem worth it to serialize like this.
Files inventory check summaryFile checks results against ancestor 84ef6841: Results for datadog-agent_7.80.0~devel.git.483.fa39ef9.pipeline.111594838-1_amd64.deb:No change detected |
Static quality checks✅ Please find below the results from static quality gates Successful checksInfo
23 successful checks with minimal change (< 2 KiB)
On-wire sizes (compressed)
|
Regression DetectorRegression Detector ResultsMetrics dashboard Baseline: 84ef684 Optimization Goals: ✅ No significant changes detected
|
| perf | experiment | goal | Δ mean % | Δ mean % CI | trials | links |
|---|---|---|---|---|---|---|
| ➖ | docker_containers_cpu | % cpu utilization | -3.22 | [-6.13, -0.32] | 1 | Logs |
Fine details of change detection per experiment
| perf | experiment | goal | Δ mean % | Δ mean % CI | trials | links |
|---|---|---|---|---|---|---|
| ➖ | quality_gate_logs | % cpu utilization | +2.62 | [+1.65, +3.59] | 1 | Logs bounds checks dashboard |
| ➖ | tcp_syslog_to_blackhole | ingress throughput | +2.09 | [+1.88, +2.30] | 1 | Logs |
| ➖ | quality_gate_metrics_logs | memory utilization | +1.68 | [+1.45, +1.92] | 1 | Logs bounds checks dashboard |
| ➖ | file_tree | memory utilization | +0.56 | [+0.51, +0.60] | 1 | Logs |
| ➖ | otlp_ingest_logs | memory utilization | +0.46 | [+0.36, +0.56] | 1 | Logs |
| ➖ | uds_dogstatsd_20mb_12k_contexts_20_senders | memory utilization | +0.42 | [+0.37, +0.46] | 1 | Logs |
| ➖ | ddot_metrics | memory utilization | +0.35 | [+0.17, +0.53] | 1 | Logs |
| ➖ | ddot_metrics_sum_cumulative | memory utilization | +0.16 | [+0.01, +0.32] | 1 | Logs |
| ➖ | ddot_logs | memory utilization | +0.07 | [+0.02, +0.12] | 1 | Logs |
| ➖ | ddot_metrics_sum_delta | memory utilization | +0.06 | [-0.11, +0.23] | 1 | Logs |
| ➖ | uds_dogstatsd_to_api_v3 | ingress throughput | +0.02 | [-0.18, +0.22] | 1 | Logs |
| ➖ | file_to_blackhole_100ms_latency | egress throughput | +0.02 | [-0.14, +0.17] | 1 | Logs |
| ➖ | uds_dogstatsd_to_api | ingress throughput | +0.01 | [-0.20, +0.21] | 1 | Logs |
| ➖ | tcp_dd_logs_filter_exclude | ingress throughput | -0.02 | [-0.11, +0.08] | 1 | Logs |
| ➖ | file_to_blackhole_500ms_latency | egress throughput | -0.03 | [-0.43, +0.38] | 1 | Logs |
| ➖ | file_to_blackhole_1000ms_latency | egress throughput | -0.06 | [-0.49, +0.38] | 1 | Logs |
| ➖ | file_to_blackhole_0ms_latency | egress throughput | -0.07 | [-0.62, +0.49] | 1 | Logs |
| ➖ | quality_gate_idle | memory utilization | -0.09 | [-0.14, -0.05] | 1 | Logs bounds checks dashboard |
| ➖ | quality_gate_idle_all_features | memory utilization | -0.09 | [-0.13, -0.06] | 1 | Logs bounds checks dashboard |
| ➖ | ddot_metrics_sum_cumulativetodelta_exporter | memory utilization | -0.22 | [-0.45, +0.01] | 1 | Logs |
| ➖ | docker_containers_memory | memory utilization | -0.29 | [-0.39, -0.20] | 1 | Logs |
| ➖ | otlp_ingest_metrics | memory utilization | -0.59 | [-0.73, -0.44] | 1 | Logs |
| ➖ | docker_containers_cpu | % cpu utilization | -3.22 | [-6.13, -0.32] | 1 | Logs |
Bounds Checks: ❌ Failed
| perf | experiment | bounds_check_name | replicates_passed | observed_value | links |
|---|---|---|---|---|---|
| ✅ | docker_containers_cpu | simple_check_run | 10/10 | 693 ≥ 26 | |
| ✅ | docker_containers_memory | memory_usage | 10/10 | 261.73MiB ≤ 370MiB | |
| ✅ | docker_containers_memory | simple_check_run | 10/10 | 693 ≥ 26 | |
| ✅ | file_to_blackhole_0ms_latency | memory_usage | 10/10 | 0.18GiB ≤ 1.20GiB | |
| ✅ | file_to_blackhole_0ms_latency | missed_bytes | 10/10 | 0B = 0B | |
| ✅ | file_to_blackhole_1000ms_latency | memory_usage | 10/10 | 0.22GiB ≤ 1.20GiB | |
| ✅ | file_to_blackhole_1000ms_latency | missed_bytes | 10/10 | 0B = 0B | |
| ✅ | file_to_blackhole_100ms_latency | memory_usage | 10/10 | 0.19GiB ≤ 1.20GiB | |
| ✅ | file_to_blackhole_100ms_latency | missed_bytes | 10/10 | 0B = 0B | |
| ✅ | file_to_blackhole_500ms_latency | memory_usage | 10/10 | 0.20GiB ≤ 1.20GiB | |
| ✅ | file_to_blackhole_500ms_latency | missed_bytes | 10/10 | 0B = 0B | |
| ✅ | quality_gate_idle | intake_connections | 10/10 | 3 ≤ 4 | bounds checks dashboard |
| ❌ | quality_gate_idle | memory_usage | 0/10 | 158.81MiB > 147MiB | bounds checks dashboard |
| ✅ | quality_gate_idle_all_features | intake_connections | 10/10 | 3 ≤ 4 | bounds checks dashboard |
| ✅ | quality_gate_idle_all_features | memory_usage | 10/10 | 486.15MiB ≤ 495MiB | bounds checks dashboard |
| ✅ | quality_gate_logs | intake_connections | 10/10 | 4 ≤ 6 | bounds checks dashboard |
| ✅ | quality_gate_logs | memory_usage | 10/10 | 190.94MiB ≤ 195MiB | bounds checks dashboard |
| ✅ | quality_gate_logs | missed_bytes | 10/10 | 0B = 0B | bounds checks dashboard |
| ✅ | quality_gate_metrics_logs | cpu_usage | 10/10 | 352.75 ≤ 2000 | bounds checks dashboard |
| ✅ | quality_gate_metrics_logs | intake_connections | 10/10 | 3 ≤ 6 | bounds checks dashboard |
| ✅ | quality_gate_metrics_logs | memory_usage | 10/10 | 389.52MiB ≤ 430MiB | bounds checks dashboard |
| ✅ | quality_gate_metrics_logs | missed_bytes | 10/10 | 0B = 0B | 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
❌ Failed. Some Quality Gates were violated.
- 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_idle, bounds check intake_connections: 10/10 replicas passed. Gate passed.
- quality_gate_idle, bounds check memory_usage: 0/10 replicas passed. Failed 10 which is > 0. Gate FAILED.
- quality_gate_logs, bounds check missed_bytes: 10/10 replicas passed. Gate passed.
- quality_gate_logs, 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_metrics_logs, bounds check intake_connections: 10/10 replicas passed. Gate passed.
- quality_gate_metrics_logs, bounds check missed_bytes: 10/10 replicas passed. Gate passed.
- quality_gate_metrics_logs, bounds check memory_usage: 10/10 replicas passed. Gate passed.
- quality_gate_metrics_logs, bounds check cpu_usage: 10/10 replicas passed. Gate passed.
By duplicating some metadata out of the SymDB attachment body into the
EvP event body, we can avoid having to download the attachment in the
backend when we receive the upload.