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

Add OTel Agent e2e pipeline tests #29091

Merged
merged 58 commits into from
Oct 4, 2024
Merged

Conversation

liustanley
Copy link
Contributor

@liustanley liustanley commented Sep 5, 2024

What does this PR do?

This PR adds e2e pipeline tests for the OTel Agent and refactors the file structure of new-e2e/tests/otel according to our testing plan.

These tests use four different collector config files:

  • complete.yml for a complete config file to use with the converter disabled
  • minimal.yml for a minimal config file to test that the converter adds components as expected
  • sampling.yml for adding the probabilistic sampler and verifying APM stats still work
  • ia.yml for a minimal config file to test the infra attributes processor with high cardinality

The following test cases are implemented in utils/pipelines_utils.go:

  • Verify fakeintake receives scraped prometheus metrics: collector metrics, trace agent metrics, and agent metrics
  • Verify fakeintake receives telemetry from telemetrygen
    • Resource attributes are tagged as expected
    • Telemetry attributes are tagged as expected
    • Infraattributesprocessor adds kubernetes tags as expected
    • Service, env, and version tags appear as expected
    • Host appears as expected and consistent across all signals
    • Trace metrics are received by fakeintake
  • Verify trace metrics work with sampling as expected

Motivation

Additional Notes

The non-pipeline tests have been moved to utils/config_utils.go, and will be expanded on in a future PR for adding extensive config tests.

Possible Drawbacks / Trade-offs

Describe how to test/QA your changes

@github-actions github-actions bot added the team/opentelemetry OpenTelemetry team label Sep 5, 2024
@pr-commenter
Copy link

pr-commenter bot commented Sep 5, 2024

Test changes on VM

Use this command from test-infra-definitions to manually test this PR changes on a VM:

inv create-vm --pipeline-id=45789683 --os-family=ubuntu

Note: This applies to commit 455ea29

@pr-commenter
Copy link

pr-commenter bot commented Sep 5, 2024

Regression Detector

Regression Detector Results

Run ID: c24df7ae-a0fb-463c-9c9c-b6f2da331599 Metrics dashboard Target profiles

Baseline: b9c2f34
Comparison: d183c15

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 trials links
file_tree memory utilization +1.28 [+1.17, +1.39] 1 Logs
tcp_syslog_to_blackhole ingress throughput +1.05 [+1.00, +1.10] 1 Logs
idle memory utilization +0.42 [+0.38, +0.47] 1 Logs
pycheck_lots_of_tags % cpu utilization +0.28 [-2.12, +2.67] 1 Logs
uds_dogstatsd_to_api_cpu % cpu utilization +0.14 [-0.60, +0.87] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput -0.00 [-0.01, +0.01] 1 Logs
basic_py_check % cpu utilization -0.01 [-2.67, +2.64] 1 Logs
uds_dogstatsd_to_api ingress throughput -0.01 [-0.12, +0.09] 1 Logs
idle_all_features memory utilization -0.59 [-0.67, -0.50] 1 Logs
otel_to_otel_logs ingress throughput -1.01 [-1.81, -0.21] 1 Logs

Bounds Checks

perf experiment bounds_check_name replicates_passed
idle memory_usage 10/10

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

@liustanley liustanley changed the title WIP Stanley.liu/otel e2e pipelines Add OTel Agent e2e pipeline tests Sep 10, 2024
@liustanley liustanley added changelog/no-changelog qa/no-code-change No code change in Agent code requiring validation labels Sep 10, 2024
@liustanley liustanley marked this pull request as ready for review September 10, 2024 20:47
@liustanley liustanley requested a review from a team as a code owner September 10, 2024 20:47
@liustanley liustanley added this to the 7.59.0 milestone Sep 10, 2024
Copy link
Member

@dineshg13 dineshg13 left a comment

Choose a reason for hiding this comment

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

We also need to test infra attributes processor with different cardinalities

test/new-e2e/tests/otel/otel-agent/config/sampling.yml Outdated Show resolved Hide resolved
test/new-e2e/tests/otel/utils/config_utils.go Show resolved Hide resolved
test/new-e2e/tests/otel/utils/pipelines_utils.go Outdated Show resolved Hide resolved
@liustanley liustanley marked this pull request as ready for review October 3, 2024 14:18
@liustanley liustanley requested review from a team as code owners October 3, 2024 14:18
Copy link
Member

@KevinFairise2 KevinFairise2 left a comment

Choose a reason for hiding this comment

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

Some suggestions to avoid panic when accessing empty array. But otherwise lgtm!

test/new-e2e/tests/otel/utils/pipelines_utils.go Outdated Show resolved Hide resolved
test/new-e2e/tests/otel/utils/pipelines_utils.go Outdated Show resolved Hide resolved
test/new-e2e/tests/otel/utils/pipelines_utils.go Outdated Show resolved Hide resolved
test/new-e2e/tests/otel/utils/pipelines_utils.go Outdated Show resolved Hide resolved
@liustanley liustanley removed the request for review from a team October 3, 2024 14:24
@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Oct 3, 2024

[Fast Unit Tests Report]

On pipeline 45854855 (CI Visibility). The following jobs did not run any unit tests:

Jobs:
  • tests_windows-x64

If you modified Go files and expected unit tests to run in these jobs, please double check the job logs. If you think tests should have been executed reach out to #agent-devx-help

Copy link
Member

@dineshg13 dineshg13 left a comment

Choose a reason for hiding this comment

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

LGTM . There few things we can handle in next iterations

  1. Use Yaml strings for defining deployments
  2. Can we extract code and create some common utils esp complete_test.go & infraatributes_test.go , etc have most common code

test/new-e2e/tests/otel/utils/pipelines_utils.go Outdated Show resolved Hide resolved
@liustanley
Copy link
Contributor Author

/merge

@dd-devflow
Copy link

dd-devflow bot commented Oct 4, 2024

🚂 MergeQueue: pull request added to the queue

The median merge time in main is 23m.

Use /merge -c to cancel this operation!

@dd-mergequeue dd-mergequeue bot merged commit 32909d7 into main Oct 4, 2024
406 of 408 checks passed
@dd-mergequeue dd-mergequeue bot deleted the stanley.liu/otel-e2e-pipelines branch October 4, 2024 18:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog/no-changelog qa/no-code-change No code change in Agent code requiring validation team/opentelemetry OpenTelemetry team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants