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

chore: add integration tests around Serverless ASM #20320

Merged
merged 27 commits into from
Nov 7, 2023

Conversation

RomainMuller
Copy link
Contributor

What does this PR do?

Adds new integration tests around the AWS Lambda Runtime API proxy used for serverless ASM (AWS Lambda), which involves leveraging the AWS_LAMBDA_EXEC_WRAPPER setting with DD_SERVERLESS_APPSEC_ENABLED. This makes function calls simulating AWS API Gateway with a user-agent known to trigger a WAF rule, which should have visible side-effects on the generated traces.

Motivation

This provides minimal regression testing against the Serverless ASM feature.

Additional Notes

Runs on a very simple payload. Might be interesting in the future to test a broader diversity of payloads.

Describe how to test/QA your changes

These are intrinsically test changes.

Reviewer's Checklist

  • If known, an appropriate milestone has been selected; otherwise the Triage milestone is set.
  • Use the major_change label if your change either has a major impact on the code base, is impacting multiple teams or is changing important well-established internals of the Agent. This label will be use during QA to make sure each team pay extra attention to the changed behavior. For any customer facing change use a releasenote.
  • A release note has been added or the changelog/no-changelog label has been applied.
  • Changed code has automated tests for its functionality.
  • Adequate QA/testing plan information is provided if the qa/skip-qa label is not applied.
  • At least one team/.. label has been applied, indicating the team(s) that should QA this change.
  • If applicable, docs team has been notified or an issue has been opened on the documentation repo.
  • If applicable, the need-change/operator and need-change/helm labels have been applied.
  • If applicable, the k8s/<min-version> label, indicating the lowest Kubernetes version compatible with this feature.
  • If applicable, the config template has been updated.

Adds new integration tests around the AWS Lambda Runtime API proxy used
for serverless ASM (AWS Lambda), which involves leveraging the
`AWS_LAMBDA_EXEC_WRAPPER` setting with `DD_SERVERLESS_APPSEC_ENABLED`.
This makes function calls simulating AWS API Gateway with a user-agent
known to trigger a WAF rule, which should have visible side-effects on
the generated traces.
@RomainMuller RomainMuller added changelog/no-changelog [deprecated] qa/skip-qa - use other qa/ labels [DEPRECATED] Please use qa/done or qa/no-code-change to skip creating a QA card team/agent-appsec labels Oct 23, 2023
@RomainMuller RomainMuller added this to the 7.50.0 milestone Oct 23, 2023
@RomainMuller
Copy link
Contributor Author

The Go flavor is specifically blocked on DataDog/datadog-lambda-go#143

@pr-commenter
Copy link

pr-commenter bot commented Oct 23, 2023

Bloop Bleep... Dogbot Here

Regression Detector Results

Run ID: 65d0c0d5-67b3-4bf1-beb0-60cf2d658664
Baseline: 115b9ba
Comparison: 151758e
Total datadog-agent CPUs: 7

Explanation

A regression test is an integrated performance test for datadog-agent in a repeatable rig, with varying configuration for datadog-agent. What follows is a statistical summary of a brief datadog-agent run for each configuration across SHAs given above. The goal of these tests are to determine quickly if datadog-agent performance is changed and to what degree by a pull request.

Because a target's optimization goal performance in each experiment will vary somewhat each time it is run, we can only estimate mean differences in optimization goal relative to the baseline target. We express these differences as a percentage change relative to the baseline target, denoted "Δ mean %". These estimates are made to a precision that balances accuracy and cost control. We represent this precision as a 90.00% confidence interval denoted "Δ mean % CI": there is a 90.00% chance that the true value of "Δ mean %" is in that interval.

We decide whether a change in performance is a "regression" -- a change worth investigating further -- if both of the following two criteria are true:

  1. The estimated |Δ mean %| ≥ 5.00%. This criterion intends to answer the question "Does the estimated change in mean optimization goal performance have a meaningful impact on your customers?". We assume that when |Δ mean %| < 5.00%, the impact on your customers is not meaningful. We also assume that a performance change in optimization goal is worth investigating whether it is an increase or decrease, so long as the magnitude of the change is sufficiently large.

  2. Zero is not in the 90.00% confidence interval "Δ mean % CI" about "Δ mean %". This statement is equivalent to saying that there is at least a 90.00% chance that the mean difference in optimization goal is not zero. This criterion intends to answer the question, "Is there a statistically significant difference in mean optimization goal performance?". It also means there is no more than a 10.00% chance this criterion reports a statistically significant difference when the true difference in mean optimization goal is zero -- a "false positive". We assume you are willing to accept a 10.00% chance of inaccurately detecting a change in performance when no true difference exists.

The table below, if present, lists those experiments that have experienced a statistically significant change in mean optimization goal performance between baseline and comparison SHAs with 90.00% confidence OR have been detected as newly erratic. Negative values of "Δ mean %" mean that baseline is faster, whereas positive values of "Δ mean %" mean that comparison is faster. Results that do not exhibit more than a ±5.00% change in their mean optimization goal are discarded. An experiment is erratic if its coefficient of variation is greater than 0.1. The abbreviated table will be omitted if no interesting change is observed.

No interesting changes in experiment optimization goals with confidence ≥ 90.00% and |Δ mean %| ≥ 5.00%.

Fine details of change detection per experiment.
experiment goal Δ mean % Δ mean % CI confidence
process_agent_real_time_mode egress throughput +0.42 [-2.10, +2.94] 21.82%
tcp_syslog_to_blackhole ingress throughput +0.26 [+0.13, +0.39] 99.90%
file_tree egress throughput +0.20 [-1.65, +2.05] 14.33%
process_agent_standard_check_with_stats egress throughput +0.15 [-1.86, +2.16] 10.00%
otel_to_otel_logs ingress throughput +0.15 [-1.45, +1.75] 12.28%
trace_agent_msgpack ingress throughput +0.03 [-0.10, +0.16] 30.25%
uds_dogstatsd_to_api ingress throughput +0.02 [-0.16, +0.20] 12.60%
tcp_dd_logs_filter_exclude ingress throughput +0.00 [-0.07, +0.07] 6.77%
dogstatsd_string_interner_128MiB_1k ingress throughput +0.00 [-0.14, +0.14] 2.38%
dogstatsd_string_interner_8MiB_100 ingress throughput +0.00 [-0.13, +0.13] 1.58%
dogstatsd_string_interner_64MiB_1k ingress throughput +0.00 [-0.13, +0.13] 1.14%
dogstatsd_string_interner_64MiB_100 ingress throughput +0.00 [-0.14, +0.14] 0.52%
dogstatsd_string_interner_128MiB_100 ingress throughput +0.00 [-0.14, +0.14] 0.13%
trace_agent_json ingress throughput -0.00 [-0.13, +0.13] 1.13%
dogstatsd_string_interner_8MiB_1k ingress throughput -0.00 [-0.11, +0.10] 5.40%
dogstatsd_string_interner_8MiB_100k ingress throughput -0.01 [-0.06, +0.05] 19.48%
dogstatsd_string_interner_8MiB_10k ingress throughput -0.01 [-0.05, +0.04] 25.33%
idle egress throughput -0.03 [-2.48, +2.42] 1.56%
dogstatsd_string_interner_8MiB_50k ingress throughput -0.03 [-0.11, +0.04] 52.37%
file_to_blackhole egress throughput -0.12 [-0.56, +0.33] 33.28%
process_agent_standard_check egress throughput -0.12 [-3.66, +3.41] 4.58%

@RomainMuller RomainMuller force-pushed the romain.marcadier/appsec-integ-tests/APPSEC-11221 branch from 07759c5 to 4118cc7 Compare October 24, 2023 10:11
@RomainMuller RomainMuller marked this pull request as ready for review October 24, 2023 13:29
@RomainMuller RomainMuller requested a review from a team as a code owner October 24, 2023 13:29

if args.logs.startswith('file:'):
with open(args.logs[5:], 'r') as f:
args.logs = f.read()
Copy link
Contributor

Choose a reason for hiding this comment

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

Great addition!

Copy link
Contributor

@purple4reina purple4reina left a comment

Choose a reason for hiding this comment

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

Splitting these tests into a test matrix and running them in parallel is something we've been wanting to do for a long time. Thanks so much for all these great updates!

@RomainMuller RomainMuller merged commit 9ebe041 into main Nov 7, 2023
143 checks passed
@RomainMuller RomainMuller deleted the romain.marcadier/appsec-integ-tests/APPSEC-11221 branch November 7, 2023 12:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog/no-changelog [deprecated] qa/skip-qa - use other qa/ labels [DEPRECATED] Please use qa/done or qa/no-code-change to skip creating a QA card team/agent-appsec
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants