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

[ASCII-1292] Warn when using an unknown config key

Open pgimalac opened this issue 1 year ago • 1 comments

What does this PR do?

  • Update viper to benefit from https://github.com/DataDog/viper/pull/31
  • Warn (a single time) when using an unknown config key

Motivation

In https://github.com/DataDog/datadog-agent/pull/23006 we only initialize config keys needed by the serverless agent, having a warning when using a key that hasn't been declared will allow detecting uninitialized keys.

Benchmarking

I ran a benchmark before/after on the Get function, as it is a hot code path in the agent.

Before After
Known 340ns/op 366ns/op
Unknown 348ns/op 5109ns/op

The benchmark showed variability of around 25ns/op, I only ran it a few times as I didn't need mathematical accuracy

Additional Notes

Possible Drawbacks / Trade-offs

Describe how to test/QA your changes

pgimalac avatar Mar 11 '24 13:03 pgimalac

Bloop Bleep... Dogbot Here

Regression Detector Results

Run ID: c01baf34-7559-4519-8323-d46622c6a28e Baseline: 51daf04867d1e2f1f563b02cc8b711313b3ba4f2 Comparison: 832b3eb95249e624e8c088f2e6010b2f0ac0e308

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.27 [-6.30, +6.84]

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI
tcp_syslog_to_blackhole ingress throughput +0.60 [+0.54, +0.65]
file_tree memory utilization +0.39 [+0.32, +0.46]
process_agent_standard_check_with_stats memory utilization +0.31 [+0.28, +0.34]
file_to_blackhole % cpu utilization +0.27 [-6.30, +6.84]
process_agent_standard_check memory utilization +0.17 [+0.13, +0.20]
trace_agent_json ingress throughput +0.01 [-0.03, +0.05]
trace_agent_msgpack ingress throughput +0.00 [-0.01, +0.01]
uds_dogstatsd_to_api ingress throughput +0.00 [-0.00, +0.00]
tcp_dd_logs_filter_exclude ingress throughput -0.00 [-0.00, +0.00]
otel_to_otel_logs ingress throughput -0.37 [-0.99, +0.26]
idle memory utilization -0.44 [-0.48, -0.41]
process_agent_real_time_mode memory utilization -0.65 [-0.69, -0.61]
uds_dogstatsd_to_api_cpu % cpu utilization -0.93 [-2.36, +0.50]
basic_py_check % cpu utilization -1.09 [-3.30, +1.12]

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 11 '24 15:03 pr-commenter[bot]

/merge

pgimalac avatar Mar 18 '24 16:03 pgimalac

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

Use /merge -c to cancel this operation!

dd-devflow[bot] avatar Mar 18 '24 16:03 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=30304189 --os-family=ubuntu

pr-commenter[bot] avatar Mar 18 '24 17:03 pr-commenter[bot]

:steam_locomotive: MergeQueue

Added to the queue.

This build is going to start soon! (estimated merge in less than 27m)

Use /merge -c to cancel this operation!

dd-devflow[bot] avatar Mar 18 '24 17:03 dd-devflow[bot]

Regression Detector

Regression Detector Results

Run ID: 319cd137-596f-42b7-bea8-18fe4877e0e5 Baseline: 11e8ea8b5455530ba8afa8ef1831d179c5523479 Comparison: 575f9a5ecb64399b4ee28828dd7de4c1de302331

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 +1.78 [-4.64, +8.20]

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI
file_to_blackhole % cpu utilization +1.78 [-4.64, +8.20]
basic_py_check % cpu utilization +0.62 [-1.79, +3.02]
tcp_syslog_to_blackhole ingress throughput +0.52 [+0.44, +0.61]
process_agent_standard_check memory utilization +0.37 [+0.33, +0.41]
uds_dogstatsd_to_api_cpu % cpu utilization +0.34 [-2.46, +3.15]
process_agent_real_time_mode memory utilization +0.11 [+0.07, +0.14]
process_agent_standard_check_with_stats memory utilization +0.05 [+0.02, +0.08]
uds_dogstatsd_to_api ingress throughput -0.00 [-0.20, +0.20]
trace_agent_json ingress throughput -0.01 [-0.02, +0.01]
tcp_dd_logs_filter_exclude ingress throughput -0.01 [-0.04, +0.01]
trace_agent_msgpack ingress throughput -0.02 [-0.02, -0.01]
otel_to_otel_logs ingress throughput -0.11 [-0.57, +0.34]
pycheck_1000_100byte_tags % cpu utilization -0.46 [-5.33, +4.42]
idle memory utilization -0.54 [-0.59, -0.49]
file_tree memory utilization -0.60 [-0.72, -0.48]

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 18 '24 18:03 pr-commenter[bot]