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

[ASCII-950] Add test for pkg/status/render #21106

Merged
merged 13 commits into from
Nov 30, 2023
Merged

Conversation

GustavoCaso
Copy link
Member

@GustavoCaso GustavoCaso commented Nov 27, 2023

What does this PR do?

The PR test for the pkg/status/render package.
Previously, a single test checked if the function returned an error.
Now, we test the different render functions and the tests asserted on the expected output format.

Motivation

Provide more confidence to the team when changing the pkg/status, and avoid breaking the output unintentionally.

Additional Notes

While working on the tests, I noticed a few regressions introduced on #20824, so this code is already proving helpful.

Regarding the changes to the process agent code, I plan on refactoring similarly to #21067. I decided not to do it on this PR to avoid increasing the amount of changes on it.

Possible Drawbacks / Trade-offs

Describe how to test/QA your 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.

@pr-commenter
Copy link

pr-commenter bot commented Nov 27, 2023

Bloop Bleep... Dogbot Here

Regression Detector Results

Run ID: c1271158-a5c4-435d-a013-ffa565f1cb59
Baseline: d0d8368
Comparison: aa953d0
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
idle egress throughput +0.22 [-2.25, +2.70] 11.75%
file_to_blackhole egress throughput +0.05 [-0.97, +1.06] 5.98%
uds_dogstatsd_to_api ingress throughput +0.04 [-0.12, +0.21] 33.72%
trace_agent_msgpack ingress throughput +0.03 [-0.10, +0.16] 32.82%
dogstatsd_string_interner_8MiB_50k ingress throughput +0.02 [-0.04, +0.09] 42.89%
trace_agent_json ingress throughput +0.01 [-0.12, +0.14] 10.74%
dogstatsd_string_interner_8MiB_100k ingress throughput +0.01 [-0.04, +0.05] 23.70%
dogstatsd_string_interner_8MiB_100 ingress throughput +0.00 [-0.12, +0.13] 4.32%
dogstatsd_string_interner_8MiB_1k ingress throughput +0.00 [-0.09, +0.10] 4.83%
dogstatsd_string_interner_8MiB_10k ingress throughput +0.00 [-0.07, +0.08] 3.19%
dogstatsd_string_interner_64MiB_100 ingress throughput -0.00 [-0.14, +0.14] 0.16%
dogstatsd_string_interner_128MiB_100 ingress throughput -0.00 [-0.14, +0.14] 0.38%
dogstatsd_string_interner_128MiB_1k ingress throughput -0.00 [-0.14, +0.14] 0.54%
dogstatsd_string_interner_64MiB_1k ingress throughput -0.00 [-0.13, +0.13] 0.77%
tcp_dd_logs_filter_exclude ingress throughput -0.03 [-0.18, +0.12] 25.28%
file_tree egress throughput -0.34 [-2.16, +1.49] 23.90%
tcp_syslog_to_blackhole ingress throughput -0.36 [-0.49, -0.23] 100.00%
otel_to_otel_logs ingress throughput -1.19 [-2.77, +0.38] 78.84%

@GustavoCaso GustavoCaso force-pushed the add-test-for-render-output branch from c46a000 to 61fc133 Compare November 28, 2023 12:44
@GustavoCaso GustavoCaso added this to the 7.51.0 milestone Nov 29, 2023
@GustavoCaso GustavoCaso 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 labels Nov 29, 2023
@GustavoCaso GustavoCaso marked this pull request as ready for review November 29, 2023 14:20
@GustavoCaso GustavoCaso requested review from a team as code owners November 29, 2023 14:20
@@ -139,7 +139,10 @@ func getAndWriteStatus(log log.Component, statusURL string, w io.Writer, options
option(&s)
}

body, err = json.Marshal(s)
status := map[string]interface{}{}
status["processAgentStatus"] = s
Copy link
Member Author

Choose a reason for hiding this comment

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

We have to add the top-level key because the template for process agent change in a previous PR https://github.com/DataDog/datadog-agent/pull/20824/files#diff-5399c03d823d8e2533aa6fc4d1a1f523a999353a481c78c3f1a60cabecad1cbfR8

I'm planning on reusing the existing code of the pkg/status on follow-up PR to DRY the code 😄

@GustavoCaso GustavoCaso changed the title Add test for render output [ASCII-950] Add test for pkg/status/render Nov 29, 2023
Copy link
Member

@robertjli robertjli left a comment

Choose a reason for hiding this comment

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

Approved for processes

@GustavoCaso GustavoCaso merged commit 562e275 into main Nov 30, 2023
158 of 161 checks passed
@GustavoCaso GustavoCaso deleted the add-test-for-render-output branch November 30, 2023 09:38
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-shared-components
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants