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

Fix Persistent Integrations for RPM packages #32765

Merged
merged 8 commits into from
Jan 14, 2025

Conversation

jose-manuel-almaza
Copy link
Contributor

@jose-manuel-almaza jose-manuel-almaza commented Jan 8, 2025

What does this PR do?

Fix a bug discovered in the generated RPM package related to the execution order of scripts during the installation/upgrade process.

Motivation

The order of execution of the different package manager scripts is not the same for all of them.
The order in which these scripts are executed varies between APT and YUM which can
lead to some rather sneaky bugs. Here's the standard order for updates.

APT
https://debian-handbook.info/browse/stable/sect.package-meta-information.html

  • prerm script of the old package (with arguments: upgrade <new-version>)
  • preinst script of the new package (with arguments: upgrade <old-version>)
  • New files get unpacked based on the file list embedded in the .deb package
  • postrm script from the old package (with arguments upgrade <new-version>)
  • dpkg updates the files list, removes the files that don't exist anymore, etc.
  • postinst of the new script is run (with arguments configure <lst-configured-version>

YUM
https://fedoraproject.org/wiki/Packaging:Scriptlets

  • pretrans of new package
  • preinst of new package
  • Files in the list get copied
  • postinst of new package
  • prerm of old package
  • Files in the old package file list that are not in the new one's get removed
  • postrm of the old package gets run
  • posttrans of the new package is run

Describe how you validated your changes

Create a virtual machine with an operating system that works with yum (rpm packages). In our tests we used a virtual machine created in GCP with Centos9.

Install 7.60: DD_AGENT_MAJOR_VERSION=7 DD_AGENT_MINOR_VERSION=60 DD_API_KEY=00000000000000000000000000000000 DD_HOSTNAME=my-hostname bash -c "$(curl -L https://s3.amazonaws.com/dd-agent/scripts/install_script_agent7.sh)"

Install datadog-ping integration: sudo datadog-agent integration install -t datadog-ping==1.0.1 -r

Upgrade to PR's package: TESTING_YUM_URL=yumtesting.datad0g.com TESTING_YUM_VERSION_PATH="testing/pipeline-<PIPELINE_ID>-a7/7" DD_API_KEY=00000000000000000000000000000000 DD_SITE="datadoghq.com" DD_HOSTNAME=my-hostname bash -c "$(curl -L https://s3.amazonaws.com/dd-agent/scripts/install_script_agent7.sh)"

Check datadog-ping has been installed: /opt/datadog-agent/embedded/bin/pip list | grep datadog-ping

Possible Drawbacks / Trade-offs

Additional Notes

@github-actions github-actions bot added medium review PR review might take time team/agent-delivery labels Jan 8, 2025
@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Jan 8, 2025

Uncompressed package size comparison

Comparison with ancestor 159157e87a97f7476c6d8a81016ae1facf8f1c46

Diff per package
package diff status size ancestor threshold
datadog-agent-x86_64-rpm 0.00MB 1013.84MB 1013.84MB 0.50MB
datadog-agent-x86_64-suse 0.00MB 1013.84MB 1013.84MB 0.50MB
datadog-agent-aarch64-rpm 0.00MB 997.77MB 997.77MB 0.50MB
datadog-agent-amd64-deb 0.00MB 1004.52MB 1004.52MB 0.50MB
datadog-agent-arm64-deb 0.00MB 988.47MB 988.47MB 0.50MB
datadog-dogstatsd-amd64-deb 0.00MB 58.83MB 58.83MB 0.50MB
datadog-dogstatsd-x86_64-rpm 0.00MB 58.90MB 58.90MB 0.50MB
datadog-dogstatsd-x86_64-suse 0.00MB 58.90MB 58.90MB 0.50MB
datadog-dogstatsd-arm64-deb 0.00MB 56.33MB 56.33MB 0.50MB
datadog-heroku-agent-amd64-deb 0.00MB 532.27MB 532.27MB 0.50MB
datadog-iot-agent-amd64-deb 0.00MB 93.85MB 93.85MB 0.50MB
datadog-iot-agent-x86_64-rpm 0.00MB 93.92MB 93.92MB 0.50MB
datadog-iot-agent-x86_64-suse 0.00MB 93.92MB 93.92MB 0.50MB
datadog-iot-agent-arm64-deb 0.00MB 89.91MB 89.91MB 0.50MB
datadog-iot-agent-aarch64-rpm 0.00MB 89.98MB 89.98MB 0.50MB

Decision

✅ Passed

@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Jan 8, 2025

[Fast Unit Tests Report]

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

Jobs:
  • tests_deb-arm64-py3
  • tests_deb-x64-py3
  • tests_flavor_dogstatsd_deb-x64
  • tests_flavor_heroku_deb-x64
  • tests_flavor_iot_deb-x64
  • tests_rpm-arm64-py3
  • tests_rpm-x64-py3
  • 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 Jan 8, 2025

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=52824912 --os-family=ubuntu

Note: This applies to commit c51485c

Copy link

cit-pr-commenter bot commented Jan 8, 2025

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: 4480d5e8-b633-4b12-b18c-87af106e5c50

Baseline: 159157e
Comparison: c51485c
Diff

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
tcp_syslog_to_blackhole ingress throughput +0.47 [+0.39, +0.55] 1 Logs
file_tree memory utilization +0.44 [+0.29, +0.59] 1 Logs
file_to_blackhole_500ms_latency egress throughput +0.29 [-0.49, +1.07] 1 Logs
file_to_blackhole_0ms_latency egress throughput +0.08 [-0.81, +0.96] 1 Logs
file_to_blackhole_0ms_latency_http1 egress throughput +0.00 [-0.83, +0.84] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput -0.00 [-0.01, +0.01] 1 Logs
file_to_blackhole_300ms_latency egress throughput -0.00 [-0.64, +0.64] 1 Logs
uds_dogstatsd_to_api ingress throughput -0.01 [-0.10, +0.08] 1 Logs
file_to_blackhole_100ms_latency egress throughput -0.05 [-0.72, +0.63] 1 Logs
file_to_blackhole_1000ms_latency_linear_load egress throughput -0.06 [-0.52, +0.41] 1 Logs
file_to_blackhole_0ms_latency_http2 egress throughput -0.06 [-0.93, +0.81] 1 Logs
quality_gate_idle memory utilization -0.14 [-0.18, -0.10] 1 Logs bounds checks dashboard
quality_gate_idle_all_features memory utilization -0.19 [-0.28, -0.11] 1 Logs bounds checks dashboard
uds_dogstatsd_to_api_cpu % cpu utilization -0.19 [-0.90, +0.51] 1 Logs
file_to_blackhole_1000ms_latency egress throughput -0.58 [-1.35, +0.20] 1 Logs
quality_gate_logs % cpu utilization -0.65 [-3.80, +2.50] 1 Logs

Bounds Checks: ✅ Passed

perf experiment bounds_check_name replicates_passed links
file_to_blackhole_0ms_latency lost_bytes 10/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_logs, bounds check lost_bytes: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_idle_all_features, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_idle, bounds check memory_usage: 10/10 replicas passed. Gate passed.

@jose-manuel-almaza jose-manuel-almaza added the qa/done QA done before merge and regressions are covered by tests label Jan 9, 2025
@jose-manuel-almaza jose-manuel-almaza marked this pull request as ready for review January 9, 2025 13:45
@jose-manuel-almaza jose-manuel-almaza requested review from a team as code owners January 9, 2025 13:45
@jose-manuel-almaza jose-manuel-almaza requested a review from a team January 9, 2025 13:45
@jose-manuel-almaza jose-manuel-almaza self-assigned this Jan 9, 2025
Copy link
Contributor

@maycmlee maycmlee left a comment

Choose a reason for hiding this comment

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

Just a couple of small suggestions, but approving to not block merge!

@github-actions github-actions bot added long review PR is complex, plan time to review it and removed medium review PR review might take time labels Jan 13, 2025
@jose-manuel-almaza
Copy link
Contributor Author

/merge

@dd-devflow
Copy link

dd-devflow bot commented Jan 13, 2025

Devflow running: /merge

View all feedbacks in Devflow UI.


2025-01-13 15:31:35 UTC ℹ️ MergeQueue: waiting for PR to be ready

This merge request is not mergeable yet, because of pending checks/missing approvals. It will be added to the queue as soon as checks pass and/or get approvals.
Note: if you pushed new commits since the last approval, you may need additional approval.
You can remove it from the waiting list with /remove command.


2025-01-13 19:31:33 UTC ⚠️ MergeQueue: This merge request was unqueued

[email protected] unqueued this merge request: It did not become mergeable within the expected time

@buraizu buraizu self-assigned this Jan 13, 2025
@jose-manuel-almaza
Copy link
Contributor Author

/merge

@dd-devflow
Copy link

dd-devflow bot commented Jan 14, 2025

Devflow running: /merge

View all feedbacks in Devflow UI.


2025-01-14 09:01:05 UTC ℹ️ MergeQueue: pull request added to the queue

The median merge time in main is 35m.


2025-01-14 09:35:18 UTC ℹ️ MergeQueue: This merge request was merged

@dd-mergequeue dd-mergequeue bot merged commit a41ae34 into main Jan 14, 2025
211 checks passed
@dd-mergequeue dd-mergequeue bot deleted the jose/fix_rpm_persistent_ints branch January 14, 2025 09:35
@github-actions github-actions bot added this to the 7.63.0 milestone Jan 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
long review PR is complex, plan time to review it qa/done QA done before merge and regressions are covered by tests team/agent-delivery
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants