docs(sinks): improve documentation of RetryLogic trait functions

[neuronull]

addresses: #19601

[jszwedko]

Thank you! This definitely makes it clearer to me.

[datadog-vectordotdev]

Datadog Report

Branch report: neuronull/docs_clarify_retry_logic
Commit report: 333be49
Test service: vector

✅ 0 Failed, 2092 Passed, 0 Skipped, 1m 23.86s Wall Time

[github-actions]

Regression Detector Results

Run ID: e9e18a90-bd35-41fd-84b3-9b6c2622546f
Baseline: f262324
Comparison: 131ab45
Total CPUs: 7

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

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
➖	splunk_hec_route_s3	ingress throughput	+1.07	[+0.57, +1.56]
➖	http_to_http_acks	ingress throughput	+0.69	[-0.62, +2.00]
➖	syslog_regex_logs2metric_ddmetrics	ingress throughput	+0.66	[+0.56, +0.76]
➖	fluent_elasticsearch	ingress throughput	+0.65	[+0.19, +1.12]
➖	http_to_http_noack	ingress throughput	+0.14	[+0.04, +0.24]
➖	syslog_loki	ingress throughput	+0.13	[+0.06, +0.21]
➖	otlp_http_to_blackhole	ingress throughput	+0.05	[-0.10, +0.20]
➖	http_to_http_json	ingress throughput	+0.03	[-0.05, +0.10]
➖	splunk_hec_indexer_ack_blackhole	ingress throughput	+0.00	[-0.15, +0.15]
➖	splunk_hec_to_splunk_hec_logs_acks	ingress throughput	-0.00	[-0.16, +0.16]
➖	http_to_s3	ingress throughput	-0.03	[-0.31, +0.25]
➖	datadog_agent_remap_blackhole_acks	ingress throughput	-0.03	[-0.12, +0.06]
➖	datadog_agent_remap_blackhole	ingress throughput	-0.05	[-0.14, +0.05]
➖	splunk_hec_to_splunk_hec_logs_noack	ingress throughput	-0.08	[-0.19, +0.03]
➖	enterprise_http_to_http	ingress throughput	-0.10	[-0.18, -0.03]
➖	socket_to_socket_blackhole	ingress throughput	-0.12	[-0.20, -0.05]
➖	syslog_humio_logs	ingress throughput	-0.36	[-0.47, -0.25]
➖	datadog_agent_remap_datadog_logs	ingress throughput	-0.45	[-0.53, -0.37]
➖	http_elasticsearch	ingress throughput	-0.47	[-0.53, -0.40]
➖	datadog_agent_remap_datadog_logs_acks	ingress throughput	-0.54	[-0.62, -0.46]
➖	otlp_grpc_to_blackhole	ingress throughput	-0.56	[-0.64, -0.47]
➖	syslog_log2metric_humio_metrics	ingress throughput	-0.91	[-1.00, -0.83]
➖	syslog_log2metric_tag_cardinality_limit_blackhole	ingress throughput	-1.03	[-1.15, -0.90]
➖	syslog_splunk_hec_logs	ingress throughput	-1.13	[-1.18, -1.08]
➖	syslog_log2metric_splunk_hec_metrics	ingress throughput	-1.90	[-2.04, -1.77]
➖	http_text_to_http_json	ingress throughput	-1.93	[-2.05, -1.81]
➖	file_to_blackhole	egress throughput	-2.69	[-5.24, -0.13]

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".

[dsmith3197]

Nice, thanks!