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

[e2e] create a session output directory per TestSuite session #32536

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

pducolin
Copy link
Contributor

@pducolin pducolin commented Dec 27, 2024

What does this PR do?

Refactor the session output directory management, centralising it inside the base e2e suite. Root output directory creation is delegated to the runner.profile, that is aware of running on the CI or locally.

This PR also reduces dependencies to e2e package out of itself, moving common code to common package

Motivation

Refactoring required to implement Diagnosable interface for Host environment

Describe how you validated your changes

Possible Drawbacks / Trade-offs

Additional Notes

Example of output directories for pre_e2e_tests job

image

As we use suite.T().Name(), suites running from a single TestXXX will all end up with the same output dir prefix TestXXX, we might want to add the suite name to ease identifying each suite's session, might change it in a follow up

@pducolin pducolin added changelog/no-changelog qa/no-code-change No code change in Agent code requiring validation labels Dec 27, 2024
@pducolin pducolin requested review from a team as code owners December 27, 2024 11:06
@github-actions github-actions bot added the long review PR is complex, plan time to review it label Dec 27, 2024
@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Dec 27, 2024

Test changes on VM

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

inv aws.create-vm --pipeline-id=51843632 --os-family=ubuntu

Note: This applies to commit df2f7be

@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Dec 27, 2024

[Fast Unit Tests Report]

On pipeline 51843632 (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

@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Dec 27, 2024

Uncompressed package size comparison

Comparison with ancestor 237b1f2a08434387e1a22e5e42cecabead23c543

Diff per package
package diff status size ancestor threshold
datadog-agent-aarch64-rpm 0.01MB ⚠️ 944.70MB 944.69MB 140.00MB
datadog-agent-arm64-deb 0.01MB ⚠️ 935.40MB 935.39MB 140.00MB
datadog-dogstatsd-amd64-deb 0.00MB 78.57MB 78.57MB 10.00MB
datadog-dogstatsd-arm64-deb 0.00MB 55.77MB 55.77MB 10.00MB
datadog-heroku-agent-amd64-deb 0.00MB 505.27MB 505.27MB 70.00MB
datadog-iot-agent-amd64-deb 0.00MB 113.35MB 113.35MB 10.00MB
datadog-iot-agent-arm64-deb 0.00MB 108.81MB 108.81MB 10.00MB
datadog-dogstatsd-x86_64-rpm -0.00MB 78.65MB 78.65MB 10.00MB
datadog-dogstatsd-x86_64-suse -0.00MB 78.65MB 78.65MB 10.00MB
datadog-iot-agent-x86_64-rpm -0.00MB 113.42MB 113.42MB 10.00MB
datadog-iot-agent-x86_64-suse -0.00MB 113.42MB 113.42MB 10.00MB
datadog-iot-agent-aarch64-rpm -0.00MB 108.88MB 108.88MB 10.00MB
datadog-agent-amd64-deb -0.01MB 1191.09MB 1191.10MB 140.00MB
datadog-agent-x86_64-rpm -0.01MB 1200.40MB 1200.42MB 140.00MB
datadog-agent-x86_64-suse -0.01MB 1200.40MB 1200.42MB 140.00MB

Decision

⚠️ Warning

Copy link

cit-pr-commenter bot commented Dec 27, 2024

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: 9b368f82-716d-402a-9e91-a9dfda55eddc

Baseline: 237b1f2
Comparison: df2f7be
Diff

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
quality_gate_logs % cpu utilization +2.54 [-0.72, +5.80] 1 Logs
uds_dogstatsd_to_api_cpu % cpu utilization +1.11 [+0.42, +1.80] 1 Logs
file_to_blackhole_0ms_latency_http1 egress throughput +0.19 [-0.70, +1.09] 1 Logs
file_tree memory utilization +0.09 [-0.04, +0.22] 1 Logs
file_to_blackhole_500ms_latency egress throughput +0.05 [-0.72, +0.82] 1 Logs
file_to_blackhole_300ms_latency egress throughput +0.02 [-0.63, +0.66] 1 Logs
uds_dogstatsd_to_api ingress throughput +0.00 [-0.11, +0.11] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput -0.00 [-0.01, +0.01] 1 Logs
file_to_blackhole_100ms_latency egress throughput -0.01 [-0.72, +0.71] 1 Logs
file_to_blackhole_0ms_latency_http2 egress throughput -0.01 [-0.95, +0.93] 1 Logs
quality_gate_idle memory utilization -0.08 [-0.11, -0.04] 1 Logs bounds checks dashboard
file_to_blackhole_0ms_latency egress throughput -0.09 [-0.96, +0.78] 1 Logs
quality_gate_idle_all_features memory utilization -0.31 [-0.39, -0.23] 1 Logs bounds checks dashboard
tcp_syslog_to_blackhole ingress throughput -0.46 [-0.52, -0.40] 1 Logs
file_to_blackhole_1000ms_latency egress throughput -0.56 [-1.35, +0.23] 1 Logs
file_to_blackhole_1000ms_latency_linear_load egress throughput -0.62 [-1.08, -0.16] 1 Logs

Bounds Checks: ❌ Failed

perf experiment bounds_check_name replicates_passed links
file_to_blackhole_0ms_latency lost_bytes 8/10
file_to_blackhole_0ms_latency memory_usage 10/10
file_to_blackhole_0ms_latency_http1 lost_bytes 10/10
file_to_blackhole_0ms_latency_http1 memory_usage 10/10
file_to_blackhole_0ms_latency_http2 lost_bytes 10/10
file_to_blackhole_0ms_latency_http2 memory_usage 10/10
file_to_blackhole_1000ms_latency memory_usage 10/10
file_to_blackhole_1000ms_latency_linear_load memory_usage 10/10
file_to_blackhole_100ms_latency lost_bytes 10/10
file_to_blackhole_100ms_latency memory_usage 10/10
file_to_blackhole_300ms_latency lost_bytes 10/10
file_to_blackhole_300ms_latency memory_usage 10/10
file_to_blackhole_500ms_latency lost_bytes 10/10
file_to_blackhole_500ms_latency memory_usage 10/10
quality_gate_idle memory_usage 10/10 bounds checks dashboard
quality_gate_idle_all_features memory_usage 10/10 bounds checks dashboard
quality_gate_logs lost_bytes 10/10
quality_gate_logs memory_usage 10/10

Explanation

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

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

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

CI Pass/Fail Decision

Passed. All Quality Gates passed.

  • quality_gate_idle, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check lost_bytes: 10/10 replicas passed. Gate passed.
  • quality_gate_idle_all_features, bounds check memory_usage: 10/10 replicas passed. Gate passed.

@pducolin pducolin force-pushed the pducolin/ADXT-354-part3-refactor-suite-utils-to-common branch 2 times, most recently from 90d1dc3 to 2200dd8 Compare December 27, 2024 12:06
Copy link
Member

@FlorentClarret FlorentClarret left a comment

Choose a reason for hiding this comment

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

👍 I just left two tiny questions

Comment on lines +186 to +187
parentDir := filepath.Dir(fullPath)
finalDir := filepath.Base(fullPath)
Copy link
Member

Choose a reason for hiding this comment

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

❓ stupid question: isn't parentDir the same as rootOutputDir and finalDir the same as subdirectory in this context? I guess my question is: why do we need to build fullPath?‏

Copy link
Contributor Author

@pducolin pducolin Dec 27, 2024

Choose a reason for hiding this comment

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

No question is stupid!

It depends on the passed subdirectory. As the current code uses the go test name, that contains path separators, and we don't sanitize them, we end up potentially with fullPath that is composed of

  • the output directory e2e-output
  • the suite session directory <suite_name>_<suite.startTime>
    The suite name can contain / if it is defined in a subfolder, for example this one from installer suite

I need to first build the parent directory, meaning all the path except the final directory, that will be a temporary one. This is to keep compatibility with current directory structure used in Windows tests: I would remove the session and temporary path for CI runs, as there is one session per job. This was implemented to ease local runs.

test/new-e2e/pkg/runner/local_profile.go Outdated Show resolved Hide resolved
Remove not needed CreateTestSession dir function, centralise session output dir creation within a suite
@pducolin pducolin force-pushed the pducolin/ADXT-354-part3-refactor-suite-utils-to-common branch from 2200dd8 to df2f7be Compare December 27, 2024 13:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog/no-changelog long review PR is complex, plan time to review it qa/no-code-change No code change in Agent code requiring validation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants