8000 fix(docs, codecs): Correctly render character delimiter as a char in the docs by jszwedko · Pull Request #21124 · vectordotdev/vector · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

fix(docs, codecs): Correctly render character delimiter as a char in the docs #21124

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Aug 21, 2024
Merged

fix(docs, codecs): Correctly render character delimiter as a char in the docs #21124

merged 2 commits into from
Aug 21, 2024

Conversation

jszwedko
Copy link
Member

Applies same fix from
5a10aa2 with an additional change to handle char config options that lack a default.

Fixes: #21121

@jszwedko
fix(docs, codecs): Correctly render character delimiter as a char in …
310d5a6 
…the docs

Applies same fix from
5a10aa2 with an
additional change to handle char config options that lack a default.

Signed-off-by: Jesse Szwedko <jesse.szwedko@datadoghq.com>
@jszwedko jszwedko requested review from a team as code owners August 20, 2024 19:30
@github-actions github-actions bot added the domain: external docs Anything related to Vector's external, public documentation label Aug 20, 2024
@github-actions GitHub Actions
Copy link

Your preview site for the VRL Playground will be ready in a few minutes, please allow time for it to build.

Heres your preview link:
VRL Playground preview

@github-actions GitHub Actions
Copy link

Your preview site for the vector.dev will be ready in a few minutes, please allow time for it to build.

Heres your preview link:
vector.dev preview

@github-actions GitHub Actions
Copy link

Your preview site for the Rust Doc will be ready in a few minutes, please allow time for it to build.

Heres your preview link:
Rust Doc preview

@jszwedko
Forgot to commit script changes
de42f66 
Signed-off-by: Jesse Szwedko <jesse.szwedko@datadoghq.com>
@github-actions github-actions bot added the domain: ci Anything related to Vector's CI environment label Aug 20, 2024
@jszwedko jszwedko added the no-changelog Changes in this PR do not need user-facing explanations in the release changelog label Aug 20, 2024
@jszwedko jszwedko enabled auto-merge August 20, 2024 19:51
@datadog-vectordotdev
Copy link

Datadog Report

Branch report: jszwedko/website/fix-framing-delimiter
Commit report: f63e238
Test service: vector

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

@jszwedko jszwedko added this pull request to the merge queue Aug 20, 2024
rtrieu
rtrieu approved these changes Aug 20, 2024
View reviewed changes
Copy link
Contributor
@rtrieu rtrieu left a comment

Choose a reason for hiding this comment

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

LGTM

@github-actions GitHub Actions
Copy link

Regression Detector Results

Run ID: e5eb8acb-e1e3-4ea5-bcc4-a74f16bd5f42 Metrics dashboard

Baseline: 12abf9f
Comparison: 51a040c

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

Significant changes in experiment optimization goals

Confidence level: 90.00%
Effect size tolerance: |Δ mean %| ≥ 5.00%

perf experiment goal Δ mean % Δ mean % CI links
❌ otlp_http_to_blackhole ingress throughput -5.32 [-5.45, -5.20]

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 -25.39 [-31.43, -19.35]

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI links
➖ syslog_loki ingress throughput +2.93 [+2.83, +3.04]
➖ syslog_log2metric_humio_metrics ingress throughput +2.35 [+2.22, +2.48]
➖ syslog_regex_logs2metric_ddmetrics ingress throughput +2.29 [+2.12, +2.45]
➖ http_text_to_http_json ingress throughput +2.25 [+2.08, +2.43]
➖ syslog_log2metric_tag_cardinality_limit_blackhole ingress throughput +1.59 [+1.50, +1.69]
➖ splunk_hec_route_s3 ingress throughput +1.33 [+1.01, +1.65]
➖ syslog_log2metric_splunk_hec_metrics ingress throughput +1.19 [+1.08, +1.30]
➖ syslog_splunk_hec_logs ingress throughput +1.16 [+1.03, +1.30]
➖ datadog_agent_remap_blackhole ingress throughput +0.46 [+0.29, +0.64]
➖ http_to_http_noack ingress throughput +0.15 [+0.07, +0.23]
➖ fluent_elasticsearch ingress throughput +0.13 [-0.36, +0.62]
➖ splunk_hec_to_splunk_hec_logs_noack ingress throughput +0.04 [-0.06, +0.13]
➖ splunk_hec_to_splunk_hec_logs_acks ingress throughput +0.00 [-0.11, +0.11]
➖ splunk_hec_indexer_ack_blackhole ingress throughput +0.00 [-0.08, +0.08]
➖ http_to_http_json ingress throughput -0.00 [-0.03, +0.03]
➖ syslog_humio_logs ingress throughput -0.17 [-0.30, -0.05]
➖ http_to_s3 ingress throughput -0.53 [-0.80, -0.27]
➖ datadog_agent_remap_datadog_logs_acks ingress throughput -0.57 [-0.71, -0.42]
➖ http_elasticsearch ingress throughput -0.59 [-0.75, -0.44]
➖ datadog_agent_remap_blackhole_acks ingress throughput -0.93 [-1.05, -0.82]
➖ datadog_agent_remap_datadog_logs ingress throughput -1.23 [-1.44, -1.02]
➖ http_to_http_acks ingress throughput -1.93 [-3.24, -0.62]
➖ otlp_grpc_to_blackhole ingress throughput -2.27 [-2.39, -2.16]
➖ socket_to_socket_blackhole ingress throughput -3.28 [-3.35, -3.20]
❌ otlp_http_to_blackhole ingress throughput -5.32 [-5.45, -5.20]
❌ file_to_blackhole egress throughput -25.39 [-31.43, -19.35]

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

@github-actions GitHub Actions
Copy link

Regression Detector Results

Run ID: c71c2d4e-337f-4560-93ae-e722d1861a0e Metrics dashboard

Baseline: bf93758
Comparison: 76a525b

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 +48.99 [+40.59, +57.39]

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI links
✅ file_to_blackhole egress throughput +48.99 [+40.59, +57.39]
➖ syslog_log2metric_splunk_hec_metrics ingress throughput +1.94 [+1.76, +2.11]
➖ syslog_regex_logs2metric_ddmetrics ingress throughput +1.82 [+1.65, +1.99]
➖ otlp_grpc_to_blackhole ingress throughput +1.53 [+1.40, +1.65]
➖ http_text_to_http_json ingress throughput +1.06 [+0.92, +1.20]
➖ http_to_http_acks ingress throughput +0.74 [-0.57, +2.06]
➖ datadog_agent_remap_blackhole ingress throughput +0.54 [+0.43, +0.64]
➖ syslog_log2metric_humio_metrics ingress throughput +0.17 [+0.04, +0.30]
➖ http_to_http_noack ingress throughput +0.09 [+0.03, +0.16]
➖ http_to_http_json ingress throughput +0.03 [-0.01, +0.06]
➖ splunk_hec_to_splunk_hec_logs_noack ingress throughput +0.01 [-0.09, +0.11]
➖ splunk_hec_to_splunk_hec_logs_acks ingress throughput +0.01 [-0.11, +0.13]
➖ splunk_hec_indexer_ack_blackhole ingress throughput -0.02 [-0.10, +0.06]
➖ http_to_s3 ingress throughput -0.14 [-0.41, +0.14]
➖ syslog_loki ingress throughput -0.15 [-0.23, -0.07]
➖ fluent_elasticsearch ingress throughput -0.21 [-0.70, +0.29]
➖ otlp_http_to_blackhole ingress throughput -0.26 [-0.38, -0.13]
➖ socket_to_socket_blackhole ingress throughput -0.27 [-0.34, -0.20]
➖ syslog_splunk_hec_logs ingress throughput -0.63 [-0.75, -0.51]
➖ http_elasticsearch ingress throughput -1.59 [-1.75, -1.44]
➖ datadog_agent_remap_datadog_logs ingress throughput -1.77 [-1.98, -1.56]
➖ splunk_hec_route_s3 ingress throughput -1.98 [-2.33, -1.64]
➖ syslog_humio_logs ingress throughput -2.09 [-2.21, -1.98]
➖ syslog_log2metric_tag_cardinality_limit_blackhole ingress throughput -2.23 [-2.33, -2.13]
➖ datadog_agent_remap_blackhole_acks ingress throughput -2.34 [-2.47, -2.21]
➖ datadog_agent_remap_datadog_logs_acks ingress throughput -3.11 [-3.34, -2.88]

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

@jszwedko jszwedko deleted the jszwedko/website/fix-framing-delimiter branch August 21, 2024 01:12
AndrooTheChen pushed a commit to discord/vector that referenced this pull request Sep 23, 2024
@jszwedko @AndrooTheChen
fix(docs, codecs): Correctly render character delimiter as a char in …
68216a1 
…the docs (vectordotdev#21124)

* fix(docs, codecs): Correctly render character delimiter as a char in the docs

Applies same fix from
vectordotdev@5a10aa2 with an
additional change to handle char config options that lack a default.

Signed-off-by: Jesse Szwedko <jesse.szwedko@datadoghq.com>

* Forgot to commit script changes

Signed-off-by: Jesse Szwedko <jesse.szwedko@datadoghq.com>

---------

Signed-off-by: Jesse Szwedko <jesse.szwedko@datadoghq.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tobz tobz tobz approved these changes

@rtrieu rtrieu rtrieu approved these changes

Assignees
No one assigned
Labels
domain: ci Anything related to Vector's CI environment domain: external docs Anything related to Vector's external, public documentation no-changelog Changes in this PR do not need user-facing explanations in the release changelog
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Inaccurate documentation of framing.character_delimited.delimiter
3 participants
@jszwedko @tobz @rtrieu
0