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

enhancement(administration config): New --skip-healthchecks option for vector validate #19691

Merged

Conversation

MartinEmrich
Copy link
Contributor

Runs full validation including VRL remaps, but skips health check connection attempts to remote sinks.

It sits in the middle between vector validate --no-environment (does not validate VRL remap transforms, thus does not catch VRL errors) and plain vector validate (which also fails if the config is valid, but health check targets fail).

I use/need this to validate my VRL heavy configuration file before deploying it to a remote system. From my local system, the targets are not reachable, so health checks would fail.

I believe this could be useful for many people authoring VRL scripts/rules, e.g. as a Git pre-commit hook.

Runs full validation including VRL remaps, but skips health check
connection attempts to remote sinks.
@MartinEmrich MartinEmrich requested review from a team as code owners January 23, 2024 13:41
@github-actions github-actions bot added the domain: external docs Anything related to Vector's external, public documentation label Jan 23, 2024
@jszwedko jszwedko added the domain: cli Anything related to Vector's CLI label Jan 23, 2024
Copy link
Contributor

@maycmlee maycmlee left a comment

Choose a reason for hiding this comment

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

Just a couple of suggestions.

website/content/en/docs/administration/validating.md Outdated Show resolved Hide resolved
website/content/en/docs/administration/validating.md Outdated Show resolved Hide resolved
@MartinEmrich MartinEmrich changed the title <enhancement>(administration config): New --skip-healthchecks option for vector validate enhancement(administration config): New --skip-healthchecks option for vector validate Jan 26, 2024
Copy link
Member

@jszwedko jszwedko left a comment

Choose a reason for hiding this comment

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

Thanks @MartinEmrich !

@jszwedko jszwedko enabled auto-merge February 6, 2024 18:10
@jszwedko jszwedko added this pull request to the merge queue Feb 8, 2024
Copy link

github-actions bot commented Feb 9, 2024

Regression Detector Results

Run ID: 973c051b-9450-4c28-9662-cf2d966a3235
Baseline: 0e6cf3e
Comparison: 1825220
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
otlp_http_to_blackhole ingress throughput +4.86 [+4.71, +5.00]
http_text_to_http_json ingress throughput +3.79 [+3.67, +3.92]
socket_to_socket_blackhole ingress throughput +1.96 [+1.89, +2.03]
file_to_blackhole egress throughput +1.91 [-0.77, +4.59]
syslog_splunk_hec_logs ingress throughput +1.21 [+1.14, +1.28]
syslog_loki ingress throughput +0.91 [+0.87, +0.96]
splunk_hec_route_s3 ingress throughput +0.86 [+0.36, +1.36]
http_to_http_noack ingress throughput +0.16 [+0.08, +0.24]
syslog_log2metric_tag_cardinality_limit_blackhole ingress throughput +0.08 [-0.03, +0.20]
http_to_http_json ingress throughput +0.02 [-0.05, +0.10]
splunk_hec_to_splunk_hec_logs_acks ingress throughput -0.00 [-0.16, +0.16]
splunk_hec_indexer_ack_blackhole ingress throughput -0.00 [-0.15, +0.14]
splunk_hec_to_splunk_hec_logs_noack ingress throughput -0.04 [-0.16, +0.07]
syslog_log2metric_splunk_hec_metrics ingress throughput -0.04 [-0.19, +0.10]
enterprise_http_to_http ingress throughput -0.09 [-0.15, -0.03]
http_elasticsearch ingress throughput -0.21 [-0.28, -0.14]
syslog_humio_logs ingress throughput -0.27 [-0.37, -0.18]
datadog_agent_remap_blackhole_acks ingress throughput -0.29 [-0.38, -0.19]
http_to_s3 ingress throughput -0.31 [-0.59, -0.03]
fluent_elasticsearch ingress throughput -0.43 [-0.89, +0.04]
otlp_grpc_to_blackhole ingress throughput -0.47 [-0.56, -0.38]
syslog_regex_logs2metric_ddmetrics ingress throughput -0.87 [-1.01, -0.74]
datadog_agent_remap_datadog_logs_acks ingress throughput -1.14 [-1.22, -1.06]
datadog_agent_remap_datadog_logs ingress throughput -1.24 [-1.32, -1.16]
http_to_http_acks ingress throughput -1.64 [-2.94, -0.34]
syslog_log2metric_humio_metrics ingress throughput -1.93 [-2.03, -1.82]
datadog_agent_remap_blackhole ingress throughput -1.94 [-2.04, -1.83]

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 1825220 Feb 9, 2024
49 checks passed
AndrooTheChen pushed a commit to discord/vector that referenced this pull request Sep 23, 2024
…r vector validate (vectordotdev#19691)

* New --skip-healthchecks option for vector validate

Runs full validation including VRL remaps, but skips health check
connection attempts to remote sinks.

* Spelling fix

* Documentation suggestions by @maycmlee

---------

Co-authored-by: Jesse Szwedko <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
domain: cli Anything related to Vector's CLI domain: external docs Anything related to Vector's external, public documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants