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

created a set of example configuration files for datadog agent

Open dogeahill opened this issue 1 year ago • 5 comments
trafficstars

What does this PR do?

This change adds a directory with example datadog-agent.yaml configuration files

Motivation

Frequently when implementing Datadog, a lot of time is spent yaml wrangling to get basic configurations set up. This process is tedious and error prone, and having a base set of configurations would simplify this process dramatically. Ideally it could ship with the agent when installed so that users could onboard datadog without having to parse a 3k plus line example yaml file.

Additional Notes

Possible Drawbacks / Trade-offs

Describe how to test/QA your changes

dogeahill avatar Sep 04 '24 17:09 dogeahill

CLA assistant check
All committers have signed the CLA.

bits-bot avatar Sep 04 '24 17:09 bits-bot

[Fast Unit Tests Report]

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

Regression Detector

Regression Detector Results

Run ID: 20c89fa1-c723-4050-9c9f-7d8dedeeee46 Metrics dashboard Target profiles

Baseline: b5758df44fab8dea0527f6abac5dbfe411201c8d Comparison: 8eed64f44a1931cf4effe9f61bb0b3699a9baf58

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.

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
uds_dogstatsd_to_api_cpu % cpu utilization +1.15 [+0.30, +2.01] 1 Logs
basic_py_check % cpu utilization +0.66 [-1.94, +3.25] 1 Logs
tcp_syslog_to_blackhole ingress throughput +0.44 [-12.55, +13.43] 1 Logs
file_tree memory utilization +0.23 [+0.17, +0.29] 1 Logs
pycheck_lots_of_tags % cpu utilization +0.13 [-2.22, +2.48] 1 Logs
uds_dogstatsd_to_api ingress throughput -0.00 [-0.00, +0.00] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput -0.00 [-0.01, +0.01] 1 Logs
idle memory utilization -0.28 [-0.32, -0.25] 1 Logs
otel_to_otel_logs ingress throughput -0.84 [-1.65, -0.03] 1 Logs

Bounds Checks

perf experiment bounds_check_name replicates_passed
idle memory_usage 10/10

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

Ideally it could ship with the agent when installed so that users could onboard datadog without having to parse a 3k plus line example yaml file.

This PR as-is won't include the example configurations in the distributed packages, I think we'd need to update the omnibus config to include this new folder, as well as where to put it when installed.

spencergilbert avatar Sep 13 '24 15:09 spencergilbert

Ideally it could ship with the agent when installed so that users could onboard datadog without having to parse a 3k plus line example yaml file.

This PR as-is won't include the example configurations in the distributed packages, I think we'd need to update the omnibus config to include this new folder, as well as where to put it when installed.

Understood, that was more of a desired future state but the goal is just to have this available in this repository to offer simpler ways to configure the agent for initial onboarding.

dogeahill avatar Sep 13 '24 15:09 dogeahill

/merge

spencergilbert avatar Sep 18 '24 14:09 spencergilbert

:steam_locomotive: MergeQueue: pull request added to the queue

The median merge time in main is 23m.

Use /merge -c to cancel this operation!

dd-devflow[bot] avatar Sep 18 '24 14:09 dd-devflow[bot]