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

feat: pub prometheus sink configs #19540

Merged
merged 4 commits into from
Jan 15, 2024

Conversation

suikammd
Copy link
Contributor

@suikammd suikammd commented Jan 8, 2024

close issue #19517

@suikammd suikammd requested a review from a team January 8, 2024 11:42
@github-actions github-actions bot added the domain: sinks Anything related to the Vector's sinks label Jan 8, 2024
@StephenWakely StephenWakely added the no-changelog Changes in this PR do not need user-facing explanations in the release changelog label Jan 8, 2024
@StephenWakely
Copy link
Contributor

@suikammd I think CI is exposing further errors to the rust-doc generation due to making these fields public. Would you be able to cd rust-doc; make docs and have a look at the errors it is now raising? It's unlikely to be caused by the changes you are making, so if you have any questions on how to fix them let me know.

@suikammd
Copy link
Contributor Author

suikammd commented Jan 10, 2024

@StephenWakely I find we should add vector_core in dependencies. After add this dependency, make docs passed.

You may check the new commit. thx!

It is wired that add dependency to dependencies since we do not need it to build vector crate. I tried add this dependency to dev-dependencies, it doesn't work like described in this link.

Copy link
Contributor

@StephenWakely StephenWakely left a comment

Choose a reason for hiding this comment

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

@suikammd The error is because those symbols are being imported into Vector via vector_lib::sink::VectorSink. So rather changing Vector to import vector_core, can you update the links to point to vector_lib. You could probably remove the path altogether since the compiler should know where to find it:

//! Contains the [`VectorSink`] instance that is responsible

If you feel inclined could you change this comment:

//! The Prometheus Remote Write [`vector_core::sink::VectorSink`]

to just say

//! The Prometheus Remote Write sink

It doesn't really make sense to link to the trait in the comment there anyway.

@@ -1,5 +1,5 @@
//! The Prometheus Remote Write [`vector_core::sink::VectorSink`].
//! Contains the [`vector_core::sink::VectorSink`] instance that is responsible
//! The Prometheus Remote Write.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
//! The Prometheus Remote Write.
//! The Prometheus Remote Write sink.

//! The Prometheus Remote Write [`vector_core::sink::VectorSink`].
//! Contains the [`vector_core::sink::VectorSink`] instance that is responsible
//! The Prometheus Remote Write.
//! Contains the [`VectorSink`] instance that is responsible
//! for taking a stream of [`vector_core::event::Event`] and forwarding
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
//! for taking a stream of [`vector_core::event::Event`] and forwarding
//! for taking a stream of [`Event`] and forwarding

@StephenWakely StephenWakely added this pull request to the merge queue Jan 15, 2024
Copy link

Regression Detector Results

Run ID: cfb5c310-8b17-473b-9fa1-bd46e9103bfc
Baseline: 20b4fc7
Comparison: 38d8801
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_tag_cardinality_limit_blackhole ingress throughput +2.84 [+2.69, +2.98]
file_to_blackhole egress throughput +1.81 [-0.82, +4.44]
splunk_hec_route_s3 ingress throughput +1.15 [+0.65, +1.65]
datadog_agent_remap_blackhole ingress throughput +0.67 [+0.56, +0.78]
syslog_splunk_hec_logs ingress throughput +0.58 [+0.52, +0.64]
syslog_log2metric_splunk_hec_metrics ingress throughput +0.45 [+0.28, +0.61]
http_elasticsearch ingress throughput +0.38 [+0.30, +0.46]
http_to_s3 ingress throughput +0.32 [+0.04, +0.60]
socket_to_socket_blackhole ingress throughput +0.07 [+0.00, +0.13]
http_to_http_noack ingress throughput +0.05 [-0.05, +0.15]
http_to_http_json ingress throughput +0.04 [-0.04, +0.11]
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]
http_to_http_acks ingress throughput -0.00 [-1.32, +1.31]
splunk_hec_to_splunk_hec_logs_noack ingress throughput -0.06 [-0.18, +0.05]
otlp_http_to_blackhole ingress throughput -0.08 [-0.23, +0.07]
datadog_agent_remap_blackhole_acks ingress throughput -0.10 [-0.19, -0.01]
syslog_humio_logs ingress throughput -0.10 [-0.18, -0.02]
enterprise_http_to_http ingress throughput -0.11 [-0.18, -0.03]
datadog_agent_remap_datadog_logs ingress throughput -0.25 [-0.33, -0.17]
otlp_grpc_to_blackhole ingress throughput -0.30 [-0.39, -0.21]
syslog_loki ingress throughput -0.47 [-0.53, -0.41]
fluent_elasticsearch ingress throughput -0.48 [-0.94, -0.01]
syslog_log2metric_humio_metrics ingress throughput -0.62 [-0.74, -0.51]
syslog_regex_logs2metric_ddmetrics ingress throughput -1.02 [-1.10, -0.93]
datadog_agent_remap_datadog_logs_acks ingress throughput -1.11 [-1.19, -1.03]
http_text_to_http_json ingress throughput -1.87 [-1.99, -1.75]

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 38d8801 Jan 15, 2024
40 checks passed
AndrooTheChen pushed a commit to discord/vector that referenced this pull request Sep 23, 2024
* feat: pub prometheus sink configs

* fix: make doc should use vector_core

* change sink prometheus remote_write comment

* change sink prometheus remote_write comment
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
domain: sinks Anything related to the Vector's sinks 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