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

Merge software definitions for integration installation for py2 and py3 #21041

Merged
merged 1 commit into from
Nov 29, 2023

Conversation

alopezz
Copy link
Contributor

@alopezz alopezz commented Nov 22, 2023

What does this PR do?

Proposes a way in which we could avoid duplication between the two existing definitions for installing Python integrations (and their dependencies).

Motivation

Both software definitions are nearly identical. That's a lot of duplication, which we try to painstakingly keep in sync by hand. Any further improvement that we might want to do to these recipes needs to be done in both recipes with a lot of care.

Additional Notes

For review, diff the new definition with the old py2 and py3 definitions.

Possible Drawbacks / Trade-offs

  • Not sure how or if this might affect caching mechanisms or other.

Describe how to test/QA your changes

  • Test that a bunch of integrations work as expected.
  • Confirm that files are copied where expected and that files that we delete are actually deleted, and any other expected outcomes from the affected definition.

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.

@alopezz alopezz force-pushed the alopez/omnibus/merge-py2-py3-definitions branch 2 times, most recently from c0f59c0 to b28fc3d Compare November 22, 2023 19:23
@pr-commenter
Copy link

pr-commenter bot commented Nov 22, 2023

Bloop Bleep... Dogbot Here

Regression Detector Results

Run ID: be268b2f-6c81-4b44-9300-882b27ef2cc6
Baseline: 25d28bc
Comparison: 00f8f2c
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
tcp_syslog_to_blackhole ingress throughput +0.63 [+0.50, +0.76] 100.00%
file_tree egress throughput +0.41 [-1.39, +2.22] 29.34%
idle egress throughput +0.21 [-2.15, +2.57] 11.71%
trace_agent_msgpack ingress throughput +0.05 [-0.07, +0.17] 51.55%
trace_agent_json ingress throughput +0.03 [-0.10, +0.16] 31.63%
uds_dogstatsd_to_api ingress throughput +0.01 [-0.16, +0.18] 9.69%
dogstatsd_string_interner_8MiB_1k ingress throughput +0.00 [-0.10, +0.10] 2.77%
dogstatsd_string_interner_128MiB_1k ingress throughput +0.00 [-0.14, +0.14] 0.24%
dogstatsd_string_interner_64MiB_100 ingress throughput +0.00 [-0.14, +0.14] 0.23%
dogstatsd_string_interner_128MiB_100 ingress throughput -0.00 [-0.14, +0.14] 0.00%
dogstatsd_string_interner_8MiB_10k ingress throughput -0.00 [-0.02, +0.02] 13.38%
dogstatsd_string_interner_64MiB_1k ingress throughput -0.00 [-0.13, +0.13] 2.57%
dogstatsd_string_interner_8MiB_100k ingress throughput -0.01 [-0.06, +0.05] 14.08%
file_to_blackhole egress throughput -0.01 [-1.03, +1.01] 1.42%
dogstatsd_string_interner_8MiB_100 ingress throughput -0.01 [-0.14, +0.12] 11.89%
dogstatsd_string_interner_8MiB_50k ingress throughput -0.01 [-0.07, +0.04] 30.05%
tcp_dd_logs_filter_exclude ingress throughput -0.02 [-0.15, +0.11] 19.08%
otel_to_otel_logs ingress throughput -0.22 [-1.79, +1.35] 18.25%

@alopezz alopezz added this to the Triage milestone Nov 23, 2023
@alopezz alopezz force-pushed the alopez/omnibus/merge-py2-py3-definitions branch 4 times, most recently from e11d0ef to 68887b6 Compare November 23, 2023 16:25
@alopezz alopezz marked this pull request as ready for review November 24, 2023 08:51
@alopezz alopezz requested review from a team as code owners November 24, 2023 08:51
Copy link
Contributor

@chouquette chouquette left a comment

Choose a reason for hiding this comment

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

very nice proposal!

end

if with_python_runtime? "3"
dependency 'datadog-agent-integrations-py3'
if with_python_runtime? "3" or with_python_runtime? "2"
Copy link
Contributor

Choose a reason for hiding this comment

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

Is there a case where the overall condition is false?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Don't we have Python-less Agent builds? e.g. iot builds.

Copy link
Contributor

Choose a reason for hiding this comment

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

Indeed, but this flavor is in the iot-agent project so it should not be an issue for this file

That being said this was mostly a nit/check and definitely not a blocking comment

Copy link
Contributor Author

Choose a reason for hiding this comment

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

In practice it doesn't make a big difference, since this condition is also checked in the loop inside datadog-agent-integrations.rb, so if any of these conditions are actually not met, that definition would run but do pretty much nothing. At any rate, this came to be as a straightforward attempt to maintain the semantics of the original bit of code it replaces.


gcc_version = ENV['GCC_VERSION']
if gcc_version.nil? || gcc_version.empty?
gcc_version = '10.4.0'
Copy link
Contributor

Choose a reason for hiding this comment

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

GCC_VERSION is set in the docker images when we build GCC. If it isn't set, then only the distribution provided gcc (4.x IIRC) is available.

I'd expect that defaulting to 10.4.0 would fail (but isn't actually used)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm not familiar with the context under which this was introduced, but interestingly, only the py3 definition had this reference to choosing the gcc_version, the py2 didn't.

It's only referenced here:

# We only have gcc 10.4.0 on linux for now
if linux_target?
nix_build_env["CC"] = "/opt/gcc-#{gcc_version}/bin/gcc"
nix_build_env["CXX"] = "/opt/gcc-#{gcc_version}/bin/g++"
end

Copy link
Member

Choose a reason for hiding this comment

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks @FlorentClarret for the context. Anyhow this just keeps what the py3 definition already had, so should there be anything to address here I think it would have to be separate work.

Copy link
Contributor

Choose a reason for hiding this comment

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

Fine by me

@alopezz alopezz force-pushed the alopez/omnibus/merge-py2-py3-definitions branch from 68887b6 to 7919422 Compare November 29, 2023 09:25
@alopezz alopezz force-pushed the alopez/omnibus/merge-py2-py3-definitions branch from 7919422 to 00f8f2c Compare November 29, 2023 10:50
@alopezz alopezz merged commit c581546 into main Nov 29, 2023
154 of 155 checks passed
@alopezz alopezz deleted the alopez/omnibus/merge-py2-py3-definitions branch November 29, 2023 13:55
KSerrania added a commit that referenced this pull request Nov 29, 2023
KSerrania added a commit that referenced this pull request Nov 29, 2023
…y2 and py3 (#21041)" (#21184)

This reverts commit c581546. It broke Agent 6 builds on ARM Linux.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants