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

Don't fail to build the agent locally when system probe is disabled #30901

Merged
merged 9 commits into from
Nov 28, 2024

Conversation

chouquette
Copy link
Contributor

What does this PR do?

Disable system probe build throughout various locations to allow building the agent when --system-probe-bin isn't provided

Motivation

Simplify building the agent locally
https://datadoghq.atlassian.net/browse/BARX-622

Describe how to test/QA your changes

I'm not sure this is worth doing QA, but it can be verified manually by attempting to build the agent on main of before that commit is merged and confirm that if fails, and then with this commit and confirm that it doesn't

Possible Drawbacks / Trade-offs

Additional Notes

@chouquette chouquette added changelog/no-changelog qa/no-code-change No code change in Agent code requiring validation team/agent-delivery labels Nov 8, 2024
@chouquette chouquette requested a review from a team as a code owner November 8, 2024 13:20
@github-actions github-actions bot added the short review PR is simple enough to be reviewed quickly label Nov 8, 2024
@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Nov 8, 2024

[Fast Unit Tests Report]

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

@@ -91,15 +91,17 @@
move "#{install_dir}/etc/datadog-agent/datadog.yaml.example", "#{output_config_dir}/etc/datadog-agent"
move "#{install_dir}/etc/datadog-agent/conf.d", "#{output_config_dir}/etc/datadog-agent", :force=>true
unless heroku_target?
move "#{install_dir}/etc/datadog-agent/system-probe.yaml.example", "#{output_config_dir}/etc/datadog-agent"
if ENV.has_key?('SYSTEM_PROBE_BIN') and not ENV['SYSTEM_PROBE_BIN'].empty?
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggestion:

Suggested change
if ENV.has_key?('SYSTEM_PROBE_BIN') and not ENV['SYSTEM_PROBE_BIN'].empty?
if ENV.fetch("SYSTEM_PROBE_BIN", "").empty?

doc

Would it be worth turning this condition into a function?

Copy link
Contributor

Choose a reason for hiding this comment

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

As an aside, the conditionals on top of this (if linux_target? and unless heroku_target? seem to be yet another repetition of the condition that I referred to on the other review comment.

@@ -144,7 +144,8 @@
end

# System-probe
sysprobe_support = (not heroku_target?) && (linux_target? || (windows_target? && do_windows_sysprobe != ""))
sysprobe_support = (not heroku_target?) && (linux_target? || (windows_target? && do_windows_sysprobe != "")) &&
Copy link
Contributor

Choose a reason for hiding this comment

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

Not related to your change, but interestingly a similar condition is defined here:

if linux_target? && !heroku_target?

Would it make sense to take this opportunity to refactor this by moving all the section under if sysprobe_support to the system_probe definition? That would drastically reduce the proliferation of these conditions that need to be repeated in several places.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That seems like a fair suggestion, I'll do the change :)

@github-actions github-actions bot added medium review PR review might take time and removed short review PR is simple enough to be reviewed quickly labels Nov 8, 2024
Copy link

cit-pr-commenter bot commented Nov 8, 2024

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: 23aff3e2-80f2-41c9-9947-8af8ce762f8d

Baseline: 7e3f609
Comparison: 57176ab
Diff

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
basic_py_check % cpu utilization +1.50 [-2.34, +5.34] 1 Logs
file_tree memory utilization +0.49 [+0.35, +0.63] 1 Logs
tcp_syslog_to_blackhole ingress throughput +0.48 [+0.41, +0.55] 1 Logs
quality_gate_idle_all_features memory utilization +0.44 [+0.35, +0.53] 1 Logs bounds checks dashboard
quality_gate_idle memory utilization +0.31 [+0.26, +0.35] 1 Logs bounds checks dashboard
uds_dogstatsd_to_api_cpu % cpu utilization +0.30 [-0.43, +1.02] 1 Logs
otel_to_otel_logs ingress throughput +0.23 [-0.47, +0.92] 1 Logs
file_to_blackhole_300ms_latency egress throughput +0.19 [-0.44, +0.82] 1 Logs
file_to_blackhole_1000ms_latency egress throughput +0.04 [-0.74, +0.81] 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.00 [-0.70, +0.69] 1 Logs
file_to_blackhole_0ms_latency egress throughput -0.00 [-0.83, +0.82] 1 Logs
uds_dogstatsd_to_api ingress throughput -0.01 [-0.12, +0.10] 1 Logs
file_to_blackhole_500ms_latency egress throughput -0.09 [-0.85, +0.67] 1 Logs
file_to_blackhole_1000ms_latency_linear_load egress throughput -0.11 [-0.58, +0.36] 1 Logs
pycheck_lots_of_tags % cpu utilization -3.86 [-7.22, -0.50] 1 Logs

Bounds Checks: ❌ Failed

perf experiment bounds_check_name replicates_passed links
file_to_blackhole_500ms_latency lost_bytes 9/10
file_to_blackhole_0ms_latency lost_bytes 10/10
file_to_blackhole_0ms_latency 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 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

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

@chouquette chouquette force-pushed the chouquette/sysprobe_dont_fail_local branch 2 times, most recently from e194084 to 86847a4 Compare November 12, 2024 09:35
@chouquette
Copy link
Contributor Author

/gitlab estimate-cost

@dd-devflow
Copy link

dd-devflow bot commented Nov 14, 2024

Devflow running: /gitlab estimate-cost

View all feedbacks in Devflow UI.


2024-11-14 15:52:08 UTC ℹ️ Devflow: /gitlab estimate-cost

Estimated cost is $12.44 for Don't fail to build the agent locally when system probe is disabled (cumulated CI duration: 47h7m58s)

@chouquette chouquette force-pushed the chouquette/sysprobe_dont_fail_local branch from 4a3dd37 to f83ffc9 Compare November 19, 2024 09:29

Verified

This commit was signed with the committer’s verified signature.
chouquette Hugo Beauzée-Luyssen
BARX-622

Verified

This commit was signed with the committer’s verified signature.
chouquette Hugo Beauzée-Luyssen

Verified

This commit was signed with the committer’s verified signature.
chouquette Hugo Beauzée-Luyssen

Verified

This commit was signed with the committer’s verified signature.
chouquette Hugo Beauzée-Luyssen

Verified

This commit was signed with the committer’s verified signature.
chouquette Hugo Beauzée-Luyssen

Verified

This commit was signed with the committer’s verified signature.
chouquette Hugo Beauzée-Luyssen

Verified

This commit was signed with the committer’s verified signature.
chouquette Hugo Beauzée-Luyssen

Verified

This commit was signed with the committer’s verified signature.
chouquette Hugo Beauzée-Luyssen
we only depend on system probe when it's enabled
@chouquette chouquette force-pushed the chouquette/sysprobe_dont_fail_local branch from 1b7698b to d6d2f07 Compare November 25, 2024 10:47
omnibus/lib/project_helpers.rb Outdated Show resolved Hide resolved
Comment on lines +94 to +101
if sysprobe_enabled?
move "#{install_dir}/etc/datadog-agent/system-probe.yaml.example", "#{output_config_dir}/etc/datadog-agent"
# SElinux policies aren't generated when system-probe isn't built
# Move SELinux policy
if debian_target? || redhat_target?
move "#{install_dir}/etc/datadog-agent/selinux", "#{output_config_dir}/etc/datadog-agent/selinux"
end
end
Copy link
Contributor

Choose a reason for hiding this comment

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

Would it make sense to move this out of the nested conditionals? sysprobe_enabled already implies linux_target and not heroku_target

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 a bit reluctant, as this block relies on the mkdir "#{output_config_dir}/etc/datadog-agent" just above, and the destination path are definitely linux specific.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah, I guess that's fair.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
Co-authored-by: Alex Lopez <alex.lopez.zorzano@gmail.com>
Comment on lines +94 to +101
if sysprobe_enabled?
move "#{install_dir}/etc/datadog-agent/system-probe.yaml.example", "#{output_config_dir}/etc/datadog-agent"
# SElinux policies aren't generated when system-probe isn't built
# Move SELinux policy
if debian_target? || redhat_target?
move "#{install_dir}/etc/datadog-agent/selinux", "#{output_config_dir}/etc/datadog-agent/selinux"
end
end
Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah, I guess that's fair.

@chouquette
Copy link
Contributor Author

/merge

@dd-devflow
Copy link

dd-devflow bot commented Nov 28, 2024

Devflow running: /merge

View all feedbacks in Devflow UI.


2024-11-28 09:27:45 UTC ℹ️ MergeQueue: pull request added to the queue

The median merge time in main is 22m.

@dd-mergequeue dd-mergequeue bot merged commit 24309bd into main Nov 28, 2024
215 checks passed
@dd-mergequeue dd-mergequeue bot deleted the chouquette/sysprobe_dont_fail_local branch November 28, 2024 09:47
@github-actions github-actions bot added this to the 7.61.0 milestone Nov 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog/no-changelog medium review PR review might take time qa/no-code-change No code change in Agent code requiring validation team/agent-delivery
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants