datadog-agent icon indicating copy to clipboard operation
datadog-agent copied to clipboard

[trace-agent] CLI support added for unofficially supported deprecated flags/switches

Open truthbk opened this issue 1 year ago • 9 comments

What does this PR do?

In PR https://github.com/DataDog/datadog-agent/pull/18492 we added backward-compatibility support for official flags that were now deprecated. Unfortunately, the unofficially supported --pid (single hyphen were the documented switches -pid) was left out. This PR adds support for it once again.

We also take the opportunity to fix a couple other flags so they remain backward-compatible even if only unofficially supported previously.

Motivation

Customer was impacted by using the unofficial --pid flag instead of -pid (both now deprecated).

Additional Notes

Possible Drawbacks / Trade-offs

Describe how to test/QA your changes

Manually launch the trace-agent and make sure the old flags are still well supported:

  • -pid <file>
  • --pid <file>
  • -cpuprofile <file>
  • --cpuprofile <file>
  • -memprofile <file>
  • --memprofile <file>

As well as the newer ones:

  • --pidfile <file>
  • --cpu-profile <file>
  • --mem-profile <file>

Reviewer's Checklist

  • [x] 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.
  • [x] A release note has been added or the changelog/no-changelog label has been applied.
  • [x] Changed code has automated tests for its functionality.
  • [x] Adequate QA/testing plan information is provided. Except if the qa/skip-qa label, with required either qa/done or qa/no-code-change labels, are applied.
  • [x] 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.

truthbk avatar Dec 28 '23 16:12 truthbk

Bloop Bleep... Dogbot Here

Regression Detector Results

Run ID: 3d443c35-dbbf-4925-829b-13417e64397f Baseline: f608b4cccd5730c5cfa225dcf8763cf8a7aff1a7 Comparison: f7f563636af3dab5b3f3efffea1cb4c222e1acb2 Total CPUs: 7

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

No significant changes in experiment optimization goals

Confidence level: 90.00% Effect size tolerance: |Δ mean %| ≥ 5.00%

There were no significant changes in experiment optimization goals at this confidence level and effect size tolerance.

Experiments ignored for regressions

Regressions in experiments with settings containing erratic: true are ignored.

perf experiment goal Δ mean % Δ mean % CI
idle memory utilization +0.06 [+0.03, +0.10]
file_to_blackhole % cpu utilization -0.24 [-6.77, +6.30]
file_tree memory utilization -1.71 [-1.84, -1.58]

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI
otel_to_otel_logs ingress throughput +0.93 [+0.20, +1.66]
tcp_syslog_to_blackhole ingress throughput +0.48 [+0.41, +0.55]
process_agent_standard_check memory utilization +0.36 [+0.28, +0.44]
process_agent_standard_check_with_stats memory utilization +0.27 [+0.20, +0.34]
process_agent_real_time_mode memory utilization +0.09 [+0.03, +0.14]
idle memory utilization +0.06 [+0.03, +0.10]
trace_agent_json ingress throughput +0.01 [-0.02, +0.03]
trace_agent_msgpack ingress throughput +0.00 [-0.02, +0.03]
uds_dogstatsd_to_api ingress throughput +0.00 [-0.04, +0.04]
tcp_dd_logs_filter_exclude ingress throughput +0.00 [-0.06, +0.06]
file_to_blackhole % cpu utilization -0.24 [-6.77, +6.30]
file_tree memory utilization -1.71 [-1.84, -1.58]

Explanation

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

pr-commenter[bot] avatar Dec 28 '23 18:12 pr-commenter[bot]

/merge

truthbk avatar Jan 05 '24 15:01 truthbk

:steam_locomotive: MergeQueue

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.

you can cancel this operation by commenting your pull request with /merge -c!

dd-devflow[bot] avatar Jan 05 '24 15:01 dd-devflow[bot]

:steam_locomotive: MergeQueue

Added to the queue.

There are 5 builds ahead of this PR! (estimated merge in less than 1h)

you can cancel this operation by commenting your pull request with /merge -c!

dd-devflow[bot] avatar Jan 05 '24 15:01 dd-devflow[bot]

/remove

KevinFairise2 avatar Jan 05 '24 16:01 KevinFairise2

:steam_locomotive: Devflow: remove

dd-devflow[bot] avatar Jan 05 '24 16:01 dd-devflow[bot]

:warning: MergeQueue

This merge request build was cancelled

If you need support, contact us on slack #ci-interfaces!

dd-devflow[bot] avatar Jan 05 '24 16:01 dd-devflow[bot]

Test changes on VM

Use this command from test-infra-definitions to manually test this PR changes on a VM:

inv create-vm --pipeline-id=30215707 --os-family=ubuntu

pr-commenter[bot] avatar Mar 15 '24 19:03 pr-commenter[bot]

Regression Detector

Regression Detector Results

Run ID: a3e81113-2c9e-485a-8aea-5f918ad56f3b Baseline: 1941f35b9b4c146b13cdf7422e9ad157f0fa7b31 Comparison: 9620d325ba0b66d95264ed5c9fec0a5aa02ddb6c

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

No significant changes in experiment optimization goals

Confidence level: 90.00% Effect size tolerance: |Δ mean %| ≥ 5.00%

There were no significant changes in experiment optimization goals at this confidence level and effect size tolerance.

Experiments ignored for regressions

Regressions in experiments with settings containing erratic: true are ignored.

perf experiment goal Δ mean % Δ mean % CI
file_to_blackhole % cpu utilization -0.93 [-7.25, +5.38]

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI
uds_dogstatsd_to_api_cpu % cpu utilization +1.77 [-0.94, +4.48]
basic_py_check % cpu utilization +1.26 [-1.26, +3.77]
file_tree memory utilization +0.48 [+0.38, +0.58]
process_agent_standard_check_with_stats memory utilization +0.15 [+0.11, +0.18]
otel_to_otel_logs ingress throughput +0.11 [-0.30, +0.51]
process_agent_standard_check memory utilization +0.07 [+0.04, +0.10]
trace_agent_json ingress throughput +0.00 [-0.03, +0.04]
uds_dogstatsd_to_api ingress throughput +0.00 [-0.20, +0.20]
tcp_syslog_to_blackhole ingress throughput -0.02 [-0.11, +0.07]
idle memory utilization -0.02 [-0.06, +0.01]
trace_agent_msgpack ingress throughput -0.03 [-0.04, -0.02]
tcp_dd_logs_filter_exclude ingress throughput -0.06 [-0.09, -0.03]
process_agent_real_time_mode memory utilization -0.54 [-0.57, -0.51]
file_to_blackhole % cpu utilization -0.93 [-7.25, +5.38]
pycheck_1000_100byte_tags % cpu utilization -2.48 [-7.28, +2.32]

Explanation

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

pr-commenter[bot] avatar Mar 15 '24 19:03 pr-commenter[bot]