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[datadog-installer]: Handle 'file not found' error in removeUnit function #32066

Merged
merged 2 commits into from
Dec 12, 2024

Conversation

efloss
Copy link
Contributor

@efloss efloss commented Dec 11, 2024

🤖 This pull request was automatically generated by Datadog Error Tracking Assistant, requested by [email protected].

Applies Datadog Error Tracking Assistant suggestions for issue: ddb74c5c-ae6d-11ef-b346-da7ad0900002.


This pull request fixes an issue where attempting to remove a non-existent systemd unit file causes an error that propagates and leads to an exception in the tracer.

Problem:

The removeUnit function attempts to remove systemd unit files using os.Remove. If the unit file does not exist, os.Remove returns an error stating "no such file or directory". This error is then passed to the DataDog tracer via tracer.WithError(err) in the deferred function, which can cause an unexpected exception within the tracer code.

Solution:

The code has been modified to check if the error returned by os.Remove is due to the file not existing. By using os.IsNotExist(err), we determine if the error is benign (the file is already absent). If so, we set err to nil, effectively ignoring the error. This prevents unnecessary errors from being passed to the tracer and avoids exceptions when the unit file is already removed.

Summary of Changes:

  • Updated the removeUnit function to handle "file not found" errors gracefully.
  • Added a check for os.IsNotExist(err) after the call to os.Remove.
  • If the unit file does not exist, the error is suppressed by setting err to nil.

Impact:

This change ensures that the removal process is idempotent and does not raise unnecessary exceptions when systemd unit files are already absent. It improves the stability of the uninstall process and prevents misleading error logs related to non-critical file absence.

…unction

🤖 This pull request was automatically generated by Datadog Error Tracking Assistant, requested by [email protected].

Applies Datadog Error Tracking Assistant suggestions for issue: [ddb74c5c-ae6d-11ef-b346-da7ad0900002](https://app.datadoghq.com/error-tracking?issueId=ddb74c5c-ae6d-11ef-b346-da7ad0900002).

---

This pull request fixes an issue where attempting to remove a non-existent systemd unit file causes an error that propagates and leads to an exception in the tracer.

**Problem:**

The `removeUnit` function attempts to remove systemd unit files using `os.Remove`. If the unit file does not exist, `os.Remove` returns an error stating "no such file or directory". This error is then passed to the DataDog tracer via `tracer.WithError(err)` in the deferred function, which can cause an unexpected exception within the tracer code.

**Solution:**

The code has been modified to check if the error returned by `os.Remove` is due to the file not existing. By using `os.IsNotExist(err)`, we determine if the error is benign (the file is already absent). If so, we set `err` to `nil`, effectively ignoring the error. This prevents unnecessary errors from being passed to the tracer and avoids exceptions when the unit file is already removed.

**Summary of Changes:**

- Updated the `removeUnit` function to handle "file not found" errors gracefully.
- Added a check for `os.IsNotExist(err)` after the call to `os.Remove`.
- If the unit file does not exist, the error is suppressed by setting `err` to `nil`.

**Impact:**

This change ensures that the removal process is idempotent and does not raise unnecessary exceptions when systemd unit files are already absent. It improves the stability of the uninstall process and prevents misleading error logs related to non-critical file absence.
@bits-bot
Copy link
Collaborator

bits-bot commented Dec 11, 2024

CLA assistant check
All committers have signed the CLA.

@github-actions github-actions bot added team/windows-agent short review PR is simple enough to be reviewed quickly labels Dec 11, 2024
@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Dec 11, 2024

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

Note: This applies to commit fe725df

@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Dec 11, 2024

Package size comparison

Comparison with ancestor 367c4b6154a709751eac1c92b7d0b0957aa83511

Diff per package
package diff status size ancestor threshold
datadog-agent-amd64-deb 0.00MB 1265.83MB 1265.83MB 140.00MB
datadog-iot-agent-amd64-deb 0.00MB 113.26MB 113.26MB 10.00MB
datadog-dogstatsd-amd64-deb 0.00MB 78.41MB 78.41MB 10.00MB
datadog-heroku-agent-amd64-deb 0.00MB 526.60MB 526.60MB 70.00MB
datadog-agent-x86_64-rpm 0.00MB ⚠️ 1275.07MB 1275.06MB 140.00MB
datadog-agent-x86_64-suse 0.00MB ⚠️ 1275.07MB 1275.06MB 140.00MB
datadog-iot-agent-x86_64-rpm 0.00MB 113.33MB 113.33MB 10.00MB
datadog-iot-agent-x86_64-suse 0.00MB 113.33MB 113.33MB 10.00MB
datadog-dogstatsd-x86_64-rpm 0.00MB 78.49MB 78.49MB 10.00MB
datadog-dogstatsd-x86_64-suse 0.00MB 78.49MB 78.49MB 10.00MB
datadog-agent-arm64-deb 0.02MB ⚠️ 1000.85MB 1000.83MB 140.00MB
datadog-iot-agent-arm64-deb 0.00MB 108.75MB 108.75MB 10.00MB
datadog-dogstatsd-arm64-deb 0.00MB 55.64MB 55.64MB 10.00MB
datadog-agent-aarch64-rpm 0.02MB ⚠️ 1010.06MB 1010.04MB 140.00MB
datadog-iot-agent-aarch64-rpm 0.00MB 108.82MB 108.82MB 10.00MB

Decision

⚠️ Warning

Copy link

cit-pr-commenter bot commented Dec 11, 2024

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: 16b13bcd-819f-4d19-8639-a7699466a4e4

Baseline: 367c4b6
Comparison: fe725df
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.84 [+0.77, +0.90] 1 Logs
quality_gate_logs % cpu utilization +0.59 [-2.36, +3.55] 1 Logs
quality_gate_idle_all_features memory utilization +0.28 [+0.15, +0.41] 1 Logs bounds checks dashboard
file_to_blackhole_1000ms_latency egress throughput +0.21 [-0.56, +0.99] 1 Logs
otel_to_otel_logs ingress throughput +0.10 [-0.59, +0.79] 1 Logs
file_to_blackhole_0ms_latency_http1 egress throughput +0.01 [-0.81, +0.84] 1 Logs
uds_dogstatsd_to_api ingress throughput +0.00 [-0.10, +0.10] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput -0.00 [-0.01, +0.01] 1 Logs
file_to_blackhole_0ms_latency egress throughput -0.02 [-0.81, +0.76] 1 Logs
file_to_blackhole_0ms_latency_http2 egress throughput -0.04 [-0.84, +0.77] 1 Logs
file_to_blackhole_300ms_latency egress throughput -0.04 [-0.67, +0.59] 1 Logs
file_to_blackhole_1000ms_latency_linear_load egress throughput -0.05 [-0.51, +0.41] 1 Logs
file_to_blackhole_100ms_latency egress throughput -0.06 [-0.76, +0.65] 1 Logs
file_to_blackhole_500ms_latency egress throughput -0.09 [-0.86, +0.68] 1 Logs
quality_gate_idle memory utilization -0.11 [-0.15, -0.06] 1 Logs bounds checks dashboard
uds_dogstatsd_to_api_cpu % cpu utilization -0.31 [-1.03, +0.42] 1 Logs
file_tree memory utilization -0.47 [-0.59, -0.35] 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, 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.

@arbll arbll added qa/done QA done before merge and regressions are covered by tests team/fleet-automation changelog/no-changelog labels Dec 12, 2024
@efloss
Copy link
Contributor Author

efloss commented Dec 12, 2024

/merge

@dd-devflow
Copy link

dd-devflow bot commented Dec 12, 2024

Devflow running: /merge

View all feedbacks in Devflow UI.


2024-12-12 15:30:56 UTC ❌ MergeQueue

This PR is a draft

@efloss efloss marked this pull request as ready for review December 12, 2024 16:42
@efloss efloss requested review from a team as code owners December 12, 2024 16:42
@efloss
Copy link
Contributor Author

efloss commented Dec 12, 2024

/merge

@dd-devflow
Copy link

dd-devflow bot commented Dec 12, 2024

Devflow running: /merge

View all feedbacks in Devflow UI.


2024-12-12 16:43:26 UTC ℹ️ MergeQueue: pull request added to the queue

The median merge time in main is 26m.


2024-12-12 17:28:58 UTC ℹ️ MergeQueue: This merge request was merged

@dd-mergequeue dd-mergequeue bot merged commit 8822a1c into main Dec 12, 2024
269 of 271 checks passed
@dd-mergequeue dd-mergequeue bot deleted the dd-XYzArPOHnuOr branch December 12, 2024 17:28
@github-actions github-actions bot added this to the 7.62.0 milestone Dec 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog/no-changelog qa/done QA done before merge and regressions are covered by tests short review PR is simple enough to be reviewed quickly team/fleet-automation team/windows-agent
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants