doc(sinks/aws_kinesis): describe partial failure behavior

[kevinburke]

I assumed that these lines meant that failures would be retried but it does not mean that in many cases, so let's make that explicit and describe the plans to address the behavior.

Updates #359.
Updates #7659.
Updates #16954.

[bits-bot]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

[netlify]

✅ Deploy Preview for vector-project ready!

Name	Link
🔨 Latest commit	c7aae20
🔍 Latest deploy log	https://app.netlify.com/sites/vector-project/deploys/64247ff64cd2a60008f5dbea
😎 Deploy Preview	https://deploy-preview-16998--vector-project.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site settings.

[github-actions]

Regression Detector Results

Run ID: ab939037-c827-4f96-b8c3-b1aa83af4ca4
Baseline: 11fb1aa
Comparison: c7aae20
Total vector CPUs: 7

Explanation

A regression test is an integrated performance test for vector in a repeatable rig, with varying configuration for vector. What follows is a statistical summary of a brief vector run for each configuration across SHAs given above. The goal of these tests are to determine quickly if vector performance is changed and to what degree by a pull request.

The table below, if present, lists those experiments that have experienced a statistically significant change in mean optimization goal performance between baseline and comparison SHAs with 90.00% confidence OR have been detected as newly erratic. Negative values mean that baseline is faster, positive comparison. Results that do not exhibit more than a ±5.00% change in their mean optimization goal are discarded. An experiment is erratic if its coefficient of variation is greater than 0.1. The abbreviated table will be omitted if no interesting change is observed.

Changes in experiment optimization goals with confidence ≥ 90.00% and |Δ mean %| ≥ 5.00%:

experiment	goal	Δ mean	Δ mean %	confidence
http_text_to_http_json	ingress throughput	-1.31MiB/CPU-s	-5.18	100.00%

Fine details of change detection per experiment.

experiment	goal	Δ mean	Δ mean %	confidence	baseline mean	baseline stdev	baseline stderr	baseline outlier %	baseline CoV	comparison mean	comparison stdev	comparison stderr	comparison outlier %	comparison CoV	erratic	declared erratic
file_to_blackhole	egress throughput	632.74KiB/CPU-s	9.12	99.92%	6.78MiB/CPU-s	4.39MiB/CPU-s	136.34KiB/CPU-s	8.371665	0.647609	7.39MiB/CPU-s	3.97MiB/CPU-s	130.62KiB/CPU-s	4.531411	0.537372	True	True
datadog_agent_remap_blackhole	ingress throughput	250.86KiB/CPU-s	0.80	100.00%	30.78MiB/CPU-s	1.06MiB/CPU-s	13.4KiB/CPU-s	0.0	0.034563	31.03MiB/CPU-s	837.31KiB/CPU-s	10.3KiB/CPU-s	0.0	0.026351	False	False
syslog_log2metric_humio_metrics	ingress throughput	48.02KiB/CPU-s	0.77	100.00%	6.09MiB/CPU-s	257.54KiB/CPU-s	3.17KiB/CPU-s	0.0	0.041325	6.13MiB/CPU-s	227.05KiB/CPU-s	2.79KiB/CPU-s	0.0	0.036154	False	False
syslog_regex_logs2metric_ddmetrics	ingress throughput	18.53KiB/CPU-s	0.49	98.80%	3.71MiB/CPU-s	428.35KiB/CPU-s	5.27KiB/CPU-s	0.0	0.112871	3.72MiB/CPU-s	419.23KiB/CPU-s	5.16KiB/CPU-s	0.0	0.109933	True	True
http_to_http_noack	ingress throughput	9.31KiB/CPU-s	0.07	85.65%	13.6MiB/CPU-s	406.71KiB/CPU-s	5.0KiB/CPU-s	0.0	0.029193	13.61MiB/CPU-s	319.57KiB/CPU-s	3.93KiB/CPU-s	0.0	0.022923	False	False
enterprise_http_to_http	ingress throughput	3.99KiB/CPU-s	0.03	69.94%	13.62MiB/CPU-s	250.03KiB/CPU-s	3.08KiB/CPU-s	0.0	0.017928	13.62MiB/CPU-s	188.14KiB/CPU-s	2.32KiB/CPU-s	0.0	0.013486	False	False
splunk_hec_indexer_ack_blackhole	ingress throughput	-155.39B/CPU-s	-0.00	2.75%	13.62MiB/CPU-s	254.11KiB/CPU-s	3.13KiB/CPU-s	0.0	0.018223	13.62MiB/CPU-s	252.56KiB/CPU-s	3.11KiB/CPU-s	0.0	0.018113	False	False
http_to_http_json	ingress throughput	488.66B/CPU-s	0.00	9.68%	13.62MiB/CPU-s	225.99KiB/CPU-s	2.78KiB/CPU-s	0.0	0.016201	13.62MiB/CPU-s	224.99KiB/CPU-s	2.77KiB/CPU-s	0.0	0.016129	False	False
fluent_elasticsearch	ingress throughput	-5.56KiB/CPU-s	-0.01	80.38%	45.41MiB/CPU-s	29.76KiB/CPU-s	371.0B/CPU-s	0.0	0.00064	45.41MiB/CPU-s	352.4KiB/CPU-s	4.29KiB/CPU-s	0.0	0.007578	False	False
splunk_hec_to_splunk_hec_logs_acks	ingress throughput	-998.38B/CPU-s	-0.01	12.58%	13.61MiB/CPU-s	350.71KiB/CPU-s	4.31KiB/CPU-s	0.0	0.025154	13.61MiB/CPU-s	357.15KiB/CPU-s	4.39KiB/CPU-s	0.0	0.025617	False	False
splunk_hec_to_splunk_hec_logs_noack	ingress throughput	-3.93KiB/CPU-s	-0.03	60.94%	13.62MiB/CPU-s	249.7KiB/CPU-s	3.07KiB/CPU-s	0.0	0.017906	13.61MiB/CPU-s	275.91KiB/CPU-s	3.39KiB/CPU-s	0.0	0.019791	False	False
http_to_http_acks	ingress throughput	-2.79KiB/CPU-s	-0.05	4.54%	5.23MiB/CPU-s	2.77MiB/CPU-s	34.88KiB/CPU-s	0.0	0.528918	5.23MiB/CPU-s	2.74MiB/CPU-s	34.48KiB/CPU-s	0.0	0.523145	True	False
datadog_agent_remap_blackhole_acks	ingress throughput	-73.35KiB/CPU-s	-0.23	100.00%	30.77MiB/CPU-s	875.63KiB/CPU-s	10.78KiB/CPU-s	0.0	0.027788	30.7MiB/CPU-s	1.06MiB/CPU-s	13.32KiB/CPU-s	0.0	0.034419	False	False
syslog_log2metric_splunk_hec_metrics	ingress throughput	-54.92KiB/CPU-s	-0.58	100.00%	9.24MiB/CPU-s	294.35KiB/CPU-s	3.62KiB/CPU-s	0.0	0.031116	9.18MiB/CPU-s	254.1KiB/CPU-s	3.13KiB/CPU-s	0.0	0.027017	False	False
datadog_agent_remap_datadog_logs	ingress throughput	-254.13KiB/CPU-s	-0.75	100.00%	32.97MiB/CPU-s	808.48KiB/CPU-s	9.95KiB/CPU-s	0.0	0.023946	32.72MiB/CPU-s	736.37KiB/CPU-s	9.06KiB/CPU-s	0.0	0.021976	False	False
otlp_grpc_to_blackhole	ingress throughput	-8.54KiB/CPU-s	-0.81	100.00%	1.02MiB/CPU-s	49.76KiB/CPU-s	626.88B/CPU-s	0.0	0.047406	1.02MiB/CPU-s	43.08KiB/CPU-s	543.02B/CPU-s	0.0	0.041386	False	False
datadog_agent_remap_datadog_logs_acks	ingress throughput	-333.65KiB/CPU-s	-0.99	100.00%	32.83MiB/CPU-s	1.1MiB/CPU-s	13.89KiB/CPU-s	0.0	0.033569	32.5MiB/CPU-s	905.55KiB/CPU-s	11.14KiB/CPU-s	0.0	0.027207	False	False
splunk_hec_route_s3	ingress throughput	-171.6KiB/CPU-s	-1.44	100.00%	11.62MiB/CPU-s	530.58KiB/CPU-s	6.53KiB/CPU-s	0.0	0.044571	11.46MiB/CPU-s	548.12KiB/CPU-s	6.74KiB/CPU-s	0.0	0.046719	False	False
syslog_loki	ingress throughput	-173.04KiB/CPU-s	-1.98	100.00%	8.53MiB/CPU-s	208.36KiB/CPU-s	2.56KiB/CPU-s	0.0	0.023856	8.36MiB/CPU-s	236.17KiB/CPU-s	2.91KiB/CPU-s	0.0	0.027586	False	False
syslog_splunk_hec_logs	ingress throughput	-224.05KiB/CPU-s	-2.43	100.00%	9.02MiB/CPU-s	208.01KiB/CPU-s	2.56KiB/CPU-s	0.0	0.022523	8.8MiB/CPU-s	229.96KiB/CPU-s	2.83KiB/CPU-s	0.0	0.025518	False	False
otlp_http_to_blackhole	ingress throughput	-40.96KiB/CPU-s	-2.56	100.00%	1.56MiB/CPU-s	108.14KiB/CPU-s	1.33KiB/CPU-s	0.0	0.067624	1.52MiB/CPU-s	118.83KiB/CPU-s	1.46KiB/CPU-s	0.0	0.076267	False	False
syslog_humio_logs	ingress throughput	-270.82KiB/CPU-s	-2.95	100.00%	8.97MiB/CPU-s	221.75KiB/CPU-s	2.73KiB/CPU-s	0.0	0.024135	8.71MiB/CPU-s	261.66KiB/CPU-s	3.22KiB/CPU-s	0.0	0.029344	False	False
socket_to_socket_blackhole	ingress throughput	-515.86KiB/CPU-s	-3.69	100.00%	13.64MiB/CPU-s	250.51KiB/CPU-s	3.08KiB/CPU-s	0.0	0.01793	13.14MiB/CPU-s	275.58KiB/CPU-s	3.39KiB/CPU-s	0.0	0.020481	False	False
http_text_to_http_json	ingress throughput	-1.31MiB/CPU-s	-5.18	100.00%	25.31MiB/CPU-s	639.3KiB/CPU-s	7.87KiB/CPU-s	0.0	0.024663	24.0MiB/CPU-s	523.53KiB/CPU-s	6.44KiB/CPU-s	0.0	0.021301	False	False

[kevinburke]

I think the regression test is a flake because this change only affects documentation in an unrelated part of the codebase.

[spencergilbert]

Thanks!