Skip to content

chore(observability): add component spec validation tests for datadog_logs sink#19887

Merged
neuronull merged 5 commits intomasterfrom
neuronull/component_validation_sinks_datadog_logs_happy
Mar 6, 2024
Merged

chore(observability): add component spec validation tests for datadog_logs sink#19887
neuronull merged 5 commits intomasterfrom
neuronull/component_validation_sinks_datadog_logs_happy

Conversation

@neuronull
Copy link
Contributor

@neuronull neuronull commented Feb 15, 2024

Adding the sad path cases is blocked by #18062

 make test-component-validation
cargo nextest run --no-fail-fast --no-default-features --features component-validation-tests --status-level pass --test-threads 4 components::validation::tests
    Starting 4 tests across 3 binaries (343 skipped)
        PASS [   5.470s] vector components::validation::tests::validate_component_tests_validation_components_sources_http_server_yaml
        PASS [  10.136s] vector components::validation::tests::validate_component_tests_validation_components_sources_http_client_yaml
        PASS [  20.943s] vector components::validation::tests::validate_component_tests_validation_components_sinks_http_yaml
        PASS [  25.950s] vector components::validation::tests::validate_component_tests_validation_components_sinks_datadog_logs_yaml
------------
     Summary [  25.951s] 4 tests run: 4 passed, 343 skipped

2024-03-05T23:12:09.348631Z  INFO vector::components::validation: Successfully validated component 'datadog_logs':
  test case 'happy path': passed
    - sent 3 inputs and received 3 outputs
    - received 4911 telemetry events
    - component_received_events_total: 3
    - component_received_event_bytes_total: 291
    - component_received_bytes_total: 0
    - component_sent_events_total: 3
    - component_sent_event_bytes_total: 237
    - component_sent_bytes_total: 241
    - component_errors_total: 0
    - component_discarded_events_total: 0
  test case 'sad path': passed
    - sent 1 inputs and received 0 outputs
    - received 7223 telemetry events
    - component_received_events_total: 1
    - component_received_event_bytes_total: 114
    - component_received_bytes_total: 0
    - component_sent_events_total: 0
    - component_sent_event_bytes_total: 0
    - component_sent_bytes_total: 0
    - component_errors_total: 1
    - component_discarded_events_total: 1

@neuronull neuronull self-assigned this Feb 15, 2024
@neuronull neuronull added the no-changelog Changes in this PR do not need user-facing explanations in the release changelog label Feb 15, 2024
@neuronull neuronull marked this pull request as ready for review February 15, 2024 23:50
@neuronull neuronull requested a review from a team February 15, 2024 23:50
@pront pront requested a review from bruceg February 16, 2024 14:32
Copy link
Member

@bruceg bruceg left a comment

Choose a reason for hiding this comment

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

I share @pront's concern with the increased sleep fudge factor, but understand it is temporary. Otherwise LGTM.

@pront
Copy link
Member

pront commented Feb 19, 2024

I share @pront's concern with the increased sleep fudge factor, but understand it is temporary. Otherwise LGTM.

It would be even better if we had a corresponding JIRA issue since it is very easy to forget such things.

@neuronull
Copy link
Contributor Author

It would be even better if we had a corresponding JIRA issue since it is very easy to forget such things.

One exists already and is assigned to me, I wasn't mentioning it here since it's a source of divide with the community.

@neuronull neuronull added domain: observability Anything related to monitoring/observing Vector domain: tests Anything related to Vector's internal tests labels Feb 22, 2024
@neuronull
Copy link
Contributor Author

Note- I'm holding off on this PR until #19927 is merged into master. It will nullify the need to increase the static sleep (because it's removed) and it also changes the error validation case (which this branch currently is missing and it makes more sense to add only once).

@neuronull neuronull added the meta: blocked Anything that is blocked to the point where it cannot be worked on. label Feb 22, 2024
@neuronull neuronull changed the title chore(observability): add happy path component spec validation tests for datadog_logs sink chore(observability): add component spec validation tests for datadog_logs sink Mar 5, 2024
@neuronull neuronull added sink: datadog_logs Anything `datadog_logs` sink related and removed meta: blocked Anything that is blocked to the point where it cannot be worked on. labels Mar 5, 2024
@github-actions github-actions bot added domain: sources Anything related to the Vector's sources domain: sinks Anything related to the Vector's sinks labels Mar 5, 2024
@datadog-vectordotdev
Copy link

datadog-vectordotdev bot commented Mar 5, 2024

Datadog Report

Branch report: neuronull/component_validation_sinks_datadog_logs_happy
Commit report: 381d330
Test service: vector

✅ 0 Failed, 43 Passed, 0 Skipped, 1m 30.09s Wall Time

@neuronull neuronull enabled auto-merge March 6, 2024 18:21
@neuronull neuronull added this pull request to the merge queue Mar 6, 2024
@github-actions
Copy link
Contributor

github-actions bot commented Mar 6, 2024

Regression Detector Results

Run ID: e983c921-4543-4cd4-b653-6628f74b292f
Baseline: 2d5e372
Comparison: 03de6e9
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
socket_to_socket_blackhole ingress throughput +3.58 [+3.51, +3.65]
otlp_http_to_blackhole ingress throughput +2.68 [+2.52, +2.84]
datadog_agent_remap_blackhole_acks ingress throughput +1.74 [+1.64, +1.85]
datadog_agent_remap_datadog_logs ingress throughput +0.98 [+0.87, +1.09]
datadog_agent_remap_blackhole ingress throughput +0.56 [+0.46, +0.65]
fluent_elasticsearch ingress throughput +0.52 [+0.06, +0.99]
http_to_s3 ingress throughput +0.20 [-0.09, +0.48]
http_to_http_noack ingress throughput +0.12 [+0.04, +0.20]
http_elasticsearch ingress throughput +0.09 [+0.01, +0.16]
http_to_http_json ingress throughput +0.03 [-0.04, +0.11]
splunk_hec_indexer_ack_blackhole ingress throughput +0.00 [-0.13, +0.14]
splunk_hec_to_splunk_hec_logs_acks ingress throughput +0.00 [-0.15, +0.15]
splunk_hec_to_splunk_hec_logs_noack ingress throughput -0.04 [-0.16, +0.07]
enterprise_http_to_http ingress throughput -0.09 [-0.16, -0.03]
http_to_http_acks ingress throughput -0.10 [-1.41, +1.20]
syslog_regex_logs2metric_ddmetrics ingress throughput -0.26 [-0.38, -0.13]
datadog_agent_remap_datadog_logs_acks ingress throughput -0.45 [-0.54, -0.37]
http_text_to_http_json ingress throughput -0.48 [-0.60, -0.35]
otlp_grpc_to_blackhole ingress throughput -0.48 [-0.56, -0.39]
syslog_log2metric_humio_metrics ingress throughput -0.65 [-0.76, -0.54]
splunk_hec_route_s3 ingress throughput -0.92 [-1.41, -0.42]
syslog_loki ingress throughput -0.95 [-0.99, -0.91]
syslog_splunk_hec_logs ingress throughput -1.46 [-1.53, -1.39]
file_to_blackhole egress throughput -1.75 [-4.21, +0.71]
syslog_humio_logs ingress throughput -2.22 [-2.30, -2.13]
syslog_log2metric_splunk_hec_metrics ingress throughput -3.16 [-3.31, -3.01]
syslog_log2metric_tag_cardinality_limit_blackhole ingress throughput -3.38 [-3.51, -3.25]

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
Copy link
Contributor

github-actions bot commented Mar 6, 2024

Regression Detector Results

Run ID: 7d70ccb9-df38-431b-ac09-9f8afdba2d00
Baseline: eb30996
Comparison: ea377f0
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
http_text_to_http_json ingress throughput +3.30 [+3.17, +3.44]
otlp_http_to_blackhole ingress throughput +2.45 [+2.29, +2.61]
datadog_agent_remap_blackhole ingress throughput +2.15 [+2.04, +2.26]
syslog_splunk_hec_logs ingress throughput +1.49 [+1.42, +1.55]
syslog_log2metric_splunk_hec_metrics ingress throughput +1.47 [+1.33, +1.61]
socket_to_socket_blackhole ingress throughput +1.11 [+1.04, +1.17]
datadog_agent_remap_datadog_logs_acks ingress throughput +1.00 [+0.92, +1.08]
datadog_agent_remap_blackhole_acks ingress throughput +0.33 [+0.24, +0.42]
syslog_log2metric_humio_metrics ingress throughput +0.32 [+0.18, +0.47]
syslog_log2metric_tag_cardinality_limit_blackhole ingress throughput +0.16 [+0.02, +0.29]
http_to_http_noack ingress throughput +0.14 [+0.05, +0.23]
http_to_http_acks ingress throughput +0.10 [-1.21, +1.42]
http_to_http_json ingress throughput +0.07 [-0.01, +0.15]
splunk_hec_to_splunk_hec_logs_acks ingress throughput -0.00 [-0.15, +0.15]
splunk_hec_indexer_ack_blackhole ingress throughput -0.01 [-0.14, +0.13]
splunk_hec_to_splunk_hec_logs_noack ingress throughput -0.03 [-0.14, +0.09]
splunk_hec_route_s3 ingress throughput -0.07 [-0.59, +0.45]
enterprise_http_to_http ingress throughput -0.12 [-0.20, -0.04]
otlp_grpc_to_blackhole ingress throughput -0.25 [-0.33, -0.17]
fluent_elasticsearch ingress throughput -0.33 [-0.80, +0.14]
http_to_s3 ingress throughput -0.39 [-0.67, -0.11]
syslog_humio_logs ingress throughput -0.39 [-0.51, -0.28]
datadog_agent_remap_datadog_logs ingress throughput -0.47 [-0.58, -0.36]
http_elasticsearch ingress throughput -0.47 [-0.54, -0.40]
syslog_regex_logs2metric_ddmetrics ingress throughput -0.50 [-0.61, -0.38]
syslog_loki ingress throughput -1.82 [-1.89, -1.74]
file_to_blackhole egress throughput -2.07 [-4.46, +0.32]

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 master with commit ea377f0 Mar 6, 2024
@neuronull neuronull deleted the neuronull/component_validation_sinks_datadog_logs_happy branch March 6, 2024 20:53
AndrooTheChen pushed a commit to discord/vector that referenced this pull request Sep 23, 2024
…g_logs` sink (vectordotdev#19887)

* chore(observability): add happy path component spec validation tests for `datadog_logs` sink

* add sad path case
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

domain: observability Anything related to monitoring/observing Vector domain: sinks Anything related to the Vector's sinks domain: sources Anything related to the Vector's sources domain: tests Anything related to Vector's internal tests no-changelog Changes in this PR do not need user-facing explanations in the release changelog sink: datadog_logs Anything `datadog_logs` sink related

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants