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(releasing): Fix docs for new components in v0.41.0 #21260

Merged
merged 2 commits into from
Sep 10, 2024

Conversation

jszwedko
Copy link
Member

@jszwedko jszwedko commented Sep 10, 2024

The new static_metrics source and greptimdb_logs sink were not correctly documented. Each commit can be reviewed separately.

And fix `greptimedb_metrics` aliasing.

Also fixed incorrect batch documentation that I noticed.

Signed-off-by: Jesse Szwedko <[email protected]>
@jszwedko jszwedko added the no-changelog Changes in this PR do not need user-facing explanations in the release changelog label Sep 10, 2024
@jszwedko jszwedko requested review from a team as code owners September 10, 2024 19:42
@github-actions github-actions bot added the domain: external docs Anything related to Vector's external, public documentation label Sep 10, 2024
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

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

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

@datadog-vectordotdev
Copy link

Datadog Report

Branch report: jszwedko/website/v0.41.0-fixes
Commit report: 1620b32
Test service: vector

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

@jszwedko jszwedko added this pull request to the merge queue Sep 10, 2024
Copy link

Regression Detector Results

Run ID: fdcac2fd-e8f0-47c9-bc55-8234e1c4ef8f Metrics dashboard

Baseline: 70fc515
Comparison: 584c70c

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 +3.87 [-3.05, +10.79]

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI links
file_to_blackhole egress throughput +3.87 [-3.05, +10.79]
syslog_log2metric_tag_cardinality_limit_blackhole ingress throughput +2.07 [+2.00, +2.14]
syslog_humio_logs ingress throughput +1.76 [+1.67, +1.86]
fluent_elasticsearch ingress throughput +1.60 [+1.10, +2.10]
http_to_http_acks ingress throughput +1.23 [+0.00, +2.45]
syslog_log2metric_splunk_hec_metrics ingress throughput +1.14 [+1.02, +1.27]
http_elasticsearch ingress throughput +0.53 [+0.35, +0.71]
http_text_to_http_json ingress throughput +0.36 [+0.23, +0.48]
syslog_loki ingress throughput +0.34 [+0.27, +0.40]
http_to_s3 ingress throughput +0.29 [+0.01, +0.57]
datadog_agent_remap_datadog_logs ingress throughput +0.15 [-0.08, +0.38]
http_to_http_json ingress throughput +0.07 [+0.01, +0.12]
splunk_hec_to_splunk_hec_logs_noack ingress throughput +0.02 [-0.08, +0.11]
splunk_hec_to_splunk_hec_logs_acks ingress throughput +0.01 [-0.12, +0.13]
http_to_http_noack ingress throughput +0.00 [-0.02, +0.02]
splunk_hec_indexer_ack_blackhole ingress throughput -0.00 [-0.08, +0.08]
datadog_agent_remap_datadog_logs_acks ingress throughput -0.06 [-0.25, +0.13]
otlp_grpc_to_blackhole ingress throughput -0.16 [-0.27, -0.05]
socket_to_socket_blackhole ingress throughput -0.21 [-0.28, -0.14]
datadog_agent_remap_blackhole ingress throughput -0.63 [-0.73, -0.52]
splunk_hec_route_s3 ingress throughput -0.70 [-1.02, -0.39]
syslog_regex_logs2metric_ddmetrics ingress throughput -0.73 [-0.87, -0.60]
otlp_http_to_blackhole ingress throughput -0.85 [-0.99, -0.71]
syslog_splunk_hec_logs ingress throughput -2.27 [-2.39, -2.16]
datadog_agent_remap_blackhole_acks ingress throughput -2.47 [-2.58, -2.36]
syslog_log2metric_humio_metrics ingress throughput -2.57 [-2.70, -2.45]

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

Copy link

@aliciascott aliciascott left a comment

Choose a reason for hiding this comment

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

looks good

Merged via the queue into master with commit 584c70c Sep 10, 2024
86 checks passed
@jszwedko jszwedko deleted the jszwedko/website/v0.41.0-fixes branch September 10, 2024 21:25
jszwedko added a commit that referenced this pull request Sep 11, 2024
* Add documentation for static_metrics source

Signed-off-by: Jesse Szwedko <[email protected]>

* Document `greptimedb_logs` sink

And fix `greptimedb_metrics` aliasing.

Also fixed incorrect batch documentation that I noticed.

Signed-off-by: Jesse Szwedko <[email protected]>

---------

Signed-off-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: 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
Development

Successfully merging this pull request may close these issues.

3 participants