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

Rotate the API key at runtime in the logs-agent

Open hush-hush opened this issue 1 year ago • 1 comments

What does this PR do?

The logs-agent now pull the API key from the configuration every time it uses it. This makes rotating the API key at runtime possible.

Describe how to test/QA your changes

  • Test that the logs agent still works like before (this includes TCP/HTTP + additional_endpoints)
  • Rotate the API key for HTTP and TCP destination (API key rotation is only supported for the main setting api_key in the configuration). But rotating the API key should not impact other destination.

Setting up API key rotation:

  • Use Secret management solution to set the API key (ex: api_key: ENC[my API key]).
  • Create a binary that returned a different value each time it's called
  • Use the new CLI to trigger secret rotation: datadog-agent secrets refresh

hush-hush avatar Mar 04 '24 14:03 hush-hush

Bloop Bleep... Dogbot Here

Regression Detector Results

Run ID: 54fb1e9e-9409-4ffb-a65f-8909b5e81730 Baseline: 8c5ec0f072ca053b31bc91d38db55d46d256a8e4 Comparison: 900a2c7a689895b4a6dfa92b54de74b39cd088ff

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.28 [-6.30, +6.86]

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI
basic_py_check % cpu utilization +1.92 [-0.33, +4.18]
otel_to_otel_logs ingress throughput +1.26 [+0.61, +1.90]
process_agent_standard_check_with_stats memory utilization +0.35 [+0.32, +0.38]
file_to_blackhole % cpu utilization +0.28 [-6.30, +6.86]
process_agent_standard_check memory utilization +0.08 [+0.05, +0.11]
trace_agent_json ingress throughput +0.01 [-0.01, +0.03]
trace_agent_msgpack ingress throughput +0.00 [-0.00, +0.00]
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]
process_agent_real_time_mode memory utilization -0.06 [-0.09, -0.02]
idle memory utilization -0.16 [-0.19, -0.13]
file_tree memory utilization -0.46 [-0.54, -0.39]
tcp_syslog_to_blackhole ingress throughput -0.64 [-0.69, -0.58]
uds_dogstatsd_to_api_cpu % cpu utilization -2.32 [-3.73, -0.91]

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

/merge

hush-hush avatar Mar 18 '24 15:03 hush-hush

: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 15: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=30308435 --os-family=ubuntu

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

:steam_locomotive: MergeQueue

Added to the queue.

There are 2 builds ahead of this PR! (estimated merge in less than 27m)

Use /merge -c to cancel this operation!

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

Regression Detector

Regression Detector Results

Run ID: c516b1e1-7e5c-4bf2-9e69-d1e581130ba3 Baseline: 6c5fe04ebf61708de7ad4195d02e6914f5a63365 Comparison: a260796ba25902522b721674514ff0fb0dc22bb2

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.32 [-6.60, +5.96]

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI
tcp_syslog_to_blackhole ingress throughput +1.54 [+1.45, +1.64]
process_agent_real_time_mode memory utilization +1.34 [+1.30, +1.39]
idle memory utilization +0.80 [+0.75, +0.84]
uds_dogstatsd_to_api_cpu % cpu utilization +0.76 [-1.93, +3.45]
process_agent_standard_check memory utilization +0.55 [+0.50, +0.60]
process_agent_standard_check_with_stats memory utilization +0.24 [+0.19, +0.29]
file_tree memory utilization +0.13 [+0.02, +0.24]
trace_agent_json ingress throughput +0.03 [-0.00, +0.07]
tcp_dd_logs_filter_exclude ingress throughput +0.01 [-0.03, +0.04]
trace_agent_msgpack ingress throughput -0.01 [-0.02, -0.00]
uds_dogstatsd_to_api ingress throughput -0.02 [-0.22, +0.19]
basic_py_check % cpu utilization -0.29 [-2.73, +2.16]
file_to_blackhole % cpu utilization -0.32 [-6.60, +5.96]
pycheck_1000_100byte_tags % cpu utilization -0.34 [-5.21, +4.52]
otel_to_otel_logs ingress throughput -0.37 [-0.81, +0.08]

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]