Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(vrl): fix vrl code example #21356

Merged
merged 3 commits into from
Sep 26, 2024

Conversation

Signed-off-by: Alexandre de Sá <[email protected]>
@bits-bot
Copy link

bits-bot commented Sep 25, 2024

CLA assistant check
All committers have signed the CLA.

Signed-off-by: Alexandre de Sá <[email protected]>
@pront pront added the no-changelog Changes in this PR do not need user-facing explanations in the release changelog label Sep 25, 2024
Copy link
Contributor

@pront pront left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @alexandre1984rj!

FYI: You can use the share button and share the playground link.

@pront pront added this pull request to the merge queue Sep 25, 2024
Copy link
Contributor

@drichards-87 drichards-87 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a small suggestion from Docs and approved the PR.

website/content/en/docs/reference/vrl/_index.md Outdated Show resolved Hide resolved
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Sep 25, 2024
@pront pront added this pull request to the merge queue Sep 26, 2024
Copy link

Regression Detector Results

Run ID: c0e48d53-346f-4729-8ae4-098f9a36a191 Metrics dashboard

Baseline: aea5cf8
Comparison: f5c9555

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.

Experiments ignored for regressions

Regressions in experiments with settings containing erratic: true are ignored.

perf experiment goal Δ mean % Δ mean % CI links
file_to_blackhole egress throughput +6.96 [-0.17, +14.09]

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI links
file_to_blackhole egress throughput +6.96 [-0.17, +14.09]
http_text_to_http_json ingress throughput +3.81 [+3.67, +3.95]
datadog_agent_remap_blackhole_acks ingress throughput +3.49 [+3.36, +3.63]
syslog_log2metric_humio_metrics ingress throughput +2.00 [+1.84, +2.17]
datadog_agent_remap_blackhole ingress throughput +1.38 [+1.25, +1.51]
otlp_grpc_to_blackhole ingress throughput +1.36 [+1.21, +1.50]
socket_to_socket_blackhole ingress throughput +1.13 [+1.06, +1.20]
syslog_log2metric_tag_cardinality_limit_blackhole ingress throughput +0.83 [+0.71, +0.94]
syslog_splunk_hec_logs ingress throughput +0.81 [+0.69, +0.93]
fluent_elasticsearch ingress throughput +0.77 [+0.28, +1.27]
syslog_loki ingress throughput +0.47 [+0.37, +0.57]
splunk_hec_route_s3 ingress throughput +0.42 [+0.09, +0.75]
http_elasticsearch ingress throughput +0.24 [+0.07, +0.41]
http_to_http_noack ingress throughput +0.15 [+0.07, +0.23]
splunk_hec_to_splunk_hec_logs_noack ingress throughput +0.03 [-0.07, +0.12]
http_to_http_json ingress throughput +0.02 [-0.02, +0.06]
splunk_hec_to_splunk_hec_logs_acks ingress throughput +0.01 [-0.11, +0.13]
splunk_hec_indexer_ack_blackhole ingress throughput +0.00 [-0.08, +0.09]
http_to_s3 ingress throughput -0.24 [-0.52, +0.03]
datadog_agent_remap_datadog_logs ingress throughput -0.31 [-0.56, -0.05]
http_to_http_acks ingress throughput -0.37 [-1.59, +0.86]
datadog_agent_remap_datadog_logs_acks ingress throughput -0.63 [-0.82, -0.44]
syslog_log2metric_splunk_hec_metrics ingress throughput -1.14 [-1.27, -1.01]
otlp_http_to_blackhole ingress throughput -1.14 [-1.29, -1.00]
syslog_regex_logs2metric_ddmetrics ingress throughput -3.16 [-3.31, -3.01]
syslog_humio_logs ingress throughput -3.50 [-3.77, -3.22]

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 vectordotdev:master with commit f5c9555 Sep 26, 2024
49 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-changelog Changes in this PR do not need user-facing explanations in the release changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants