Skip to content

Conversation

@bruceg
Copy link
Member

@bruceg bruceg commented May 22, 2024

The example value field in component descriptions is wrapped in an Option, but all uses of it set it to Some. This removes the optionality and drops the resulting unreachable error case.

The example value field in component descriptions is wrapped in an `Option`, but
all uses of it set it to `Some`. This removes the optionality and drops the
resulting unreachable error case.
@bruceg bruceg added type: tech debt A code change that does not add user value. domain: config Anything related to configuring Vector domain: core Anything related to core crates i.e. vector-core, core-common, etc no-changelog Changes in this PR do not need user-facing explanations in the release changelog labels May 22, 2024
@bruceg bruceg requested a review from a team as a code owner May 22, 2024 22:10
@github-actions github-actions bot removed the domain: core Anything related to core crates i.e. vector-core, core-common, etc label May 22, 2024
@datadog-vectordotdev
Copy link

Datadog Report

Branch report: bruceg/drop-missing-example
Commit report: cd21099
Test service: vector

✅ 0 Failed, 7 Passed, 0 Skipped, 25.38s Total Time

@bruceg bruceg added this pull request to the merge queue May 23, 2024
@bruceg bruceg removed this pull request from the merge queue due to a manual request May 23, 2024
@github-actions
Copy link

Regression Detector Results

Run ID: 6300d590-affb-45ea-b5a8-c5e908181e66
Baseline: 4cc1ecf
Comparison: 2131b86
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
socket_to_socket_blackhole ingress throughput +1.60 [+1.54, +1.66]
syslog_log2metric_splunk_hec_metrics ingress throughput +0.64 [+0.50, +0.78]
http_to_http_acks ingress throughput +0.58 [-0.78, +1.94]
datadog_agent_remap_datadog_logs_acks ingress throughput +0.37 [+0.29, +0.44]
syslog_humio_logs ingress throughput +0.36 [+0.22, +0.49]
otlp_http_to_blackhole ingress throughput +0.25 [+0.14, +0.35]
file_to_blackhole egress throughput +0.23 [-2.27, +2.73]
datadog_agent_remap_datadog_logs ingress throughput +0.20 [+0.10, +0.31]
http_to_http_noack ingress throughput +0.12 [+0.02, +0.21]
datadog_agent_remap_blackhole ingress throughput +0.04 [-0.05, +0.12]
http_to_http_json ingress throughput +0.02 [-0.05, +0.10]
splunk_hec_to_splunk_hec_logs_acks ingress throughput +0.00 [-0.14, +0.14]
splunk_hec_indexer_ack_blackhole ingress throughput +0.00 [-0.15, +0.15]
http_to_s3 ingress throughput -0.01 [-0.29, +0.27]
splunk_hec_to_splunk_hec_logs_noack ingress throughput -0.05 [-0.17, +0.06]
enterprise_http_to_http ingress throughput -0.07 [-0.12, -0.02]
http_text_to_http_json ingress throughput -0.07 [-0.19, +0.05]
splunk_hec_route_s3 ingress throughput -0.11 [-0.56, +0.35]
datadog_agent_remap_blackhole_acks ingress throughput -0.19 [-0.28, -0.09]
fluent_elasticsearch ingress throughput -0.28 [-0.76, +0.20]
http_elasticsearch ingress throughput -0.55 [-0.62, -0.48]
syslog_loki ingress throughput -1.20 [-1.25, -1.15]
otlp_grpc_to_blackhole ingress throughput -1.30 [-1.39, -1.21]
syslog_log2metric_humio_metrics ingress throughput -2.10 [-2.21, -1.99]
syslog_splunk_hec_logs ingress throughput -2.29 [-2.34, -2.23]
syslog_log2metric_tag_cardinality_limit_blackhole ingress throughput -3.29 [-3.40, -3.19]
syslog_regex_logs2metric_ddmetrics ingress throughput -3.30 [-3.39, -3.20]

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

@bruceg bruceg added this pull request to the merge queue May 23, 2024
@github-actions
Copy link

Regression Detector Results

Run ID: 1630d0b9-09df-4e40-b640-736c7501b107
Baseline: f5abce9
Comparison: 8b4a3ba
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
syslog_log2metric_humio_metrics ingress throughput +1.62 [+1.53, +1.71]
http_text_to_http_json ingress throughput +1.62 [+1.47, +1.76]
socket_to_socket_blackhole ingress throughput +1.46 [+1.39, +1.54]
datadog_agent_remap_datadog_logs_acks ingress throughput +1.41 [+1.31, +1.50]
datadog_agent_remap_blackhole ingress throughput +1.39 [+1.30, +1.47]
splunk_hec_route_s3 ingress throughput +1.36 [+0.90, +1.82]
otlp_http_to_blackhole ingress throughput +1.33 [+1.21, +1.45]
datadog_agent_remap_blackhole_acks ingress throughput +1.15 [+1.05, +1.24]
datadog_agent_remap_datadog_logs ingress throughput +1.05 [+0.94, +1.16]
syslog_splunk_hec_logs ingress throughput +1.01 [+0.96, +1.05]
syslog_log2metric_splunk_hec_metrics ingress throughput +0.86 [+0.72, +0.99]
http_to_http_acks ingress throughput +0.84 [-0.52, +2.19]
fluent_elasticsearch ingress throughput +0.40 [-0.08, +0.89]
syslog_log2metric_tag_cardinality_limit_blackhole ingress throughput +0.37 [+0.25, +0.50]
syslog_loki ingress throughput +0.33 [+0.28, +0.37]
syslog_regex_logs2metric_ddmetrics ingress throughput +0.11 [-0.01, +0.24]
http_to_http_noack ingress throughput +0.09 [-0.01, +0.19]
http_to_http_json ingress throughput +0.04 [-0.04, +0.11]
splunk_hec_to_splunk_hec_logs_acks ingress throughput -0.00 [-0.14, +0.14]
splunk_hec_indexer_ack_blackhole ingress throughput -0.00 [-0.15, +0.14]
http_to_s3 ingress throughput -0.02 [-0.30, +0.26]
splunk_hec_to_splunk_hec_logs_noack ingress throughput -0.04 [-0.15, +0.08]
syslog_humio_logs ingress throughput -0.04 [-0.16, +0.08]
otlp_grpc_to_blackhole ingress throughput -0.12 [-0.21, -0.03]
enterprise_http_to_http ingress throughput -0.14 [-0.22, -0.07]
http_elasticsearch ingress throughput -0.41 [-0.49, -0.34]
file_to_blackhole egress throughput -1.28 [-3.84, +1.28]

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

Merged via the queue into master with commit 8b4a3ba May 23, 2024
@bruceg bruceg deleted the bruceg/drop-missing-example branch May 23, 2024 17:11
paomian pushed a commit to paomian/vector that referenced this pull request Jun 12, 2024
…#20550)

The example value field in component descriptions is wrapped in an `Option`, but
all uses of it set it to `Some`. This removes the optionality and drops the
resulting unreachable error case.
AndrooTheChen pushed a commit to discord/vector that referenced this pull request Sep 23, 2024
…#20550)

The example value field in component descriptions is wrapped in an `Option`, but
all uses of it set it to `Some`. This removes the optionality and drops the
resulting unreachable error case.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

domain: config Anything related to configuring Vector no-changelog Changes in this PR do not need user-facing explanations in the release changelog type: tech debt A code change that does not add user value.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants